Contacts

Find or create a contact by phone number

POST
/api/contacts/find-or-create-by-phone

Looks up a contact in the caller's organization by phone number, creating a new contact (placed at the first pipeline stage) when none exists. Used by the dialpad flow when an outgoing call needs a contact reference.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/contacts/find-or-create-by-phone" \  -H "Content-Type: application/json" \  -d '{    "phoneNumber": "+14165550100"  }'
{  "data": {    "_id": "64f0a1b2c3d4e5f6a7b8c9d0",    "firstName": "New Contact",    "phoneNumber": [      {        "value": "+14165550100",        "isPrimary": true      }    ]  },  "created": true}