Skip to main content

Create distribution response

result object
idId (string)required

The ID Of the SMS disctribution.

Possible values: Value must match regular expression ^SMSD_[a-zA-Z0-9]{11,15}$

nameName (string)required

The name of the SMS distribution.

Possible values: <= 100 characters

ownerIdOwnerId (string)required

The user id of the owner of the distribution

Possible values: Value must match regular expression ^[a-zA-Z0-9]{1,4}_[a-zA-Z0-9]{11,15}$

organizationIdOrganizationId (string)required

The string identifier for the organination.

Possible values: <= 20 characters

requestStatusRequestStatus (string)required

Possible values: <= 11 characters

requestTypeRequestType (string)required

Possible values: <= 30 characters

sendDatestring<date-time>required

The date and time when the distribution was sent

surveyIdSurveyId (string)required

The id of the survey sent in the distribution.

Possible values: Value must match regular expression ^SV_[a-zA-Z0-9]{11,15}$

recipients objectrequired
mailingListIdMailingListId (string)nullablerequired

Possible values: Value must match regular expression ^[a-zA-Z0-9]{1,4}_[a-zA-Z0-9]{11,15}$

contactIdContactId (string)nullablerequired

Possible values: Value must match regular expression ^(CTR|CGC|MLRP)_[a-zA-Z0-9]{11,15}$

libraryIdLibraryId (string)required

Refers to the library of the contact list, not the message.

Possible values: Value must match regular expression ^[a-zA-Z0-9]{1,4}_[a-zA-Z0-9]{11,15}$

sampleIdSampleId (string)nullablerequired

Possible values: Value must match regular expression ^[a-zA-Z0-9]{1,4}_[a-zA-Z0-9]{11,15}$

transactionBatchIdTransactionBatchId (string)nullablerequired

Possible values: Value must match regular expression ^BT_[a-zA-Z0-9]{11,15}$

transactionIdTransactionId (string)nullablerequired

Possible values: Value must match regular expression ^CTR_[a-zA-Z0-9]{11,15}$

message objectrequired
messageIdMessageId (string)nullable

Possible values: Value must match regular expression ^(MS|DL)_[a-zA-Z0-9]{11,15}$

libraryIdLibraryId (string)nullable

Possible values: Value must match regular expression ^[a-zA-Z0-9]{1,4}_[a-zA-Z0-9]{11,15}$

messageTextmessageText (string)nullable

Possible values: <= 10000 characters

messageTypeMessageType (string)

Possible values: [Inline, Library]

stats objectrequired
sentSent (integer)required
startedStarted (integer)required
finishedFinished (integer)required
failedFailed (integer)required
creditsCredits (integer)required
segmentsSegments (integer)required
surveyLinkExpirationDatestring<date-time>

The date and time when the survey link expires.

meta object
httpStatushttp status (string)required

http status

requestIdAn identifier of the incoming request. (string)required

An identifier of the incoming request.

noticeAn informational string about the request. (string)

An informational string about the request.

Create distribution response
{
  "result": {
    "id": "string",
    "name": "string",
    "ownerId": "string",
    "organizationId": "string",
    "requestStatus": "string",
    "requestType": "string",
    "sendDate": "2024-07-29T15:51:28.071Z",
    "surveyId": "string",
    "recipients": {
      "mailingListId": "string",
      "contactId": "string",
      "libraryId": "string",
      "sampleId": "string",
      "transactionBatchId": "string",
      "transactionId": "string"
    },
    "message": {
      "messageId": "string",
      "libraryId": "string",
      "messageText": "string",
      "messageType": "Inline"
    },
    "stats": {
      "sent": 0,
      "started": 0,
      "finished": 0,
      "failed": 0,
      "credits": 0,
      "segments": 0
    },
    "surveyLinkExpirationDate": "2024-07-29T15:51:28.071Z"
  },
  "meta": {
    "httpStatus": "string",
    "requestId": "string",
    "notice": "string"
  }
}