v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Contact

ContactRelationTypes.update

Modifies ContactRelationType or ContactRelationTypes with given id(s)

patch/entities/ContactRelationTypes/{id}

Path parameters

idstring uuid required

ID of ContactRelationType to update

Query parameters

validation-levelinteger

Specify validation level of ContactRelationType on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

colorinteger

Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue.

labelstring

Display label of the contact-to-contact relationship type (e.g. Spouse, Colleague).

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "color": 1,
  "label": "string",
  "revision": 1
}

Response

Modification confirmation. Returns resulting ContactRelationType

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "color": 1,
    "label": "string",
    "revision": 1
  }
}