PATCH /v1/conversation-folders/:id

Auth: tenant — _Status:_ stable

Rename a folder and/or change its sort position. Fields optional — apply whichever are present.

Request

Path paramTypeDescription
idintFolder id.

Body

FieldTypeDescription
namestringNew display name.
positionintNew sort order (≥ 0).
curl -X PATCH \
  -H "Authorization: Bearer atr_…" \
  -H "Content-Type: application/json" \
  -d '{"name":"Labs","position":1}' \
  http://arbiter.example.com/v1/conversation-folders/3

Response

200 OK

The updated ConversationFolder object. Field schemas: Data model → ConversationFolder.

Failure modes

StatusWhenBody
400Body isn't a JSON object; position < 0.{"error": "..."}
401Missing / invalid bearer.{"error": "..."}
404Id doesn't exist or belongs to another tenant.{"error": "folder not found"}

See also