Skip to main content

Documentation Index

Fetch the complete documentation index at: https://orbit-docs.devotel.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Custom Fields API

Extend the contact schema with typed fields specific to your business — lifetime_value, plan_tier, last_login_at, account_manager, etc. Custom fields are referenced from segment rules, flow conditions, message personalization, and the inbox UI. Base path: /v1/custom-fields Authentication: API key (X-API-Key) or session JWT.

​
Definitions

MethodPathPurpose
GET/v1/custom-fields/List field definitions
POST/v1/custom-fields/Create a definition
GET/v1/custom-fields/{id}Get a definition
PATCH/v1/custom-fields/{id}Update name / type / description
DELETE/v1/custom-fields/{id}Delete (also removes all values)
POST/v1/custom-fields/reorderReorder definitions for the dashboard UI

​
Values

Per-contact values are written via a single endpoint and read inline as part of the contact resource.
MethodPathPurpose
PUT/v1/custom-fields/valuesSet a custom-field value on a contact

​
Example — define a lifetime-value field, then set it

# 1. Define
curl -X POST https://orbit-api.devotel.io/api/v1/custom-fields/ \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "key": "ltv_usd", "type": "number", "label": "Lifetime value (USD)" }'

# 2. Set on a contact
curl -X PUT https://orbit-api.devotel.io/api/v1/custom-fields/values \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "contact_id": "ct_abc123", "key": "ltv_usd", "value": 482.50 }'

​
See also