Update Destination-Service Group

patch https://examplebaseURL.com/v1/api/apps/{appID}/destination/{destinationID}

Response Format

Parameter	Type	Description
code	Number	Refer to [Success and Error Code] (https://docs.cinnox.com/reference/error-codes-and-rate-limit)
id	String	ID of the updated destination

Path Params

appID

string

required

App ID

destinationID

string

required

ID of the destination you are required to update. This ID can be found in the response of Create destination endpoint.

Body Params

displayName (Required)

string

The updated Service Group Name. The maximum limit is 40 characters

supportLanguages (Required)

array of strings

A list of the updated language the staff will use to engage with the customer or visitor. It supports multiple language codes ("*" = support all languages in the request body).

supportLanguages (Required)

supportLocations (Required)

array of strings

A list of the updated location the service group will support. The format: countries/regions + states. It supports multiple location ("*" = support all countries/regions in the request body)

supportLocations (Required)

types (Required)

array of strings

A list of the updated Destination type. Supported type: PHONE / STAFF / TRUNK (All capital letters)

types (Required)

phoneTargets

array of strings

A list of the updated PSTN Number with country code. Required when selected the PHONE type

phoneTargets

staffTargets

array of strings

A list of the updated Staff ID. Required when you select the STAFF type.

staffTargets

trunkTargets

array of strings

A list of the updated Sip Trunk Number with country code. Required when you select the Sip TRUNK type.

trunkTargets

Headers

Content-Type

string

application/json

Authorization

string

Bearer AppToken

Responses

Language


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://examplebaseurl.com/v1/api/apps/appID/destination/destinationID \
3
     --header 'Authorization: Bearer AppToken' \
4
     --header 'Content-Type: application/json' \
5
     --header 'accept: application/json'

Choose an example:

application/json

Response Format

200200

400400