Create a curation custom field

POST

/api/v3/curations/custom-fields

curl --request POST \
  --url 'https://api.tryletterhead.com/api/v3/curations/custom-fields?api=true' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "Vendor SKU", "maxLength": 60 }'

• Production

Define a new curation custom field for the company (max 20 per company). Once created, it can be set on a curation via customFields (Update a curation) or mapped from a data feed (see Create a data feed’s fieldMappings).

Authorizations

• bearerAuth

Parameters

Query Parameters

api

required

boolean

Required. Set to true to authenticate with your company API key rather than a signed-in session.

Request Body ^required

Media type application/json

object

name

required

Letters, numbers, spaces, hyphens, and underscores only (max 60 characters).

string

maxLength

required

Maximum length, in characters, of a value stored in this field (max 500).

integer

Example

{
  "name": "Vendor SKU",
  "maxLength": 60
}

Responses

201

Custom field created

Media type application/json

object

items

object

id

integer

companyId

integer

name

string

key

string

maxLength

integer

createdAt

string

updatedAt

string

message

string

total

integer

Example

{
  "items": {
    "id": 3,
    "companyId": 999999999,
    "name": "Vendor SKU",
    "key": "vendor-sku",
    "maxLength": 60,
    "createdAt": "2026-06-01T12:00:00+00:00",
    "updatedAt": "2026-06-01T12:00:00+00:00"
  },
  "message": "Custom field created.",
  "total": 1
}