Get distribution response

result object

idId (string)required

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

nameName (string)required

Possible values: <= 100 characters

ownerIdOwnerId (string)required

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

organizationIdOrganizationId (string)required

Possible values: <= 20 characters

requestStatusRequestStatus (string)required

Possible values: <= 11 characters

requestTypeRequestType (string)required

Possible values: <= 30 characters

sendDatestring<date-time>required

Possible values: <= 20 characters

surveyIdSurveyId (string)required

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)nullablerequired

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

libraryIdLibraryId (string)nullablerequired

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

stats objectrequired

sentSent (integer)required

startedStarted (integer)required

finishedFinished (integer)required

failedFailed (integer)required

creditsCredits (integer)required

segmentsSegments (integer)required

meta object

httpStatushttp status (string)required

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.

Get distribution response

{
  "result": {
    "id": "WAD_012345678901234",
    "name": "myWADistribution",
    "ownerId": "UR_012345678901234",
    "organizationId": "exampleorganization1",
    "requestStatus": "Scheduled",
    "requestType": "Invite",
    "sendDate": "2017-11-17T00:36:42Z",
    "surveyId": "SV_012345678901234",
    "recipients": {
      "mailingListId": "CG_012345678901234",
      "contactId": "CGC_012345678901234"
    },
    "message": {
      "messageId": "MS_012345678901234",
      "contactId": "UR_012345678901234"
    },
    "stats": {
      "sent": 0,
      "started": 0,
      "finished": 0,
      "failed": 0,
      "credits": 0,
      "segments": 0
    }
  },
  "meta": {
    "httpStatus": "200 - OK"
  }
}