get opt-out status for communication type and value

get opt-out status for communication type and value

Path Parameters

departmentUUID string required
communicationType string required
communicationValue string required

Responses

• 200

---

OK

application/json

Schema

Example (from schema)

---

Schema

statusCode int32
optOutStatus object
optOutState string
canSendOptinRequest boolean
timeOfChange date-time
requestUUID string
errors object[]
Array [
errorCode string
errorDescription string
errorUID string
]
warnings object[]
Array [
warningCode string
warningDescription string
]

{
  "statusCode": 0,
  "optOutStatus": {
    "optOutState": "string",
    "canSendOptinRequest": true,
    "timeOfChange": "2026-10-06T06:21:47.693Z"
  },
  "requestUUID": "string",
  "errors": [
    {
      "errorCode": "string",
      "errorDescription": "string",
      "errorUID": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

Loading...