Update Contact Custom Field
Updates a specified contact custom field. The name parameter is required; type is optional and defaults to Text if not provided.
Endpoint
POST
v5/contactcustomfield/{field_id}
Requires authentication
Path Parameters
The custom field to update.
field_id
string
required
The ID of the contact custom field to update.
Query Parameters
name
string
The updated name for the custom field.
type
string
The updated data type for the custom field. Accepted values:
Text, Date/Time, Currency, Number, Yes/No. Defaults to Text if not specified.Response
Returns the updated custom field object.
result_ok
boolean
Whether the request succeeded.
data
object
The updated contact custom field object.
child attributes
id
string
The unique numeric ID of the custom field.
name
string
The updated name of the custom field.
type
string
The data type of the custom field.
Examples
Request (cURL)
curl -X POST "https://api.alchemer.com/v5/contactcustomfield/YOUR_FIELD_ID?api_token=YOUR_API_TOKEN&api_token_secret=YOUR_API_TOKEN_SECRET&name=updated_field_name&type=Text"
Response
{
"result_ok": true,
"data": {
"id": "6",
"name": "updated_field_name",
"type": "Text"
}
}