GET /messaging/v1/sms/definitions/{definitionKey}

Gets send definition configuration details for a definition key.

URL Parameters

definitionKeystringRequiredUnique identifier of the definition.


200  Definition retrieved. Review example response.
 requestIdstringThe unique identifier of this request.
 namestringName of the definition.
 definitionKeystringUnique, user-generated key to access the definition object.
 definitionIdstringUnique Marketing Cloud object identifier.
 descriptionstringUser-provided description of the send definition.
 statusstringOperational 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.
 createdDatestringDate the definition was created.
 modifiedDatestringDate and time the definition was most recently changed.
 content.messagestringThe message content that you want sent with each message. Use substitution strings and AMPscript to personalize the message.
 subscriptions.shortCodestringThe short or long code for the mobile transmissions for each message on this definition.
 subscriptions.countryCodestringThe 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.keywordstringThe keyword used to track messages
 subscriptions.autoAddSubscriberbooleanAllows 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.updateSubscriberbooleanUpdates the recipient subscriber data including mobile number. Default is true.

Example Request

Example Response

HTTP Responses

200 SuccessDefinition retrieved. Review example response.
400 Bad RequestInvalid request
403 ForbiddenFailed to pass authorization.
404 Not FoundDefinition key doesn’t exist for this MID
500 Server ErrorInternal error