Skip to main content
POST
Update a viewing

Authorizations

Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Path Parameters

id
string
required

The id identifier.

Body

application/json
start_time
integer

Reschedule the viewing to this time. Measured in seconds since the Unix epoch.

duration
integer

How long the viewing lasts, in minutes.

Required range: 5 <= x <= 480
assignee
string | null

The ID of the user hosting the viewing. Pass null to unassign.

unit
string | null

The ID of the unit being viewed. Pass null to clear.

notes
string | null

Internal notes recorded against the viewing.

metadata
object | null

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

Response

200 - application/json

Returns the viewing object if the update succeeded.

id
string
required

Unique identifier for the object.

created
number
required

Time at which the object was created. Measured in seconds since the Unix epoch.

object
enum<string>
required
Available options:
leads.viewing
assignee
required

The team member hosting the viewing.

canceled_at
number | null
required

Time at which the viewing was canceled. Measured in seconds since the Unix epoch.

canceled_reason
string | null
required

The reason recorded when the viewing was canceled.

completed_at
number | null
required

Time at which the viewing was marked as completed. Measured in seconds since the Unix epoch.

duration
integer
required

How long the viewing lasts, in minutes.

enquiry
required

The enquiry the viewing was booked for.

notes
string | null
required

Internal notes recorded against the viewing.

source
enum<string>
required

How the viewing was booked.

Available options:
self_serve,
manual
start_time
integer
required

When the viewing starts. Measured in seconds since the Unix epoch.

status
enum<string>
required

The status of the viewing.

Available options:
scheduled,
completed,
canceled,
no_show
unit
required

The unit being viewed.

account
string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

deleted
boolean
default:false

Only returned if the object has been deleted.

metadata
object | null

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.