Create a Contact

Add a new contact to your account. Phone numbers are automatically normalized to E.164 format. Permission: contacts:create

POST /api/contacts

Create a contact

cURL

curl --request POST \
  --url https://api.recepta.ai/api/v1/api/contacts \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "[e-mail]",
  "phone": "[phone]",
  "source": "API",
  "tags": [
    "lead"
  ],
  "status": "active",
  "notes": "Met at conference",
  "company_name": "Acme Corp",
  "address": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zipCode": "<string>",
  "country": "<string>",
  "customFields": {}
}
'

201

{
  "success": true,
  "message": "Client created successfully",
  "data": {
    "client": {
      "id": "697929d5ebccbcca5cdaf13b",
      "firstName": "Jane",
      "lastName": "Doe",
      "fullName": "Jane Doe",
      "email": "[e-mail]",
      "phone": "[phone]",
      "source": "API",
      "tags": [
        "lead",
        "website"
      ],
      "status": "active",
      "notes": "Interested in premium plan",
      "company_name": "Acme Corp",
      "address": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zipCode": "<string>",
      "country": "<string>",
      "customFields": {
        "referralSource": "google"
      },
      "isActive": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  }
}

Authorizations

x-api-key · string · header · required

Your Recepta API key (starts with rcp_)

Body

application/json

firstName · string

Example:

"Jane"

lastName · string

Example:

"Doe"

email · string

Example:

"[e-mail]"

phone · string

Phone number (auto-normalized to E.164)

Example:

"[phone]"

source · enum<string> · default: API

Available options: MANUAL, FACEBOOK, CSV, API, CALL

tags · string[]

Example:

["lead"]

status · string

Example:

"active"

notes · string

Example:

"Met at conference"

company_name · string

Example:

"Acme Corp"

address · string

city · string

state · string

zipCode · string

country · string

customFields · object

Arbitrary key-value pairs

Response

201

application/json

Contact created

success · boolean

Example:

true

message · string

Example:

"Client created successfully"

data · object

Show child attributes