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

Overview

Updates a specific message definition. It can take up to two minutes for outbound messages to reflect the changes.

URL Parameters

NameTypeDescription
definitionKeystringRequiredUnique identifier of the definition.

JSON Parameters

NameTypeDescription
namestringRequiredName of the definition. Must be unique.
content.messagestringRequiredThe message content that you want sent with each message. Use substitution strings and AMPscript to personalize the message.
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.
descriptionstringUser-provided description of the send definition.
subscriptions.shortCodestringRequiredThe 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.autoAddSubscriberbooleanPermits adding a recipient as subscriber against the shortCode using contactKey. When false, the message is rejected if contactKey does not exist as a subscriber. Default is true.

Usage

Example Request

Example Response

HTTP Responses

ResponseReason
200 OKSend definition is updated. Review example response.
400 Bad RequestInvalid request
403 ForbiddenFailed to pass authorization.
500 Server ErrorInternal error