Skip to main content
PUT
/
customfield
/
{identifier}
Update custom field
curl --request PUT \
  --url https://api.sendx.io/api/v1/rest/customfield/{identifier} \
  --header 'Content-Type: application/json' \
  --header 'X-Team-ApiKey: <api-key>' \
  --data '{
  "name": "Customer Tier",
  "description": "Customer segmentation tier (Bronze/Silver/Gold)"
}'
{
  "id": "custom_field_abc123def456ghi789",
  "name": "Account Type",
  "type": 123,
  "description": "Customer account classification"
}
🔄 Updatable fields:
  • Field name (must remain unique)
  • Description
  • Type
⚠️ Important:
  • Existing data is preserved
  • Name changes reflect in merge tags
  • Updates don’t affect historical data
💡 Common Updates:
  • Clarify field descriptions
  • Rename for consistency
  • Toggle visibility in forms
  • Enable cross-team sharing

Authorizations

​
X-Team-ApiKey
string
header
required

Team API key for authentication. Find your API key in SendX Settings → Team API Key.

Example:

X-Team-ApiKey: your_team_api_key_here

Path Parameters

​
identifier
string
required

Custom field identifier to update

Body

application/json
​
name
string
required

Custom field name (must be unique within team)

Example:

"Account Type"

​
type
integer
required

Field data type.

Values:

  • 0 - Text (max 255 characters)
  • 1 - Number (integer or decimal)
  • 2 - Date (YYYY-MM-DD format)
  • 3 - Boolean (true/false)
  • 4 - Phone number (international format)
​
description
string
required

Field description for documentation

Example:

"Customer account classification"

Response

✅ Custom field updated successfully

​
id
string

Unique field identifier with custom_field_ prefix

Example:

"custom_field_abc123def456ghi789"

​
name
string

Custom field name

Example:

"Account Type"

​
type
integer

Field data type.

Values:

  • 0 - Text (max 255 characters)
  • 1 - Number (integer or decimal)
  • 2 - Date (YYYY-MM-DD format)
  • 3 - Boolean (true/false)
  • 4 - Phone number (international format)
​
description
string

Field description for documentation

Example:

"Customer account classification"

⌘I