Walkthroughs

Update A Walkthrough's Schedule, Status, Or Attendee Details

PATCHhttps://api.getcovent.com/api/v1/walkthroughs/{id}

Update a walkthrough's schedule, status, or attendee details.

How to Call

Use one of the examples below to call this endpoint from your own integration.

curl -X PATCH "https://api.getcovent.com/api/v1/walkthroughs/{id}" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "scheduled_at": "2026-04-21T18:00:00Z",
  "status": "confirmed",
  "notes": "Buyer requested a one-hour delay."
}'

Request

Review headers, parameters, and body fields before calling this endpoint.

AuthorizationstringRequired

Bearer token for the proposed external API contract.

Example: Bearer <API_KEY>
AcceptstringRequired

Response format header.

Example: application/json
Content-TypestringRequired

JSON request body header.

Example: application/json

idstringRequired

id path parameter.

Example: <id>

scheduled_atstringRequired

scheduled_at request field.

Example: 2026-04-21T18:00:00Z
statusstringRequired

status request field.

Example: confirmed
notesstringRequired

notes request field.

Example: Buyer requested a one-hour delay.

Response

200application/json

idstringRequired

id response field.

Example: wt_123
scheduled_atstringRequired

scheduled_at response field.

Example: 2026-04-21T18:00:00Z
statusstringRequired

status response field.

Example: confirmed
notesstringRequired

notes response field.

Example: Buyer requested a one-hour delay.
updated_atstringRequired

updated_at response field.

Example: 2026-04-17T20:20:00Z

Response Example

{
  "id": "wt_123",
  "scheduled_at": "2026-04-21T18:00:00Z",
  "status": "confirmed",
  "notes": "Buyer requested a one-hour delay.",
  "updated_at": "2026-04-17T20:20:00Z"
}