PATCH /v1/scheduled-messages/{id}
PATCH
/v1/scheduled-messages/{id}
const url = 'https://seu-endereco-da-api/v1/scheduled-messages/example';const options = { method: 'PATCH', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"items":[{"kind":"message","type":"text","text":"example","mediaKey":"example","mediaMime":"example","fileName":"example"}],"timezone":"example","scheduleKind":"once","runAt":"example","localTime":"example","weekdays":[1],"dayOfMonth":1,"fallbackTemplateId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","fallbackHeaderMediaKey":"example","fallbackHeaderMediaMime":"example","holidayPolicy":"ignore","holidayConfigId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","status":"scheduled"}'};
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/scheduled-messages/example \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "items": [ { "kind": "message", "type": "text", "text": "example", "mediaKey": "example", "mediaMime": "example", "fileName": "example" } ], "timezone": "example", "scheduleKind": "once", "runAt": "example", "localTime": "example", "weekdays": [ 1 ], "dayOfMonth": 1, "fallbackTemplateId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "fallbackHeaderMediaKey": "example", "fallbackHeaderMediaMime": "example", "holidayPolicy": "ignore", "holidayConfigId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "status": "scheduled" }'Permissão que a Chave de acesso precisa: Enviar mensagem e atender (conversations:write).
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
items
Array<object>
object
kind
required
string
type
required
string
text
string
mediaKey
string
mediaMime
string
fileName
string
timezone
string
scheduleKind
string
runAt
string
localTime
string
weekdays
Array<number>
dayOfMonth
number
fallbackTemplateId
string format: uuid
fallbackHeaderMediaKey
string
fallbackHeaderMediaMime
string
holidayPolicy
string
holidayConfigId
string format: uuid
status
string
Responses
Seção intitulada “Responses”Media typeapplication/json
object
id
required
string
conversationId
required
string
contactId
required
string
contactName
required
string
contactPhone
required
string
contactProfilePicUrl
required
Presigned url for the contact’s whatsapp profile photo
string
channelId
required
string
channel
required
Null quando o canal foi apagado de vez
object
name
required
O nome que o cliente deu ao canal na plataforma
string
provider
required
string
status
required
string
coexistence
required
boolean
phoneNumber
required
O numero ou @ da conta no provedor
string
accountName
required
O nome da conta no provedor: o verificado da Meta, ou o do aparelho no canal lite
string
removed
required
O canal foi apagado; a conversa continua descrevendo por onde ela aconteceu
boolean
items
required
Array<object>
object
id
required
string
position
required
number
kind
required
string
type
required
string
text
required
string
mediaKey
required
string
mediaMime
required
string
fileName
required
string
mediaUrl
required
string
timezone
required
string
scheduleKind
required
string
runAt
required
string format: date-time
localTime
required
string
weekdays
required
Array<number>
dayOfMonth
required
number
holidayPolicy
required
Ignore, skip ou postpone: o que fazer quando a ocorrência cai num feriado
string
holidayConfigId
required
Horário comercial cujos calendários definem o feriado; nulo usa todos os calendários do tenant
string
fallbackTemplateId
required
string
fallbackHeaderMediaKey
required
string
fallbackHeaderMediaMime
required
string
sendAfter
required
string format: date-time
status
required
string
lastFiredAt
required
string format: date-time
lastError
required
string
occurrenceCount
required
number
recurrenceLabel
required
string
createdByUserId
required
string
authorName
required
string
authorAvatarUrl
required
Public url for the author’s photo
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
canManage
required
The caller holds conversations:write and may act on the schedule’s conversation (edit, pause, delete)
boolean
Example generated
{ "id": "example", "conversationId": "example", "contactId": "example", "contactName": "example", "contactPhone": "example", "contactProfilePicUrl": "example", "channelId": "example", "channel": { "name": "example", "provider": "example", "status": "example", "coexistence": true, "phoneNumber": "example", "accountName": "example", "removed": true }, "items": [ { "id": "example", "position": 1, "kind": "example", "type": "example", "text": "example", "mediaKey": "example", "mediaMime": "example", "fileName": "example", "mediaUrl": "example" } ], "timezone": "example", "scheduleKind": "example", "runAt": "2026-04-15T12:00:00Z", "localTime": "example", "weekdays": [ 1 ], "dayOfMonth": 1, "holidayPolicy": "example", "holidayConfigId": "example", "fallbackTemplateId": "example", "fallbackHeaderMediaKey": "example", "fallbackHeaderMediaMime": "example", "sendAfter": "2026-04-15T12:00:00Z", "status": "example", "lastFiredAt": "2026-04-15T12:00:00Z", "lastError": "example", "occurrenceCount": 1, "recurrenceLabel": "example", "createdByUserId": "example", "authorName": "example", "authorAvatarUrl": "example", "createdAt": "2026-04-15T12:00:00Z", "updatedAt": "2026-04-15T12:00:00Z", "canManage": true}