GET /messaging/v1/sms/definitions/{definitionKey}
Gets send definition configuration details for a definition key.
Name | Type | | Description |
---|
definitionKey | string | Required | Unique identifier of the definition. |
Status | Name | Type | Description |
---|
200 | | | Definition retrieved. Review example response. |
| requestId | string | The unique identifier of this request. |
| name | string | Name of the definition. |
| definitionKey | string | Unique, user-generated key to access the definition object. |
| definitionId | string | Unique Marketing Cloud object identifier. |
| description | string | User-provided description of the send definition. |
| status | string | Operational state of the definition: active, inactive, or deleted. A message sent to an active definition is processed and delivered. A message sent to an inactive definition isn’t processed or delivered. Instead, the message is queued for later processing for up to three days. |
| createdDate | string | Date the definition was created. |
| modifiedDate | string | Date and time the definition was most recently changed. |
| content.message | string | The message content that you want sent with each message. Use substitution strings and AMPscript to personalize the message. |
| subscriptions.shortCode | string | The short or long code for the mobile transmissions for each message on this definition. |
| subscriptions.countryCode | string | The country code associated with the shortCode for the mobile transmissions for each message on this definition. Don't use for long codes, unless your account configuration requires it. |
| subscriptions.keyword | string | The keyword used to track messages |
| subscriptions.autoAddSubscriber | boolean | Allows you to add a recipient as subscriber against the shortCode using contactKey. When false, the message is rejected if contactKey doesn’t exist as a subscriber. Default is true. |
| subscriptions.updateSubscriber | boolean | Updates the recipient subscriber data including mobile number. Default is true. |
Response | Reason |
---|
200 Success | Definition retrieved. Review example response. |
400 Bad Request | Invalid request |
403 Forbidden | Failed to pass authorization. |
404 Not Found | Definition key doesn’t exist for this MID |
500 Server Error | Internal error |