Departments

PATCH /v1/departments/{department_id}

PATCH /v1/departments/{department_id}

Required scopes: departments:write

patch/v1/departments/{department_id}

Request

  • Base URL: https://api.yardstick.team
  • URL: https://api.yardstick.team/v1/departments/{department_id}
  • Auth: HTTP bearer

Path parameters

department_idstring required

Headers

Idempotency-Keystring

Supported for safe retry. Reuse the same key to receive the cached response without repeating the operation.

X-Request-Idstring

Optional caller-supplied request identifier. Values must match ^[A-Za-z0-9_-]{1,128}$; a valid value is echoed in the response X-Request-Id header, otherwise the API generates one.

Request body

namestring
descriptionstring nullable
slugstring

Response

Success

idstring required

Display id, e.g. dpt_<base32>

object'department' required
organization_idstring required

Display id, e.g. org_<base32>

namestring required
slugstring required
descriptionstring nullable required
created_atstring nullable required

ISO-8601 UTC

updated_atstring nullable required

ISO-8601 UTC

Changes

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