Rename an Attribute key and dependent data

POST

attributes

{key}

rename

curl --request POST \
  --url https://app.productlasso.com/api/v1/attributes/{key}/rename \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "new_key": "material_name"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({new_key: 'material_name'})
};

fetch('https://app.productlasso.com/api/v1/attributes/{key}/rename', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://app.productlasso.com/api/v1/attributes/{key}/rename"

payload = { "new_key": "material_name" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "partial": false,
  "old_key": "<string>",
  "new_key": "<string>",
  "updated_count": 1,
  "error_count": 0,
  "attribute": {
    "id": "11111111-1111-4111-8111-111111111111",
    "key": "product_name",
    "label": "Product name",
    "type": "text",
    "format_output_type": null,
    "enum_values": null,
    "tags_values": null,
    "allow_custom_values": true,
    "boolean_config": null,
    "number_config": null,
    "relation_config": null,
    "description": "Public product title",
    "validation": null,
    "language": "en",
    "image_config": null,
    "status": "active",
    "archived_at": null,
    "is_reviewed": true,
    "source_id": null,
    "external_id": null,
    "source_synced_at": null,
    "created_at": "2026-07-01T00:00:00.000Z",
    "updated_at": "2026-07-14T10:00:00.000Z"
  },
  "results": {}
}

{
  "status_code": 123,
  "error_type": "invalid_request",
  "message": "<string>",
  "request_id": "<string>",
  "code": "<string>",
  "retryable": true,
  "attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "attribute_key": "<string>",
  "details": {},
  "current_updated_at": "2023-11-07T05:31:56Z"
}

{
  "status_code": 123,
  "error_type": "invalid_request",
  "message": "<string>",
  "request_id": "<string>",
  "code": "<string>",
  "retryable": true,
  "attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "attribute_key": "<string>",
  "details": {},
  "current_updated_at": "2023-11-07T05:31:56Z"
}

{
  "status_code": 123,
  "error_type": "invalid_request",
  "message": "<string>",
  "request_id": "<string>",
  "code": "<string>",
  "retryable": true,
  "attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "attribute_key": "<string>",
  "details": {},
  "current_updated_at": "2023-11-07T05:31:56Z"
}

{
  "status_code": 123,
  "error_type": "invalid_request",
  "message": "<string>",
  "request_id": "<string>",
  "code": "<string>",
  "retryable": true,
  "attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "attribute_key": "<string>",
  "details": {},
  "current_updated_at": "2023-11-07T05:31:56Z"
}

Atomic behavior

The handler previews the affected resources and then applies the key change and supported dependent migrations in one database operation.

200 means the atomic rename completed. Successful result buckets have code: "ok", error_count: 0, and an empty errors array.
409 means nothing was partially migrated. Detail codes include key conflicts, rename_busy, blockers, and stale_preview.
Pass attribute_id when retrying an uncertain request so the handler can identify the same Attribute even if its key already changed.
Most API clients should omit expected_impact_revision. If you provide an outdated token, the handler returns 409 stale_preview.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

key

string

required

Existing canonical Attribute key.

Body

application/json

new_key

string

required

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_/]*$

attribute_id

string<uuid>

Stable Attribute ID for retrying an uncertain rename outcome after the key may have changed.

expected_impact_revision

string

Optional optimistic-concurrency token. Most API clients should omit it; an outdated value returns 409 stale_preview.

Response

Atomic rename and all dependent migrations completed

success

boolean

required

partial

boolean

required

old_key

string

required

new_key

string

required

updated_count

integer

required

Required range: x >= 0

error_count

integer

required

attribute

object

required

Show child attributes

Example:

{
  "id": "11111111-1111-4111-8111-111111111111",
  "key": "product_name",
  "label": "Product name",
  "type": "text",
  "format_output_type": null,
  "enum_values": null,
  "tags_values": null,
  "allow_custom_values": true,
  "boolean_config": null,
  "number_config": null,
  "relation_config": null,
  "description": "Public product title",
  "validation": null,
  "language": "en",
  "image_config": null,
  "status": "active",
  "archived_at": null,
  "is_reviewed": true,
  "source_id": null,
  "external_id": null,
  "source_synced_at": null,
  "created_at": "2026-07-01T00:00:00.000Z",
  "updated_at": "2026-07-14T10:00:00.000Z"
}

results

object

required

Show child attributes

Rename an Attribute key and dependent data

curl --request POST \
  --url https://app.productlasso.com/api/v1/attributes/{key}/rename \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "new_key": "material_name"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({new_key: 'material_name'})
};

fetch('https://app.productlasso.com/api/v1/attributes/{key}/rename', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://app.productlasso.com/api/v1/attributes/{key}/rename"

payload = { "new_key": "material_name" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "partial": false,
  "old_key": "<string>",
  "new_key": "<string>",
  "updated_count": 1,
  "error_count": 0,
  "attribute": {
    "id": "11111111-1111-4111-8111-111111111111",
    "key": "product_name",
    "label": "Product name",
    "type": "text",
    "format_output_type": null,
    "enum_values": null,
    "tags_values": null,
    "allow_custom_values": true,
    "boolean_config": null,
    "number_config": null,
    "relation_config": null,
    "description": "Public product title",
    "validation": null,
    "language": "en",
    "image_config": null,
    "status": "active",
    "archived_at": null,
    "is_reviewed": true,
    "source_id": null,
    "external_id": null,
    "source_synced_at": null,
    "created_at": "2026-07-01T00:00:00.000Z",
    "updated_at": "2026-07-14T10:00:00.000Z"
  },
  "results": {}
}

{
  "status_code": 123,
  "error_type": "invalid_request",
  "message": "<string>",
  "request_id": "<string>",
  "code": "<string>",
  "retryable": true,
  "attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "attribute_key": "<string>",
  "details": {},
  "current_updated_at": "2023-11-07T05:31:56Z"
}

{
  "status_code": 123,
  "error_type": "invalid_request",
  "message": "<string>",
  "request_id": "<string>",
  "code": "<string>",
  "retryable": true,
  "attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "attribute_key": "<string>",
  "details": {},
  "current_updated_at": "2023-11-07T05:31:56Z"
}

{
  "status_code": 123,
  "error_type": "invalid_request",
  "message": "<string>",
  "request_id": "<string>",
  "code": "<string>",
  "retryable": true,
  "attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "attribute_key": "<string>",
  "details": {},
  "current_updated_at": "2023-11-07T05:31:56Z"
}

{
  "status_code": 123,
  "error_type": "invalid_request",
  "message": "<string>",
  "request_id": "<string>",
  "code": "<string>",
  "retryable": true,
  "attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "attribute_key": "<string>",
  "details": {},
  "current_updated_at": "2023-11-07T05:31:56Z"
}

Overview

Search

Enrich

Tables

Rows

Enhance

Schemas

Attributes

Files

Glossary

Credits

Product analytics

Catalog

Catalog Webhooks

Rename an Attribute key and dependent data

Atomic behavior

Authorizations

Path Parameters

Body

Response

​Atomic behavior

Authorizations

Path Parameters

Body

Response

Atomic behavior