Sign in

v1

latestOpenAPI 3.0.02026-07-26254134307.1 KB
Conversations

Update conversation reminders

Snooze or unsnooze a conversation for the provided user. For private conversations, reminders can only be created and edited through the API for teammates that own the conversation. For shared conversations, reminders created and edited through the API are shared for all teammates within the shared inbox(es) that the conversation belongs to.

Required scope: conversations:write

patch/conversations/{conversation_id}/reminders

Path parameters

conversation_idstring required

The conversation ID

Request body

teammate_idstring required

ID of the teammate to create a reminder for. For a private conversation, specify the id of the teammate that owns the conversation. For a shared conversation, use the id of any teammate that has access to the conversation's shared inbox. Alternatively, you can supply an email as a resource alias.

scheduled_atnumber required

Unix timestamp in seconds to schedule the reminder for. Must be in the future and within 50 years. Set to null to cancel.

status_idstring

ID of the waiting status to which the conversation will be set. Ticketing must be enabled for the company to use this field. If no status is supplied and ticket is enabled, the default waiting status will be used.

Response

No content