Rename or move a folder

PATCH

/v1/tenant/asset-folders/{folderId}

curl --request PATCH \
  --url https://api.keliplay.com/v1/tenant/asset-folders/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "Autumn 2026", "parentId": null }'

• Production

Renames a folder, moves it, or both. Send parentId: null to move it to the top level. A folder cannot move inside itself.

Permission: assets.manage.

Authorizations

• apiKey

Parameters

Path Parameters

folderId

required

string

The folder’s id.

Request Body^required

Media typeapplication/json

object

name

string

>= 1 characters <= 80 characters

parentId

string | null

Example

{
  "name": "Autumn 2026",
  "parentId": null
}

Responses

200

The updated folder.

Media typeapplication/json

object

folder

required

object

id

required

string

parentId

required

The folder it sits in. Null at the top level.

string | null

name

required

string

>= 1 characters <= 80 characters

createdAt

required

string format: date-time

updatedAt

string format: date-time

Example

{
  "folder": {
    "id": "0192f3a1-0000-7000-8000-0000000f1001",
    "parentId": null,
    "name": "Autumn 2026",
    "createdAt": "2026-09-20T09:00:00.000Z",
    "updatedAt": "2026-10-05T10:00:00.000Z"
  }
}

400

The request is not valid. details lists each field that failed, where there is one.

Media typeapplication/json

object

error

required

object

code

required

Stable and safe to branch on.

• invalid_request (400): the request is not valid.
• unauthorized (401): missing, malformed or revoked API key.
• upgrade_required (402): not in your plan, or a plan limit is reached.
• forbidden (403): the key lacks a permission, or the action is not allowed.
• not_found (404): nothing with that id in your account.
• conflict (409): clashes with the current state.
• confirmation_required (409): repeat with confirm=true. Folder deletion only.
• rate_limited (429): wait for Retry-After seconds.
• internal_error (500) and service_unavailable (503): try again later.

string

Allowed values: invalid_request unauthorized upgrade_required forbidden not_found conflict confirmation_required rate_limited internal_error service_unavailable

message

required

Written for a person. May change; do not parse it.

string

details

One of:

Array<object>

Array<object>

object

path

required

The failing field, dot separated, such as prize.label.

string

message

required

string

object

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid_request",
    "message": "Invalid request json.",
    "details": [
      {
        "path": "name",
        "message": "Too small, expected string to have >=1 characters"
      }
    ]
  }
}

401

The API key is missing, malformed or revoked.

Media typeapplication/json

object

error

required

object

code

required

Stable and safe to branch on.

• invalid_request (400): the request is not valid.
• unauthorized (401): missing, malformed or revoked API key.
• upgrade_required (402): not in your plan, or a plan limit is reached.
• forbidden (403): the key lacks a permission, or the action is not allowed.
• not_found (404): nothing with that id in your account.
• conflict (409): clashes with the current state.
• confirmation_required (409): repeat with confirm=true. Folder deletion only.
• rate_limited (429): wait for Retry-After seconds.
• internal_error (500) and service_unavailable (503): try again later.

string

Allowed values: invalid_request unauthorized upgrade_required forbidden not_found conflict confirmation_required rate_limited internal_error service_unavailable

message

required

Written for a person. May change; do not parse it.

string

details

One of:

Array<object>

Array<object>

object

path

required

The failing field, dot separated, such as prize.label.

string

message

required

string

object

object

key

additional properties

any

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or revoked API key."
  }
}

403

The API key does not carry the permission this needs, or the request is not allowed.

Media typeapplication/json

object

error

required

object

code

required

Stable and safe to branch on.

• invalid_request (400): the request is not valid.
• unauthorized (401): missing, malformed or revoked API key.
• upgrade_required (402): not in your plan, or a plan limit is reached.
• forbidden (403): the key lacks a permission, or the action is not allowed.
• not_found (404): nothing with that id in your account.
• conflict (409): clashes with the current state.
• confirmation_required (409): repeat with confirm=true. Folder deletion only.
• rate_limited (429): wait for Retry-After seconds.
• internal_error (500) and service_unavailable (503): try again later.

string

Allowed values: invalid_request unauthorized upgrade_required forbidden not_found conflict confirmation_required rate_limited internal_error service_unavailable

message

required

Written for a person. May change; do not parse it.

string

details

One of:

Array<object>

Array<object>

object

path

required

The failing field, dot separated, such as prize.label.

string

message

required

string

object

object

key

additional properties

any

Example

{
  "error": {
    "code": "forbidden",
    "message": "Your role does not allow this (draws.run)."
  }
}

404

Nothing with that id exists in your account.

Media typeapplication/json

object

error

required

object

code

required

Stable and safe to branch on.

• invalid_request (400): the request is not valid.
• unauthorized (401): missing, malformed or revoked API key.
• upgrade_required (402): not in your plan, or a plan limit is reached.
• forbidden (403): the key lacks a permission, or the action is not allowed.
• not_found (404): nothing with that id in your account.
• conflict (409): clashes with the current state.
• confirmation_required (409): repeat with confirm=true. Folder deletion only.
• rate_limited (429): wait for Retry-After seconds.
• internal_error (500) and service_unavailable (503): try again later.

string

Allowed values: invalid_request unauthorized upgrade_required forbidden not_found conflict confirmation_required rate_limited internal_error service_unavailable

message

required

Written for a person. May change; do not parse it.

string

details

One of:

Array<object>

Array<object>

object

path

required

The failing field, dot separated, such as prize.label.

string

message

required

string

object

object

key

additional properties

any

Example

{
  "error": {
    "code": "not_found",
    "message": "Channel 0192f3a1-0000-7000-8000-00000000c009 not found."
  }
}

409

The request clashes with the current state. The message says what to change.

Media typeapplication/json

object

error

required

object

code

required

Stable and safe to branch on.

• invalid_request (400): the request is not valid.
• unauthorized (401): missing, malformed or revoked API key.
• upgrade_required (402): not in your plan, or a plan limit is reached.
• forbidden (403): the key lacks a permission, or the action is not allowed.
• not_found (404): nothing with that id in your account.
• conflict (409): clashes with the current state.
• confirmation_required (409): repeat with confirm=true. Folder deletion only.
• rate_limited (429): wait for Retry-After seconds.
• internal_error (500) and service_unavailable (503): try again later.

string

Allowed values: invalid_request unauthorized upgrade_required forbidden not_found conflict confirmation_required rate_limited internal_error service_unavailable

message

required

Written for a person. May change; do not parse it.

string

details

One of:

Array<object>

Array<object>

object

path

required

The failing field, dot separated, such as prize.label.

string

message

required

string

object

object

key

additional properties

any

Example

{
  "error": {
    "code": "conflict",
    "message": "An archived campaign cannot be edited. Restore it first, then make the change."
  }
}