Pular para o conteúdo

PATCH /v1/calendar/appointments/{id}

PATCH
/v1/calendar/appointments/{id}
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).

id
required
string
Media typeapplication/json
object
startsAt
string
resourceId
string format: uuid
status
string
Allowed values: agendado confirmado atendido cancelado faltou
notes
string
nullable
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
nullable
cancelReason
required
string
nullable
createdAt
required
string format: date-time
resourceId
required
string
resourceName
required
string
resourceColor
required
string
timezone
required
string
ownerUserId
required
string
nullable
serviceId
required
string
serviceName
required
string
contactId
required
string
contactName
required
string
contactPhoneNumber
required
string
nullable
conversationId
required
string
nullable
createdByUserId
required
string
nullable
createdByName
required
string
nullable
reminderScheduleId
required
string
nullable
taskId
required
string
nullable
meetingUrl
required

Link da reunião (Google Meet ou o link fixo do profissional)

string
nullable
confirmedAt
required

Quando o contato confirmou presença

string format: date-time
nullable

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"
}
]
}