asset-folders

Create a folder in the media library

Creates a folder in the workspace's media library. Omit parent_id to create it at the top level, or name another folder to nest it up to 10 levels deep. A workspace supports up to 1,000 active folders and 10,000 retained folders, including deleted folders. Deleting a folder frees an active slot but does not release retained capacity.

Folders organize the library for the people browsing it. They are never part of an asset's URL, so filing an asset, renaming a folder, or moving a whole branch leaves every message that already embeds those assets rendering exactly as it did.

post/v1/asset-folders

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/asset-folders
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Headers

Idempotency-Keystring

Client-supplied key. On operations supporting request deduplication, a retained response is replayed for duplicate requests with the same key within the idempotency window (3 hours by default). This protection requires a workspace, organization, or staff-account scope. User-only and unscoped unauthenticated operations, streams, and operations with a separate replay contract do not use this response replay.

On a supported operation, if idempotency protection is unavailable before execution, the API returns 503 IdempotencyUnavailable (E01033) without executing this attempt. Retry with backoff using the same key and request. An operation that takes effect before its response is retained can still execute again on retry.

Two distinct 409 errors signal misuse:

  • request_in_progress (E01004): The same key is currently being processed by a concurrent request. Wait briefly and retry. The lock expires within 30 seconds.
  • idempotency_key_reuse (E01005): The same key has already completed against a different request body or method. Generate a new key.

Recommended key format is <event-type>/<entity-id> (for example welcome-user/usr_abc123).

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Request body

namestring required

The folder's display name. Must be unique among folders sharing the same parent, compared without regard to case. Cannot contain /.

parent_idstring

Example request

{
  "name": "Campaign images"
}

Response

The created folder.

created_atstring date-time required
updated_atstring date-time required
idstring required
namestring required

The folder's display name. Unique among folders sharing the same parent, compared without regard to case.

parent_idstring required
pathstring required

The folder's location written out from the top level, such as /Marketing/Logos. Provided so a caller can display a folder without walking its parents.

Example response

{
  "created_at": "2026-05-20T09:14:52Z",
  "updated_at": "2026-05-25T16:42:01Z",
  "id": "asf_01krdgeqcxet5s7t44vh8rt9mg",
  "parent_id": "asf_01krdgeqcxet5s7t44vh8rt9mg"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.