update opt-out status for a communication context

update opt-out status for a communication context

Path Parameters

departmentUUID string required

application/json

Request Body required

customerUUID string
messageUUID string
userUUID string
apiCallSource string
communicationAttributesList object[]
Array [
communicationType string
communicationValue string
okToCommunicate boolean
customerUUID string
]
event string

Possible values: [STOP_MESSAGE_RECEIVED, STOP_SUSPECTED_MESSAGE_RECEIVED, OPTIN_MESSAGE_RECEIVED, OPTIN_TEXT_CONSENT_VIA_MESSAGE_RECEIVED, GENERIC_MESSAGE_RECEIVED, USER_REQUESTED_SEND_OPTIN_REQUEST, USER_REQUESTED_OPT_OUT, COMMUNICATION_VALUE_CREATION, COMMUNICATION_VALUE_UPDATE, COMMUNICATION_STATUS_NOT_FOUND, DOUBLE_OPTIN_ROLLOUT, DOUBLE_OPTIN_ROLLBACK]

updateType string

Possible values: [MESSAGE, CUSTOMER, DEPLOYMENT]

processSynchronously boolean

Responses

• 200

---

OK

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode string
errorDescription string
errorUID string
]
warnings object[]
Array [
warningCode string
warningDescription string
]

{
  "errors": [
    {
      "errorCode": "string",
      "errorDescription": "string",
      "errorUID": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

Loading...