Update a visit

patch

https://api.robinpowered.com/v1.0/visits/{id}

Partially update an existing visit by its unique identifier. All fields are optional.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

Visit ID (UUID)

Body Params

start_time

date-time

deprecated

Deprecated. Use start instead.

start

date-time

ISO 8601 scheduled start time.

type_id

string

Visit type identifier: the UUID id from GET /visits/visit-types for this location.

hosts

array of objects

length between 1 and 5

List of hosts for the visit (first host is primary)

hosts

user_id

string

required

Robin user ID of the host

is_visible_to_guests

boolean

Defaults to true

Whether the host is visible to guests. Defaults to true.

send_notifications

boolean

Defaults to true

Whether the host receives notifications. Defaults to true.

arrival_instructions

string | null

Instructions shown to guests upon arrival. Pass null to clear.

custom_fields

array of objects

Custom field values for this visit

custom_fields

Responses

400

Validation error — missing or invalid parameters

401

Authentication required — no valid user identity

404

Visit not found

500

Internal server error

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK