Message

List messages

The user needs to be logged in to use this endpoint, click here to read more.

Message API for send message to customer service and to see messages created by customer in self service.

SecurityAuthorization_Code
Responses
200

OK

Response Schema: application/json
Array of objects
400

Bad Request

429

Too Many Requests

500

Internal Server Error

get/v1/customer/message
Request samples
Response samples
application/json
{
  • "messages": [
    ]
}

Send message

The user needs to be logged in to use this endpoint, click here to read more.

Message API for send message to customer service.

SecurityAuthorization_Code
Request
Request Body schema: application/json
product
required
string <= 12 characters

Product code

caseType
string <= 1 characters

Override case type for this message. Available types:

  • A: follow up complaint
  • B: cancellation
messageSubject
string <= 40 characters

The subject on the message to customer service.

messageContent
required
string <= 32000 characters

Message to customer service

Responses
200

OK

Response Schema: application/json
Array of objects
400

Bad Request

429

Too Many Requests

500

Internal Server Error

post/v1/customer/message
Request samples
application/json
{
  • "product": "CO27409",
  • "caseType": "B",
  • "messageSubject": "cancel",
  • "messageContent": "Cancel my subscription"
}
Response samples
application/json
{
  • "messages": [
    ]
}

Send message - client mode

Only the client needs to be logged in to use this endpoint. The user does not need to be logged in, click here to read more.

Message API to send message to customer service.

SecurityClient_Credentials
Request
Request Body schema: application/json
product
string <= 12 characters

Product code

caseType
string <= 1 characters

Override case type for this message. Available types:

  • A: follow up complaint
  • B: cancellation
messageSubject
string <= 40 characters

The subject on the message to customer service.

messageContent
required
string <= 32000 characters

Message to customer service

Responses
200

OK

Response Schema: application/json
Array of objects
400

Bad Request

429

Too Many Requests

500

Internal Server Error

post/v1/client/message
Request samples
application/json
{
  • "product": "CO27409",
  • "caseType": "B",
  • "messageSubject": "cancel",
  • "messageContent": "Cancel my subscription"
}
Response samples
application/json
{
  • "messages": [
    ]
}