curl --request POST \
--url https://{subdomain}.conveyour.com/api/fields \
--header 'Content-Type: application/json' \
--header 'x-conveyour-token: <api-key>' \
--data '
{
"name": "<string>",
"label": "<string>",
"type": "<string>",
"bucket_id": "<string>",
"values": [
"<string>"
]
}
'const options = {
method: 'POST',
headers: {'x-conveyour-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
label: '<string>',
type: '<string>',
bucket_id: '<string>',
values: ['<string>']
})
};
fetch('https://{subdomain}.conveyour.com/api/fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'POST',
headers: {'x-conveyour-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
label: '<string>',
type: '<string>',
bucket_id: '<string>',
values: ['<string>']
})
};
fetch('https://{subdomain}.conveyour.com/api/fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{subdomain}.conveyour.com/api/fields"
payload = {
"name": "<string>",
"label": "<string>",
"type": "<string>",
"bucket_id": "<string>",
"values": ["<string>"]
}
headers = {
"x-conveyour-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{subdomain}.conveyour.com/api/fields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'label' => '<string>',
'type' => '<string>',
'bucket_id' => '<string>',
'values' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-conveyour-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"status": "ok",
"message": "Custom field created",
"data": {
"id": "64a1b2c3d4e5f6a7b8c9d0e1"
}
}{
"status": "failed",
"message": "Token is either expired or does not have the correct permissions",
"data": []
}Create a field
Creates a new custom contact field.
Create a custom field
curl --request POST \
--url https://{subdomain}.conveyour.com/api/fields \
--header 'Content-Type: application/json' \
--header 'x-conveyour-token: <api-key>' \
--data '
{
"name": "<string>",
"label": "<string>",
"type": "<string>",
"bucket_id": "<string>",
"values": [
"<string>"
]
}
'const options = {
method: 'POST',
headers: {'x-conveyour-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
label: '<string>',
type: '<string>',
bucket_id: '<string>',
values: ['<string>']
})
};
fetch('https://{subdomain}.conveyour.com/api/fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'POST',
headers: {'x-conveyour-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
label: '<string>',
type: '<string>',
bucket_id: '<string>',
values: ['<string>']
})
};
fetch('https://{subdomain}.conveyour.com/api/fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{subdomain}.conveyour.com/api/fields"
payload = {
"name": "<string>",
"label": "<string>",
"type": "<string>",
"bucket_id": "<string>",
"values": ["<string>"]
}
headers = {
"x-conveyour-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{subdomain}.conveyour.com/api/fields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'label' => '<string>',
'type' => '<string>',
'bucket_id' => '<string>',
'values' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-conveyour-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"status": "ok",
"message": "Custom field created",
"data": {
"id": "64a1b2c3d4e5f6a7b8c9d0e1"
}
}{
"status": "failed",
"message": "Token is either expired or does not have the correct permissions",
"data": []
}Authorizations
Your API key token. Contacts endpoints require a Server-only — Full API key — see Authentication.
Query Parameters
Team scope for the request, as one or more team ObjectIds. The brackets are required: PHP keeps only the last value for a repeated plain key, so teams=A&teams=B silently resolves to B alone. On requests with a JSON body you may send teams (no brackets) in the body instead.
Values that are not valid ObjectIds are silently ignored — a mistyped team ID behaves as if no team was sent. See the teams section of the API conventions guide.
Body
The snake_case identifier for this field. Must be unique within your org. Used in Liquid templates as contact.badge_number.
Human-readable label shown in the ConveYour UI.
Field data type. One of: string, int, bool, list, date, email, textarea, time, image, secret, related_contacts, relation, user_list, id_number, related_custom_object. Defaults to string when omitted.
The ID of the bucket (field group) this field belongs to. Required on create — the bucket must belong to your org.
For list fields — an array of allowed option values.
Response
Success.