Sign in
Label

Partial update label

Update part of label object.

patch/api/v1/labels/{labelID}

Path parameters

labelIDinteger required

A unique integer value identifying this label.

Request body

idinteger

Label object ID.

urlstring uri

Label object URL.

namestring

Text of the label.

organizationstring uri

Organization URL.

colorstring nullable

Color of the label in RGB hex format.

Example request

{
  "id": 1,
  "url": "https://example.rossum.app/api/v1/labels/1",
  "name": "expedite",
  "organization": "https://example.rossum.app/api/v1/organizations/406",
  "color": "#FF5733"
}

Response

OK

idinteger required

Label object ID.

urlstring uri required

Label object URL.

namestring required

Text of the label.

organizationstring uri required

Organization URL.

colorstring nullable required

Color of the label in RGB hex format.

Example response

{
  "id": 1,
  "url": "https://example.rossum.app/api/v1/labels/1",
  "name": "expedite",
  "organization": "https://example.rossum.app/api/v1/organizations/406",
  "color": "#FF5733"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.