get communication status for customers

deprecated

This endpoint has been deprecated and may be removed in future versions of the API.

get communication status for customers

Path Parameters

departmentUUID string required

application/json

Request Body required

customerUUIDList string[]

Responses

• 200

---

OK

application/json

Schema

Example (from schema)

---

Schema

customerCommunicationStatusDetailsList object[]
Array [
customerUUID string
textCommunicationStatus string
Possible values: [OPTED_IN_OK_TO_COMMUNICATE, UNKNOWN, OPTED_OUT, OPTED_IN_NOT_OK_TO_COMMUNICATE]
emailCommunicationStatus string
Possible values: [OPTED_IN_OK_TO_COMMUNICATE, UNKNOWN, OPTED_OUT, OPTED_IN_NOT_OK_TO_COMMUNICATE]
callCommunicationStatus string
Possible values: [OPTED_IN_OK_TO_COMMUNICATE, UNKNOWN, OPTED_OUT, OPTED_IN_NOT_OK_TO_COMMUNICATE]
]
errors object[]
Array [
errorCode string
errorDescription string
errorUID string
]
warnings object[]
Array [
warningCode string
warningDescription string
]

{
  "customerCommunicationStatusDetailsList": [
    {
      "customerUUID": "string",
      "textCommunicationStatus": "OPTED_IN_OK_TO_COMMUNICATE",
      "emailCommunicationStatus": "OPTED_IN_OK_TO_COMMUNICATE",
      "callCommunicationStatus": "OPTED_IN_OK_TO_COMMUNICATE"
    }
  ],
  "errors": [
    {
      "errorCode": "string",
      "errorDescription": "string",
      "errorUID": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

POST /departments/:departmentUUID/getCommunicationStatusForCustomerUUIDList

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

/communications

Username

Password

departmentUUID — path required

Body required

{
  "customerUUIDList": [
    "string"
  ]
}

curl / cURL

curl -L -X POST '/communications/departments/:departmentUUID/getCommunicationStatusForCustomerUUIDList' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "customerUUIDList": [
    "string"
  ]
}'

python / requests

curl -L -X POST '/communications/departments/:departmentUUID/getCommunicationStatusForCustomerUUIDList' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "customerUUIDList": [
    "string"
  ]
}'

go / native

curl -L -X POST '/communications/departments/:departmentUUID/getCommunicationStatusForCustomerUUIDList' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "customerUUIDList": [
    "string"
  ]
}'

nodejs / axios

curl -L -X POST '/communications/departments/:departmentUUID/getCommunicationStatusForCustomerUUIDList' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "customerUUIDList": [
    "string"
  ]
}'

ruby / Net::HTTP

curl -L -X POST '/communications/departments/:departmentUUID/getCommunicationStatusForCustomerUUIDList' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "customerUUIDList": [
    "string"
  ]
}'

csharp / RestSharp

curl -L -X POST '/communications/departments/:departmentUUID/getCommunicationStatusForCustomerUUIDList' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "customerUUIDList": [
    "string"
  ]
}'

php / cURL

curl -L -X POST '/communications/departments/:departmentUUID/getCommunicationStatusForCustomerUUIDList' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "customerUUIDList": [
    "string"
  ]
}'

java / OkHttp

curl -L -X POST '/communications/departments/:departmentUUID/getCommunicationStatusForCustomerUUIDList' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "customerUUIDList": [
    "string"
  ]
}'

powershell / RestMethod

curl -L -X POST '/communications/departments/:departmentUUID/getCommunicationStatusForCustomerUUIDList' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "customerUUIDList": [
    "string"
  ]
}'