get opt-out status list for communication attributes

get opt-out status list for communication attributes

Path Parameters

departmentUUID string required

application/json

Request Body required

communicationList object[]
Array [
communicationType string
communicationValue string
okToCommunicate boolean
customerUUID string
]

Responses

• 200

---

OK

application/json

Schema

Example (from schema)

---

Schema

optOutStatusList object[]
Array [
communication object
communicationType string
communicationValue string
okToCommunicate boolean
customerUUID string
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
]

{
  "optOutStatusList": [
    {
      "communication": {
        "communicationType": "string",
        "communicationValue": "string",
        "okToCommunicate": true,
        "customerUUID": "string"
      },
      "optOutStatus": {
        "optOutState": "string",
        "canSendOptinRequest": true,
        "timeOfChange": "2025-03-28T11:34:43.307Z"
      }
    }
  ],
  "requestUUID": "string",
  "errors": [
    {
      "errorCode": "string",
      "errorDescription": "string",
      "errorUID": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

POST /department/:departmentUUID/communications/optoutstatus/list

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

/communications

Username

Password

departmentUUID — path required

Body required

{
  "communicationList": [
    {
      "communicationType": "string",
      "communicationValue": "string",
      "okToCommunicate": true,
      "customerUUID": "string"
    }
  ]
}

curl / cURL

curl -L -X POST '/communications/department/:departmentUUID/communications/optoutstatus/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "communicationList": [
    {
      "communicationType": "string",
      "communicationValue": "string",
      "okToCommunicate": true,
      "customerUUID": "string"
    }
  ]
}'

python / requests

curl -L -X POST '/communications/department/:departmentUUID/communications/optoutstatus/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "communicationList": [
    {
      "communicationType": "string",
      "communicationValue": "string",
      "okToCommunicate": true,
      "customerUUID": "string"
    }
  ]
}'

go / native

curl -L -X POST '/communications/department/:departmentUUID/communications/optoutstatus/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "communicationList": [
    {
      "communicationType": "string",
      "communicationValue": "string",
      "okToCommunicate": true,
      "customerUUID": "string"
    }
  ]
}'

nodejs / axios

curl -L -X POST '/communications/department/:departmentUUID/communications/optoutstatus/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "communicationList": [
    {
      "communicationType": "string",
      "communicationValue": "string",
      "okToCommunicate": true,
      "customerUUID": "string"
    }
  ]
}'

ruby / Net::HTTP

curl -L -X POST '/communications/department/:departmentUUID/communications/optoutstatus/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "communicationList": [
    {
      "communicationType": "string",
      "communicationValue": "string",
      "okToCommunicate": true,
      "customerUUID": "string"
    }
  ]
}'

csharp / RestSharp

curl -L -X POST '/communications/department/:departmentUUID/communications/optoutstatus/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "communicationList": [
    {
      "communicationType": "string",
      "communicationValue": "string",
      "okToCommunicate": true,
      "customerUUID": "string"
    }
  ]
}'

php / cURL

curl -L -X POST '/communications/department/:departmentUUID/communications/optoutstatus/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "communicationList": [
    {
      "communicationType": "string",
      "communicationValue": "string",
      "okToCommunicate": true,
      "customerUUID": "string"
    }
  ]
}'

java / OkHttp

curl -L -X POST '/communications/department/:departmentUUID/communications/optoutstatus/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "communicationList": [
    {
      "communicationType": "string",
      "communicationValue": "string",
      "okToCommunicate": true,
      "customerUUID": "string"
    }
  ]
}'

powershell / RestMethod

curl -L -X POST '/communications/department/:departmentUUID/communications/optoutstatus/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "communicationList": [
    {
      "communicationType": "string",
      "communicationValue": "string",
      "okToCommunicate": true,
      "customerUUID": "string"
    }
  ]
}'