Create communication thread

Deprecated

Required Scopes: `COMMUNICATION_WRITE` Creates new thread with a new communication for a customer

Endpoint

POST /v1/communications/{customerId}/threads

Path Parameters

customerId required integer (int64)

The ID of the customer

Request Body application/json

required

Communication thread request

communicationThreadStatus required

The status of a communication thread

Allowed values:
CREATED The thread is created
ONGOING The thread is in ongoing progress
CLOSED The thread is closed
Example:  "CREATED"
ticketNumber

The ticket number of the third party ticketing system

Example:  "A123456"
subject required

The subject of the communication

Example:  "Complaint"
content required

The content of the communication

Example:  "I received two invoices this month, but I only made one purchase."
communicationDirection required

The direction of the communication

Allowed values:
INCOMING The communication is incoming from the customer
OUTGOING The communication is outgoing to the customer
Example:  "INCOMING"
ticketLink

The link to the ticket in the third party ticketing system

Example:  "https://ticketing-system.com/ticket/A123456"
communicationChannel required

The channel of the communication

Allowed values:
LETTER Communication via letter
EMAIL Communication via email
TEXT_MESSAGE Communication via text message
PHONE Communication via phone
FAX Communication via fax
CONVERSATION Communication via conversation
CHAT Communication via chat
OTHER Communication via other means
Example:  "LETTER"
agent

The employee/agent handling the communication

Example:  "Peter Meyer"
communicationDateTime string(date-time)

When this field is not null it will be used as the date time of the communication instead of the current time

Example:  "2022-06-22T08:00:00.000+02:00[Europe/Berlin]"

Responses

OK

Response Body application/json

Communication thread response

customerId integer(int64) required

The customer's ID

Example:  1
communicationId integer(int64) required

The ID of the communication

Example:  1
threadId integer(int64) required

The ID of the communication thread

Example:  1
communicationThreadStatus required

The status of a communication thread

Allowed values:
CREATED The thread is created
ONGOING The thread is in ongoing progress
CLOSED The thread is closed
Example:  "CREATED"
ticketNumber

The ticket number of the third party ticketing system

Example:  "A123456"
subject required

The subject of the communication

Example:  "Complaint"
content required

The content of the communication

Example:  "I received two invoices this month, but I only made one purchase."
communicationDirection required

The direction of the communication

Allowed values:
INCOMING The communication is incoming from the customer
OUTGOING The communication is outgoing to the customer
Example:  "INCOMING"
ticketLink

The link to the ticket in the third party ticketing system

Example:  "https://ticketing-system.com/ticket/A123456"
communicationChannel required

The channel of the communication

Allowed values:
LETTER Communication via letter
EMAIL Communication via email
TEXT_MESSAGE Communication via text message
PHONE Communication via phone
FAX Communication via fax
CONVERSATION Communication via conversation
CHAT Communication via chat
OTHER Communication via other means
Example:  "LETTER"
agent

The employee/agent handling the communication

Example:  "Peter Meyer"
Validation of the request failed.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Authentication failed. No api-key, wrong api-key or wrong header name.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Authorization failed. The caller has no privilege to the given resource.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Entity does not exists.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Concurrent modification detected. The entity was modified by another request.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Access denied - rate limit is exceeded.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Unexpected system error.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"