Class Manager
POST /v1/messages/send

Send Message

application/json

Body

Request for creating or updating a message.

  • id string | null

    Message ID (for updating only)

  • subject string Required

    Subject

  • body string Required

    Body

  • recipientIds array[string] Required

    List of contact IDs

  • attachments array[string] Required

    List of attachment paths

Responses

  • 403 application/json

    Not authorized

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
  • 404 application/json

    Not found

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
  • 204

    Successful operation with no content

POST /v1/messages/send 
curl \
 --request POST 'https://localhost/v1/messages/send' \
 --header "Content-Type: application/json" \
 --data '{"id":"msg_xxxxxxxxxx","subject":"email","body":"email body","recipientIds":["con_xxxxxxxxxx"],"attachments":["/path/to/file.blah"]}'
Request examples 
{
  "id": "msg_xxxxxxxxxx",
  "subject": "email",
  "body": "email body",
  "recipientIds": [
    "con_xxxxxxxxxx"
  ],
  "attachments": [
    "/path/to/file.blah"
  ]
}
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}
Response examples (404) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}