curl --request PUT \
--url https://api.callva.io/api/v1/external/custom-fields/{custom_field} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"options": "<string>"
}
'import requests
url = "https://api.callva.io/api/v1/external/custom-fields/{custom_field}"
payload = { "options": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({options: '<string>'})
};
fetch('https://api.callva.io/api/v1/external/custom-fields/{custom_field}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"message": "Custom field updated successfully",
"data": {
"id": "<string>",
"tenant_id": "<string>",
"entity_type": "<string>",
"field_key": "<string>",
"field_label": "<string>",
"field_type": "<string>",
"is_required": true,
"is_filterable": true,
"is_sortable": true,
"is_groupable": true,
"is_searchable": true,
"is_system": true,
"is_visible": true,
"sort_order": 123,
"options": {},
"validation_rules": {},
"default_value": "<string>",
"help_text": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"project_id": "<string>",
"extraction_enabled": true,
"extraction_prompt": "<string>"
}
}{
"success": true,
"message": "<string>"
}{
"error": "Invalid or expired token",
"message": "The provided token is invalid or has expired"
}{
"success": false,
"message": "Insufficient permission.",
"code": "insufficient_permission"
}{
"message": "<string>"
}{
"success": true,
"message": "<string>",
"errors": {}
}Update a custom field
Requires permission: fields.update.
What a token may call depends on its role: see Authentication and permissions. Guide: Custom fields.
curl --request PUT \
--url https://api.callva.io/api/v1/external/custom-fields/{custom_field} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"options": "<string>"
}
'import requests
url = "https://api.callva.io/api/v1/external/custom-fields/{custom_field}"
payload = { "options": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({options: '<string>'})
};
fetch('https://api.callva.io/api/v1/external/custom-fields/{custom_field}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"message": "Custom field updated successfully",
"data": {
"id": "<string>",
"tenant_id": "<string>",
"entity_type": "<string>",
"field_key": "<string>",
"field_label": "<string>",
"field_type": "<string>",
"is_required": true,
"is_filterable": true,
"is_sortable": true,
"is_groupable": true,
"is_searchable": true,
"is_system": true,
"is_visible": true,
"sort_order": 123,
"options": {},
"validation_rules": {},
"default_value": "<string>",
"help_text": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"project_id": "<string>",
"extraction_enabled": true,
"extraction_prompt": "<string>"
}
}{
"success": true,
"message": "<string>"
}{
"error": "Invalid or expired token",
"message": "The provided token is invalid or has expired"
}{
"success": false,
"message": "Insufficient permission.",
"code": "insufficient_permission"
}{
"message": "<string>"
}{
"success": true,
"message": "<string>",
"errors": {}
}Authorizations
A CallVA API token, sent as Authorization: Bearer <token>.
Creating one. In the CallVA dashboard, open the organization's Settings, then API Keys, and choose Create API Key: give the key a name, choose its role, and choose its project scope - All projects for an organization-wide token, or one project for a project token. The key is shown once, when it is created, and cannot be read again; store it then. Creating keys needs the api_tokens.create permission, which owners and admins hold, and a key cannot create another key.
Organization-wide or project token. A project token works in the one project it was created for; any project named in the request is ignored. An organization-wide token reaches the projects of its organization, and each request names its project with the X-Project-ID header or project_id (query string for reads and deletes, body for writes).
What it can call. The token's role decides which endpoints it may call; each endpoint names the permission it requires, and a token whose role lacks it is answered 403.
Headers
The project this request acts in. Required with an organization-wide token (or send project_id instead); ignored with a project token, which always acts in its own project.
Path Parameters
The custom field ID