Bulk Create Tags
Creates multiple tags in a single request. Returns lists of successful and failed tag creations with detailed error reasons.
/api/v1/{team_slug}/{app_slug}/tags/bulk- API
- Management
- OpenAPI
- management-api
- Updated
- Apr 26, 2026
management-api:POST:/api/v1/{team_slug}/{app_slug}/tags/bulk
Creates multiple tags in a single request. Returns lists of successful and failed tag creations with detailed error reasons.
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\}/tags/bulk - Summary: Bulk Create Tags
- Description: Creates multiple tags in a single request. Returns lists of successful and failed tag creations with detailed error reasons.
- 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.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| team_slug | path | Yes | string | Team slug |
| app_slug | path | Yes | string | App slug |
Request body
- Required: Yes
- Description: Tags data to create
- Content: application/json (object)
Bulk Create Tags Payload
| Property | Type | Required | Details |
|---|---|---|---|
tags | object[] | Yes | maxItems: 50 |
Create Tag Payload
| Property | Type | Required | Details |
|---|---|---|---|
attributes_keys | string[] | No | - |
filterable | boolean | No | - |
key | string | Yes | minLength: 0 |
name | string | Yes | minLength: 0 |
status | enum("active", "inactive", "archived", "draft") | Yes | - |
Generated example (synthetic):
{
"tags": [
{
"attributes_keys": [
"string"
],
"filterable": false,
"key": "string",
"name": "string",
"status": "active"
}
]
}Responses
| Status | Description | Content |
|---|---|---|
| 201 | Tags 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
Bulk Create Tags 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 | - |
Bulk Create Tags
| Property | Type | Required | Details |
|---|---|---|---|
failed | object[] | No | - |
successful | object[] | No | - |
Bulk Create Tag Failed Creation
| Property | Type | Required | Details |
|---|---|---|---|
key | string | No | - |
reason | string | No | - |
Tag
| Property | Type | Required | Details |
|---|---|---|---|
attributes | object[] | No | - |
created_at | string | No | - |
filterable | boolean | No | - |
id | string | No | - |
key | string | No | - |
markets | object[] | No | - |
name | string | No | - |
schedules | object[] | No | - |
source_app_id | string | No | - |
source_id | string | No | - |
status | string | No | - |
translations | object | No | - |
updated_at | string | No | - |
Generated example (synthetic):
{
"data": {
"failed": [
{
"key": "string",
"reason": "string"
}
],
"successful": [
{
"attributes": [],
"created_at": "string",
"filterable": false,
"id": "string",
"key": "string",
"markets": [],
"name": "string",
"schedules": [],
"source_app_id": "string",
"source_id": "string",
"status": "string",
"translations": {
"name": null
},
"updated_at": "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):
{
"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):
{
"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):
{
"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\}/tags/bulk - Operation ID: Not documented in the OpenAPI contract.
- OpenAPI tag: Tags, Bulk
- OpenAPI summary: Bulk Create Tags