OmnioDocsAPI referenceOpen the app

Change tag

PATCH/v1/tags/{tag_id}

Rename or recolour a tag.

Scope crm:admin

Path parameters

tag_idstring, uuidRequired

Request body

namestring
1 to 60 characters
colorstring

Response

  • 200Success
Response fields
idstringRequired
namestringRequired
colorstringRequired
created_atstringRequired
created_byobjectRequired
May be null
created_by.member_idstringRequired
created_by.display_namestringRequired

Errors

  • 401unauthorized. The key is missing, unknown or revoked
  • 403insufficient_scope. The key lacks the scope above
  • 403forbidden, or insufficient_scope
  • 404not_found
  • 409tag_exists
  • 422validation_error. details.fields names each field at fault

Every error has the same shape. See Errors.