Sign in
User
Inbox

Request inbox messages refresh

Refreshes inbox messages. Webhook triggering depends on the webhookDelivery parameter.

post/3rdparty/v1/inbox/refresh

Request body

deviceIdstring

ID of the device to refresh messages for.

messageTypesSmsgatewayIncomingMessageType[]

List of message types to refresh. By default, SMS messages are refreshed.

sincestring date-time required

Start of the time range to refresh.

triggerWebhooksboolean

Deprecated: use WebhookDelivery instead. Indicates whether to trigger webhooks for the refreshed messages.

untilstring date-time required

End of the time range to refresh.

webhookDelivery'Disabled' | 'Individual' | 'Batch'

Example request

{
  "deviceId": "PyDmBQZZXYmyxMwED8Fzy",
  "since": "2024-01-01T00:00:00Z",
  "triggerWebhooks": true,
  "until": "2024-01-01T23:59:59Z"
}

Response

Inbox refresh request accepted

Changes

No recorded changes to this endpoint across all 1 revision of this API.