PATCH /v1/calendar/appointments/{id}
PATCH
/v1/calendar/appointments/{id}
const url = 'https://seu-endereco-da-api/v1/calendar/appointments/example';const options = { method: 'PATCH', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"startsAt":"example","resourceId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","status":"agendado","notes":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://seu-endereco-da-api/v1/calendar/appointments/example \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "startsAt": "example", "resourceId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "status": "agendado", "notes": "example" }'Permissão que a Chave de acesso precisa: Marcar compromissos (calendar:manage).
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Path Parameters
Seção intitulada “Path Parameters”id
required
string
Request Bodyrequired
Seção intitulada “Request Bodyrequired”Media typeapplication/json
object
startsAt
string
resourceId
string format: uuid
status
string
notes
string
Responses
Seção intitulada “Responses”Media typeapplication/json
object
id
required
string
startsAt
required
string format: date-time
endsAt
required
string format: date-time
status
required
string
source
required
string
notes
required
string
cancelReason
required
string
createdAt
required
string format: date-time
resourceId
required
string
resourceName
required
string
resourceColor
required
string
timezone
required
string
ownerUserId
required
string
serviceId
required
string
serviceName
required
string
contactId
required
string
contactName
required
string
contactPhoneNumber
required
string
conversationId
required
string
createdByUserId
required
string
createdByName
required
string
reminderScheduleId
required
string
taskId
required
string
meetingUrl
required
Link da reunião (Google Meet ou o link fixo do profissional)
string
confirmedAt
required
Quando o contato confirmou presença
string format: date-time
Example generated
{ "id": "example", "startsAt": "2026-04-15T12:00:00Z", "endsAt": "2026-04-15T12:00:00Z", "status": "example", "source": "example", "notes": "example", "cancelReason": "example", "createdAt": "2026-04-15T12:00:00Z", "resourceId": "example", "resourceName": "example", "resourceColor": "example", "timezone": "example", "ownerUserId": "example", "serviceId": "example", "serviceName": "example", "contactId": "example", "contactName": "example", "contactPhoneNumber": "example", "conversationId": "example", "createdByUserId": "example", "createdByName": "example", "reminderScheduleId": "example", "taskId": "example", "meetingUrl": "example", "confirmedAt": "2026-04-15T12:00:00Z"}Media typeapplication/json
object
statusCode
required
number
code
required
string
message
required
string
alternatives
required
Array<object>
object
resourceId
required
string
resourceName
required
string
startsAt
required
string
endsAt
required
string
timezone
required
string
Example generated
{ "statusCode": 1, "code": "example", "message": "example", "alternatives": [ { "resourceId": "example", "resourceName": "example", "startsAt": "example", "endsAt": "example", "timezone": "example" } ]}