POST /messaging/v1/sms/messages/

Sends an SMS message to multiple recipients using a send definition.

JSON Parameters

Name	Type	Description
`definitionKey`	string	Required. The ID of the send definition.
`recipients`	array	Required. An array of recipient objects that contain parameters and metadata for the recipients, such as tracking and personalization attributes. If this array is present in the request, the `recipient` object (which is used to send messages to individual recipients) can't be included in the request.
`recipients.contactKey`	string	Required. A unique identifier for the subscriber. You can create a contact key at send time if the contact isn’t already in Marketing Cloud Engagement.
`recipients.to`	string	Required. The phone number of the recipient.
`recipients.messageKey`	string	A unique identifier that you can use to track the status of the message. You can provide this key as part of the request. If you don't provide a key, the system generates one for you. The key can contain up to 100 characters. There are no character restrictions. The message key that you provide must be unique among all of the keys that have been used in your business unit over the prior 72 hours. If you use a duplicate `messageKey` in the same request, the message is rejected
`recipients.attributes`	object	Personalization information for the recipient. Written as key-value pairs. The attributes match profile attributes or content attributes.
`subscriptions.resubscribe`	boolean	If `true`, the mobile number is subscribed to a short code, even if the recipient opted out by replying STOP to a previous message. This option is used to ensure that critical transactional messages are delivered, even if the subscriber previously opted out.
`content.message`	string	An override for the message content in the send definition. Use substitution strings to personalize the content.
`attributes`	object	Information used to personalize the message for the request. Written as key-value pairs. The attributes match profile attributes or content attributes.

Usage

Host: https://YOUR_SUBDOMAIN.rest.marketingcloudapis.com
POST /messaging/v1/sms/messages
Content-Type: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN

{
  "definitionKey": "SEND_DEFINITION",
  "recipients": [
    {
      "contactKey": "Astro25",
      "to": "15555551234",
      "messageKey": "nFL4ULgheUeaGbPIMzJJSw",
      "attributes": {
        "FirstName": "Astro",
        "Password": "1234567"
      }
    },
    {
      "contactKey": "Codey36",
      "to": "15555554321",
      "messageKey": "GV1LhQ6NFkqFUAE1IsoQ9Q"
      "attributes": {
        "FirstName": "Code",
        "Password": "2345678"
      }
    }
  ],
  "attributes": {
    "RequestTrackingAttribute": "2",
  }
}

The response includes a request ID for the entire request. The responses array contains a messageKey value for each message that you attempted to send. If a message was sent successfully, the array object doesn’t contain any additional information.

HTTP/1.1 202 Accepted
{
  "requestId": "ccdb94bf-fcac-4fef-b194-08f534a2079a",
  "errorcode": 0,
  "responses": [
    {
      "messageKey": "nFL4ULgheUeaGbPIMzJJSw"
    },
    {
      "messageKey": "GV1LhQ6NFkqFUAE1IsoQ9Q"
    }
  ]
}

If a message wasn’t sent, the object in the responses array still includes a messageKey, but it also includes the reason that the message failed to send. The response can include a combination of successful and unsuccessful sends. In other words, one unsuccessful send doesn’t cause the entire batch to fail.

HTTP/1.1 202 Accepted
{
  "requestId": "c261d918-e99e-460c-94dc-3bbfda154c88",
  "errorcode": 109001,
  "message": "MCMS_UTM_ResponsesHasErrors: 1 subscribers failed to queue out of 2",
  "responses": [
    {
      "messageKey": "gHQ3VLsfCEOuAC2sl-CV1Q",
      "errorcode": 109106,
      "message": "MCMS_UTM_Validation_MissingRequiredField_to: Invalid subscriber"
    },
    {
      "messageKey": "oixAQE_zFUyr8bT8sJncdw"
    }
  ]
}

POST /messaging/v1/sms/messages/

JSON Parameters

Usage

No Results

Contents