Sign in

v1

latestOpenAPI 3.0.02026-07-14362240.2 KB
external-lines

Update an external line

Updates the configuration of an existing external communication line.

patch/messenger/v1/external-lines/{id}

Path parameters

idstring required

The unique identifier of the external line to update

Request body

namestring required

The name of the external line

iconstring required

The icon of the external line

externalIdstring required

The external id of the external line

Example request

{
  "name": "External line name",
  "icon": "https://external-line-icon.com/icon.png",
  "externalId": "external-line-external-id"
}

Response

The updated external line

idstring required

External line id

namestring required

External line name

iconstring required

External line icon

externalIdstring required

External line external id

timestampnumber required

External line timestamp

portalstring required

External line portal

phoneNumberstring required

External line phone number

Example response

{
  "id": "659ff121fd62e43063340f2f",
  "name": "Main line",
  "icon": "https://example.com/icon.png",
  "externalId": "externalId",
  "timestamp": 1620211200000,
  "portal": "portal",
  "phoneNumber": "+1234567890"
}