add or revoke followers to a thread

add or revoke followers to a thread

Path Parameters

departmentUUID string required
customerUUID string required

application/json

Request Body required

userEvents object[]
Array [
user object
uuid string
name string
type string
Possible values: [USER, CUSTOMER]
departmentUuid string
addedEvents object[]
Array [
type string
Possible values: [INTERNAL, EXTERNAL]
category object
name string
Possible values: [MANUAL]
events string[]
Possible values: [INTERNAL_NOTE]
]
revokedEvents object[]
Array [
type string
Possible values: [INTERNAL, EXTERNAL]
category object
name string
Possible values: [MANUAL]
events string[]
Possible values: [INTERNAL_NOTE]
]
events object[]
Array [
type string
Possible values: [INTERNAL, EXTERNAL]
category object
name string
Possible values: [MANUAL]
events string[]
Possible values: [INTERNAL_NOTE]
]
]
customerUuid string
departmentUuid string

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"
    }
  ]
}

POST /department/:departmentUUID/customer/:customerUUID/followers

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

/communications

Username

Password

departmentUUID — path required

customerUUID — path required

Body required

{
  "userEvents": [
    {
      "user": {
        "uuid": "string",
        "name": "string",
        "type": "USER",
        "departmentUuid": "string"
      },
      "addedEvents": [
        {
          "type": "INTERNAL",
          "category": {
            "name": "MANUAL",
            "events": [
              "INTERNAL_NOTE"
            ]
          }
        }
      ],
      "revokedEvents": [
        {
          "type": "INTERNAL",
          "category": {
            "name": "MANUAL",
            "events": [
              "INTERNAL_NOTE"
            ]
          }
        }
      ],
      "events": [
        {
          "type": "INTERNAL",
          "category": {
            "name": "MANUAL",
            "events": [
              "INTERNAL_NOTE"
            ]
          }
        }
      ]
    }
  ],
  "customerUuid": "string",
  "departmentUuid": "string"
}

curl / cURL

curl -L -X POST '/communications/department/:departmentUUID/customer/:customerUUID/followers' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "userEvents": [
    {
      "user": {
        "uuid": "string",
        "name": "string",
        "type": "USER",
        "departmentUuid": "string"
      },
      "addedEvents": [
        {
          "type": "INTERNAL",
          "category": {
            "name": "MANUAL",
            "events": [
              "INTERNAL_NOTE"
            ]
          }
        }
      ],
      "revokedEvents": [
        {
          "type": "INTERNAL",
          "category": {
            "name": "MANUAL",
            "events": [
              "INTERNAL_NOTE"
            ]
          }
        }
      ],
      "events": [
        {
          "type": "INTERNAL",
          "category": {
            "name": "MANUAL",
            "events": [
              "INTERNAL_NOTE"
            ]
          }
        }
      ]
    }
  ],
  "customerUuid": "string",
  "departmentUuid": "string"
}'

python / requests

curl -L -X POST '/communications/department/:departmentUUID/customer/:customerUUID/followers' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "userEvents": [
    {
      "user": {
        "uuid": "string",
        "name": "string",
        "type": "USER",
        "departmentUuid": "string"
      },
      "addedEvents": [
        {
          "type": "INTERNAL",
          "category": {
            "name": "MANUAL",
            "events": [
              "INTERNAL_NOTE"
            ]
          }
        }
      ],
      "revokedEvents": [
        {
          "type": "INTERNAL",
          "category": {
            "name": "MANUAL",
            "events": [
              "INTERNAL_NOTE"
            ]
          }
        }
      ],
      "events": [
        {
          "type": "INTERNAL",
          "category": {
            "name": "MANUAL",
            "events": [
              "INTERNAL_NOTE"
            ]
          }
        }
      ]
    }
  ],
  "customerUuid": "string",
  "departmentUuid": "string"
}'

go / native

curl -L -X POST '/communications/department/:departmentUUID/customer/:customerUUID/followers' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "userEvents": [
    {
      "user": {
        "uuid": "string",
        "name": "string",
        "type": "USER",
        "departmentUuid": "string"
      },
      "addedEvents": [
        {
          "type": "INTERNAL",
          "category": {
            "name": "MANUAL",
            "events": [
              "INTERNAL_NOTE"
            ]
          }
        }
      ],
      "revokedEvents": [
        {
          "type": "INTERNAL",
          "category": {
            "name": "MANUAL",
            "events": [
              "INTERNAL_NOTE"
            ]
          }
        }
      ],
      "events": [
        {
          "type": "INTERNAL",
          "category": {
            "name": "MANUAL",
            "events": [
              "INTERNAL_NOTE"
            ]
          }
        }
      ]
    }
  ],
  "customerUuid": "string",
  "departmentUuid": "string"
}'

nodejs / axios

curl -L -X POST '/communications/department/:departmentUUID/customer/:customerUUID/followers' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "userEvents": [
    {
      "user": {
        "uuid": "string",
        "name": "string",
        "type": "USER",
        "departmentUuid": "string"
      },
      "addedEvents": [
        {
          "type": "INTERNAL",
          "category": {
            "name": "MANUAL",
            "events": [
              "INTERNAL_NOTE"
            ]
          }
        }
      ],
      "revokedEvents": [
        {
          "type": "INTERNAL",
          "category": {
            "name": "MANUAL",
            "events": [
              "INTERNAL_NOTE"
            ]
          }
        }
      ],
      "events": [
        {
          "type": "INTERNAL",
          "category": {
            "name": "MANUAL",
            "events": [
              "INTERNAL_NOTE"
            ]
          }
        }
      ]
    }
  ],
  "customerUuid": "string",
  "departmentUuid": "string"
}'

ruby / Net::HTTP

curl -L -X POST '/communications/department/:departmentUUID/customer/:customerUUID/followers' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "userEvents": [
    {
      "user": {
        "uuid": "string",
        "name": "string",
        "type": "USER",
        "departmentUuid": "string"
      },
      "addedEvents": [
        {
          "type": "INTERNAL",
          "category": {
            "name": "MANUAL",
            "events": [
              "INTERNAL_NOTE"
            ]
          }
        }
      ],
      "revokedEvents": [
        {
          "type": "INTERNAL",
          "category": {
            "name": "MANUAL",
            "events": [
              "INTERNAL_NOTE"
            ]
          }
        }
      ],
      "events": [
        {
          "type": "INTERNAL",
          "category": {
            "name": "MANUAL",
            "events": [
              "INTERNAL_NOTE"
            ]
          }
        }
      ]
    }
  ],
  "customerUuid": "string",
  "departmentUuid": "string"
}'

csharp / RestSharp

curl -L -X POST '/communications/department/:departmentUUID/customer/:customerUUID/followers' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "userEvents": [
    {
      "user": {
        "uuid": "string",
        "name": "string",
        "type": "USER",
        "departmentUuid": "string"
      },
      "addedEvents": [
        {
          "type": "INTERNAL",
          "category": {
            "name": "MANUAL",
            "events": [
              "INTERNAL_NOTE"
            ]
          }
        }
      ],
      "revokedEvents": [
        {
          "type": "INTERNAL",
          "category": {
            "name": "MANUAL",
            "events": [
              "INTERNAL_NOTE"
            ]
          }
        }
      ],
      "events": [
        {
          "type": "INTERNAL",
          "category": {
            "name": "MANUAL",
            "events": [
              "INTERNAL_NOTE"
            ]
          }
        }
      ]
    }
  ],
  "customerUuid": "string",
  "departmentUuid": "string"
}'

php / cURL

curl -L -X POST '/communications/department/:departmentUUID/customer/:customerUUID/followers' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "userEvents": [
    {
      "user": {
        "uuid": "string",
        "name": "string",
        "type": "USER",
        "departmentUuid": "string"
      },
      "addedEvents": [
        {
          "type": "INTERNAL",
          "category": {
            "name": "MANUAL",
            "events": [
              "INTERNAL_NOTE"
            ]
          }
        }
      ],
      "revokedEvents": [
        {
          "type": "INTERNAL",
          "category": {
            "name": "MANUAL",
            "events": [
              "INTERNAL_NOTE"
            ]
          }
        }
      ],
      "events": [
        {
          "type": "INTERNAL",
          "category": {
            "name": "MANUAL",
            "events": [
              "INTERNAL_NOTE"
            ]
          }
        }
      ]
    }
  ],
  "customerUuid": "string",
  "departmentUuid": "string"
}'

java / OkHttp

curl -L -X POST '/communications/department/:departmentUUID/customer/:customerUUID/followers' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "userEvents": [
    {
      "user": {
        "uuid": "string",
        "name": "string",
        "type": "USER",
        "departmentUuid": "string"
      },
      "addedEvents": [
        {
          "type": "INTERNAL",
          "category": {
            "name": "MANUAL",
            "events": [
              "INTERNAL_NOTE"
            ]
          }
        }
      ],
      "revokedEvents": [
        {
          "type": "INTERNAL",
          "category": {
            "name": "MANUAL",
            "events": [
              "INTERNAL_NOTE"
            ]
          }
        }
      ],
      "events": [
        {
          "type": "INTERNAL",
          "category": {
            "name": "MANUAL",
            "events": [
              "INTERNAL_NOTE"
            ]
          }
        }
      ]
    }
  ],
  "customerUuid": "string",
  "departmentUuid": "string"
}'

powershell / RestMethod

curl -L -X POST '/communications/department/:departmentUUID/customer/:customerUUID/followers' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "userEvents": [
    {
      "user": {
        "uuid": "string",
        "name": "string",
        "type": "USER",
        "departmentUuid": "string"
      },
      "addedEvents": [
        {
          "type": "INTERNAL",
          "category": {
            "name": "MANUAL",
            "events": [
              "INTERNAL_NOTE"
            ]
          }
        }
      ],
      "revokedEvents": [
        {
          "type": "INTERNAL",
          "category": {
            "name": "MANUAL",
            "events": [
              "INTERNAL_NOTE"
            ]
          }
        }
      ],
      "events": [
        {
          "type": "INTERNAL",
          "category": {
            "name": "MANUAL",
            "events": [
              "INTERNAL_NOTE"
            ]
          }
        }
      ]
    }
  ],
  "customerUuid": "string",
  "departmentUuid": "string"
}'