Sign in

v1

latestOpenAPI 3.0.02026-07-2447166133.5 KB
Scheduled Messages

Schedule a message to be sent in a conversation

This operation creates a scheduled message to be sent in a conversation at the designated time. If no author is specified, the message will be sent as the organization.

post/conversations/{conversationId}/scheduledmessages

Path parameters

conversationIdstring required

The id of the conversation to schedule the message for

Headers

s-idempotency-keystring

A unique value generated by the client used to recognize subsequent retries of the same request. Idempotency keys can be up to 255 characters long.

Request body

sendAtstring date-time required

The date and time the message is scheduled to be sent

Example request

{
  "message": {
    "author": "entity_0D4QABCC06000",
    "body": [
      {
        "type": "text",
        "value": "Hello, how are you?"
      }
    ]
  },
  "sendAt": "2020-04-01T00:00:00Z"
}

Response

created

Example response

{
  "scheduledMessage": {
    "conversationId": "t_0E5QDGJC03000",
    "createdAt": "2020-04-01T00:00:00Z",
    "id": "scm_26RRC7PQ6JG00",
    "message": {
      "attachments": [
        {
          "data": {
            "mimetype": "audio/mpeg"
          },
          "title": "example.pdf"
        }
      ],
      "text": "Can you look at this @Dr. Smith?"
    },
    "modifiedAt": "2020-04-01T00:00:00Z",
    "scheduledToSendAt": "2020-04-01T00:00:00Z",
    "sendAsInternalMemberId": "entity_0D4QABCC06000"
  }
}