Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Tag

TagRelations.update

Modifies TagRelation or TagRelations with given id(s)

patch/entities/TagRelations/{id}

Path parameters

idstring uuid required

ID of TagRelation to update

Query parameters

validation-levelinteger

Specify validation level of TagRelation 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

account_idstring uuid

Id of the linked account.

appointment_idstring uuid

Id of the linked appointment.

contact_idstring uuid

Id of the linked contact.

custom_entity_idstring uuid

Id of the linked custom entity record.

email_idstring uuid

Id of the linked email.

lead_idstring uuid

Id of the linked lead.

oppty_idstring uuid

Id of the linked opportunity.

process_idstring uuid

Id of the linked sales process.

project_idstring uuid

Id of the linked project.

quote_idstring uuid

Id of the linked quote.

tag_idstring uuid

Id of the tag.

task_idstring uuid

Id of the linked task.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "account_id": "01234567-abcd-dcba-ffff-000000000000",
  "appointment_id": "01234567-abcd-dcba-ffff-000000000000",
  "contact_id": "01234567-abcd-dcba-ffff-000000000000",
  "custom_entity_id": "01234567-abcd-dcba-ffff-000000000000",
  "email_id": "01234567-abcd-dcba-ffff-000000000000",
  "lead_id": "01234567-abcd-dcba-ffff-000000000000",
  "oppty_id": "01234567-abcd-dcba-ffff-000000000000",
  "process_id": "01234567-abcd-dcba-ffff-000000000000",
  "project_id": "01234567-abcd-dcba-ffff-000000000000",
  "quote_id": "01234567-abcd-dcba-ffff-000000000000",
  "tag_id": "01234567-abcd-dcba-ffff-000000000000",
  "task_id": "01234567-abcd-dcba-ffff-000000000000",
  "revision": 1
}

Response

Modification confirmation. Returns resulting TagRelation

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",
    "account_id": "01234567-abcd-dcba-ffff-000000000000",
    "appointment_id": "01234567-abcd-dcba-ffff-000000000000",
    "contact_id": "01234567-abcd-dcba-ffff-000000000000",
    "custom_entity_id": "01234567-abcd-dcba-ffff-000000000000",
    "email_id": "01234567-abcd-dcba-ffff-000000000000",
    "lead_id": "01234567-abcd-dcba-ffff-000000000000",
    "oppty_id": "01234567-abcd-dcba-ffff-000000000000",
    "process_id": "01234567-abcd-dcba-ffff-000000000000",
    "project_id": "01234567-abcd-dcba-ffff-000000000000",
    "quote_id": "01234567-abcd-dcba-ffff-000000000000",
    "tag_id": "01234567-abcd-dcba-ffff-000000000000",
    "task_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1
  }
}