Skip to main content
POST
/
v2.0
/
handover
/
provider
Create a Handover Provider
curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/handover/provider \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "_id": "<string>",
  "referenceId": "<string>",
  "organisationId": "<string>",
  "serviceId": "<string>",
  "service": "<string>",
  "localeId": "<string>",
  "name": "<string>",
  "createdAt": 123,
  "lastChangedAt": 123,
  "createdBy": "<string>",
  "lastChangedBy": "<string>",
  "properties": [
    {}
  ],
  "settings": {},
  "projectId": "<string>"
}
'
{
  "_id": "<string>",
  "referenceId": "<string>",
  "organisationId": "<string>",
  "serviceId": "<string>",
  "service": "<string>",
  "localeId": "<string>",
  "name": "<string>",
  "createdAt": 123,
  "lastChangedAt": 123,
  "createdBy": "<string>",
  "lastChangedBy": "<string>",
  "properties": [
    {}
  ],
  "settings": {}
}

Authorizations

ā€‹
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

Headers

ā€‹
Accept
enum<string>

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Body

application/json
ā€‹
_id
string<mongoId>

The object id of the handover provider

ā€‹
referenceId
string

The referenceId of the handover provider

ā€‹
organisationId
string

The organisation Id associated with the handover provider

ā€‹
serviceId
string

The id of the service

ā€‹
service
string

The handover provider's specified service; e.g., Live Agent, Genesys

ā€‹
localeId
string

The referenceId of the locale to use

ā€‹
name
string

The name of the handover provider resource

ā€‹
createdAt
integer<int64>

Unix-timestamp when the entity was created initially

ā€‹
lastChangedAt
integer<int64>

Unix-timestamp when the entity was last modified

ā€‹
createdBy
string<mongoId>

Id of the user who created the entity initially

ā€‹
lastChangedBy
string<mongoId>

Id of the user who made the last modification

ā€‹
properties
object[]

A list of properties associated with the handover provider

ā€‹
settings
object

Settings related to the handover provider

ā€‹
projectId
string

The unique identifier for the Project.

Required string length: 24
Pattern: ^[a-z0-9]{24}$

Response

Returns the handover provider object.

ā€‹
_id
string<mongoId>

The object id of the handover provider

ā€‹
referenceId
string

The referenceId of the handover provider

ā€‹
organisationId
string

The organisation Id associated with the handover provider

ā€‹
serviceId
string

The id of the service

ā€‹
service
string

The handover provider's specified service; e.g., Live Agent, Genesys

ā€‹
localeId
string

The referenceId of the locale to use

ā€‹
name
string

The name of the handover provider resource

ā€‹
createdAt
integer<int64>

Unix-timestamp when the entity was created initially

ā€‹
lastChangedAt
integer<int64>

Unix-timestamp when the entity was last modified

ā€‹
createdBy
string<mongoId>

Id of the user who created the entity initially

ā€‹
lastChangedBy
string<mongoId>

Id of the user who made the last modification

ā€‹
properties
object[]

A list of properties associated with the handover provider

ā€‹
settings
object

Settings related to the handover provider