Partial Update Department

PATCH /coa/api/department/{id}

Partial Update Department

cURL

curl --request PATCH \
  --url https://api.meetcampfire.com/coa/api/department/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "active": true,
  "code": "<string>",
  "name": "<string>",
  "display_name": "<string>",
  "tag_ids": [
    0
  ],
  "tag_group_ids": [
    0
  ],
  "parent": 123
}
'

200

{
  "id": 123,
  "parent_name": "<string>",
  "tags": [
    {
      "id": 123,
      "group_name": "<string>",
      "parent_name": "<string>",
      "is_deleted": false,
      "deleted_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "last_modified_at": "2023-11-07T05:31:56Z",
      "customer": 123,
      "parent": 123,
      "is_active": true,
      "group": 123
    }
  ],
  "last_modified_at": "2023-11-07T05:31:56Z",
  "code": "<string>",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "customer": 123,
  "active": true,
  "display_name": "<string>",
  "tag_ids": [
    0
  ],
  "tag_group_ids": [
    0
  ],
  "parent": 123
}

Authorizations

Authorization · string · header · required

Token-based authentication with required prefix "Token"

Path Parameters

id · integer · required

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

active · boolean · default: true

code · string

Maximum string length: 250

name · string | null

Maximum string length: 250

display_name · string | null

Maximum string length: 600

tag_ids · integer<int64>[]

Required range: -9223372036854776000 <= x <= 9223372036854776000

tag_group_ids · integer<int64>[]

Required range: -9223372036854776000 <= x <= 9223372036854776000

parent · integer | null

Response

200 - application/json

id · integer · required · read-only

parent_name · string · required · read-only

tags · object[] · required · read-only

Show child attributes

last_modified_at · string<date-time> · required · read-only

code · string · required

Maximum string length: 250

name · string | null · required

Maximum string length: 250

created_at · string<date-time> · required · read-only

customer · integer · required · read-only

active · boolean · default: true

display_name · string | null

Maximum string length: 600

tag_ids · integer<int64>[]

Required range: -9223372036854776000 <= x <= 9223372036854776000

tag_group_ids · integer<int64>[]

Required range: -9223372036854776000 <= x <= 9223372036854776000

parent · integer | null