Skip to main content
POST
/
api
/
contacts
Create Contact
curl --request POST \
  --url https://api.example.com/api/contacts

​
Request

curl -X POST https://app.orova.ai/api/contacts \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "contactName": "John Doe",
    "phoneNumber": "+1234567890",
    "region": "US East",
    "workspaceId": "WORKSPACE_ID",
    "externalFields": {
      "accountNumber": "ACC-001",
      "company": "Acme Corp"
    }
  }'

​
Parameters

FieldTypeRequiredDescription
contactNamestringYesContact name
phoneNumberstringYesPhone number (E.164)
regionstringNoGeographic region (auto-detected from phone number if not provided)
workspaceIdstringYesWorkspace ID
externalFieldsobjectNoCustom key-value fields

​
Response

{
  "_id": "contact_id",
  "contactName": "John Doe",
  "phoneNumber": "+1234567890",
  "region": "US East",
  "workspaceId": "WORKSPACE_ID",
  "externalFields": {
    "accountNumber": "ACC-001",
    "company": "Acme Corp"
  },
  "createdAt": "2025-01-01T00:00:00.000Z"
}