Create a new shareable link

Creates a new shareable link that allows sharing of DAM resources (folders, images, videos, files) with optional description and expiration date

POST/api/v1/{team_slug}/{app_slug}/dam/shareable-links
API
Management
Updated
Apr 26, 2026

management-api:POST:/api/v1/{team_slug}/{app_slug}/dam/shareable-links

Creates a new shareable link that allows sharing of DAM resources (folders, images, videos, files) with optional description and expiration date

API ownership

  • API family: Management API
  • Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
  • Do not use from: Browser-only storefront code or public clients.
  • Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

  • Method: POST
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/dam/shareable-links
  • Summary: Create a new shareable link
  • Description: Creates a new shareable link that allows sharing of DAM resources (folders, images, videos, files) with optional description and expiration date
  • OpenAPI contract: management-api
  • Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters2 parameters
NameInRequiredTypeDescription
app_slugpathYesstringApp slug
team_slugpathYesstringTeam slug
Request bodyDocumented body
  • Required: Yes
  • Description: Shareable link details
  • Content: application/json (object)
PropertyTypeRequiredDetails
descriptionstringNo-
expires_atstringNo-

Generated example (synthetic):

{
  "description": "string",
  "expires_at": "string"
}
Responses4 statuses
StatusDescriptionContent
201Shareable link created successfullyapplication/json (object)
400Invalid requestapplication/json (object)
401Unauthorized accessapplication/json (object)
500Internal server errorapplication/json (object)

201 - object

PropertyTypeRequiredDetails
dataobjectNo-
detailsstring[]NoAdditional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
successbooleanNo-
PropertyTypeRequiredDetails
created_atstringNo-
descriptionstringNo-
expires_atstringNo-
file_idsstring[]No-
folder_idsstring[]No-
idstringNo-
image_idsstring[]No-
tokenstringNo-
updated_atstringNo-
video_idsstring[]No-

Generated example (synthetic):

{
  "data": {
    "created_at": "string",
    "description": "string",
    "expires_at": "string",
    "file_ids": [
      "string"
    ],
    "folder_ids": [
      "string"
    ],
    "id": "string",
    "image_ids": [
      "string"
    ],
    "token": "string",
    "updated_at": "string",
    "video_ids": [
      "string"
    ]
  },
  "details": [
    "string"
  ],
  "success": false
}

400 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

401 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

  • API family: Management API
  • Method: POST
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/dam/shareable-links
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: DAM
  • OpenAPI summary: Create a new shareable link

Create a new shareable link

# Create a new shareable link Creates a new shareable link that allows sharing of DAM resources (folders, images, videos, files) with optional description and expiration date
POST /api/v1/{team_slug}/{app_slug}/dam/shareable-links
Purpose

Creates a new shareable link that allows sharing of DAM resources (folders, images, videos, files) with optional description and expiration date

Required inputs

app_slug path team_slug path

Primary response

201 ยท Shareable link created successfully

Operation key

management-api:POST:/api/v1/{team_slug}/{app_slug}/dam/shareable-links

## API ownership - API family: Management API - Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data. - Do not use from: Browser-only storefront code or public clients. - Guide route: [/apis/management/latest](/apis/management/latest) The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation. ## Operation - Method: `POST` - Path: `/api/v1/{team_slug}/{app_slug}/dam/shareable-links` - Summary: Create a new shareable link - Description: Creates a new shareable link that allows sharing of DAM resources (folders, images, videos, files) with optional description and expiration date - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:POST:/api/v1/{team_slug}/{app_slug}/dam/shareable-links` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | app_slug | path | Yes | string | App slug | | team_slug | path | Yes | string | Team slug | ## Request body - Required: Yes - Description: Shareable link details - Content: application/json (object) ### Create Shareable Link Request | Property | Type | Required | Details | | --- | --- | --- | --- | | `description` | string | No | - | | `expires_at` | string | No | - | **Generated example (synthetic):** ```json { "description": "string", "expires_at": "string" } ``` ## Responses | Status | Description | Content | | --- | --- | --- | | 201 | Shareable link created successfully | application/json (object) | | 400 | Invalid request | application/json (object) | | 401 | Unauthorized access | application/json (object) | | 500 | Internal server error | application/json (object) | ### 201 - object #### Shareable Link Response | Property | Type | Required | Details | | --- | --- | --- | --- | | `data` | object | No | - | | `details` | string[] | No | Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes | | `success` | boolean | No | - | ##### Shareable Link | Property | Type | Required | Details | | --- | --- | --- | --- | | `created_at` | string | No | - | | `description` | string | No | - | | `expires_at` | string | No | - | | `file_ids` | string[] | No | - | | `folder_ids` | string[] | No | - | | `id` | string | No | - | | `image_ids` | string[] | No | - | | `token` | string | No | - | | `updated_at` | string | No | - | | `video_ids` | string[] | No | - | **Generated example (synthetic):** ```json { "data": { "created_at": "string", "description": "string", "expires_at": "string", "file_ids": [ "string" ], "folder_ids": [ "string" ], "id": "string", "image_ids": [ "string" ], "token": "string", "updated_at": "string", "video_ids": [ "string" ] }, "details": [ "string" ], "success": false } ``` ### 400 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 401 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 500 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ## Contract identity Use these fields to confirm you are implementing the intended endpoint contract. - API family: Management API - Method: `POST` - Path: `/api/v1/{team_slug}/{app_slug}/dam/shareable-links` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:POST:/api/v1/{team_slug}/{app_slug}/dam/shareable-links` - OpenAPI tag: DAM - OpenAPI summary: Create a new shareable link