Create Contact Custom Field
Creates a new contact custom field in your account. Custom fields can then be set on contacts using the Contact List Contact endpoints.
Endpoint
PUT
v5/contactcustomfield
Requires authentication
Path Parameters
This endpoint does not include path parameters.
None
Query Parameters
name
string
required
The name of the custom field.
type
string
The data type of the custom field. Accepted values:
Text, Date/Time, Currency, Number, Yes/No. Defaults to Text if not specified.Response
Returns the result of the creation request and the newly created custom field object.
result_ok
boolean
Whether the request succeeded.
data
object
The newly created contact custom field object.
child attributes
id
string
The unique numeric ID assigned to the newly created custom field.
name
string
The name of the custom field.
type
string
The data type of the custom field.
Examples
Request (cURL)
curl -X PUT "https://api.alchemer.com/v5/contactcustomfield?api_token=YOUR_API_TOKEN&api_token_secret=YOUR_API_TOKEN_SECRET&name=plan_type&type=Text"
Response
{
"result_ok": true,
"data": {
"id": "6",
"name": "field_name",
"type": "Text"
}
}