ROrossum
Label

Partial update label

Changed on

Update part of label object.

patch/api/v1/labels/{labelID}

Request

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

  • f1b5a910991dRevision changes
    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added subschema #2 to the response body allOf list for the response status