Sign in

v1

latestOpenAPI 3.0.02026-07-1315476656.4 KB
CommunicationWay

Update a existing communication way

Update a communication way

put/CommunicationWay/{communicationWayId}

Path parameters

communicationWayIdinteger required

ID of CommunicationWay to update

Request body

type'EMAIL' | 'PHONE' | 'WEB' | 'MOBILE'

Type of the communication way

valuestring

The value of the communication way.<br> For example the phone number, e-mail address or website.

mainboolean nullable

Defines whether the communication way is the main communication way for the contact.

Example request

{
  "contact": {
    "objectName": "Contact"
  },
  "type": "EMAIL",
  "key": {
    "objectName": "CommunicationWayKey"
  }
}

Response

Successful operation - Returns changed CommunicationWay resource

idstring

The communication way id

objectNamestring

The communication way object name

createstring date-time

Date of communication way creation

updatestring date-time

Date of last communication way update

type'EMAIL' | 'PHONE' | 'WEB' | 'MOBILE'

Type of the communication way

valuestring

The value of the communication way.<br> For example the phone number, e-mail address or website.

mainstring

Defines whether the communication way is the main communication way for the contact.

Example response

{
  "id": "0",
  "objectName": "CommunicationWay",
  "contact": {
    "id": "0",
    "objectName": "Contact"
  },
  "type": "EMAIL",
  "key": {
    "id": "0",
    "objectName": "CommunicationWayKey"
  },
  "main": "0",
  "sevClient": {
    "id": "0",
    "objectName": "SevClient"
  }
}