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

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
]

{
  "optOutStatus": {
    "optOutState": "string",
    "canSendOptinRequest": true,
    "timeOfChange": "2025-03-28T11:34:43.330Z"
  },
  "requestUUID": "string",
  "errors": [
    {
      "errorCode": "string",
      "errorDescription": "string",
      "errorUID": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

GET /department/:departmentUUID/communicationType/:communicationType/communicationValue/:communicationValue/optoutstatus

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

/communications

Username

Password

departmentUUID — path required

communicationType — path required

communicationValue — path required

curl / cURL

curl -L -X GET '/communications/department/:departmentUUID/communicationType/:communicationType/communicationValue/:communicationValue/optoutstatus' \
-H 'Accept: application/json'

python / requests

curl -L -X GET '/communications/department/:departmentUUID/communicationType/:communicationType/communicationValue/:communicationValue/optoutstatus' \
-H 'Accept: application/json'

go / native

curl -L -X GET '/communications/department/:departmentUUID/communicationType/:communicationType/communicationValue/:communicationValue/optoutstatus' \
-H 'Accept: application/json'

nodejs / axios

curl -L -X GET '/communications/department/:departmentUUID/communicationType/:communicationType/communicationValue/:communicationValue/optoutstatus' \
-H 'Accept: application/json'

ruby / Net::HTTP

curl -L -X GET '/communications/department/:departmentUUID/communicationType/:communicationType/communicationValue/:communicationValue/optoutstatus' \
-H 'Accept: application/json'

csharp / RestSharp

curl -L -X GET '/communications/department/:departmentUUID/communicationType/:communicationType/communicationValue/:communicationValue/optoutstatus' \
-H 'Accept: application/json'

php / cURL

curl -L -X GET '/communications/department/:departmentUUID/communicationType/:communicationType/communicationValue/:communicationValue/optoutstatus' \
-H 'Accept: application/json'

java / OkHttp

curl -L -X GET '/communications/department/:departmentUUID/communicationType/:communicationType/communicationValue/:communicationValue/optoutstatus' \
-H 'Accept: application/json'

powershell / RestMethod

curl -L -X GET '/communications/department/:departmentUUID/communicationType/:communicationType/communicationValue/:communicationValue/optoutstatus' \
-H 'Accept: application/json'