Create a contact

POST/v1/contacts

Creates a contact. full_name and phone_number are required. Optional fields include email, type, company_name, country_name, city_name, bio, additional_attributes, and is_blocked. When omitted, type defaults to external and is_blocked defaults to false.

Body

full_namestring required

emailstring (email) or null

phone_numberstring•E.164 format when type is external required

Example:+201288899999

typeenum: internal | external

Example:external

company_namestring or null

country_namestring or null

city_namestring or null

biostring or null

additional_attributesobject

is_blockedboolean

Example:false

Responses

Body

success_codeenum: 201•Numeric success code matching the HTTP response status. required

Example:201

messagestring required

Example:Contact created

detailsobject required

dataobject (GeneralContactCreatedData) required

idstring•Created contact ULID required

Example:01kptye62pxs8pp0xkh6d5vxz2

metaobject

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

Request Sample:Shell / cURL

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

curl --request POST \
  --url "https://api-stg.bevatelcloud.com/v1/contacts" \
  --header "Authorization: Bearer <YOUR_API_KEY>" \
  --header "Content-Type: application/json" \
  --data '{
  "full_name": "Omar Test",
  "email": "[email protected]",
  "phone_number": "+201288899999",
  "company_name": "Bevatel",
  "country_name": null,
  "city_name": null,
  "bio": null,
  "type": "internal",
  "additional_attributes": {},
  "is_blocked": false
}'

Response Example

1
2
3
4
5
6
7
8
9

{
  "success_code": 201,
  "message": "Contact created",
  "details": {},
  "data": {
    "id": "01kptye62pxs8pp0xkh6d5vxz2"
  },
  "meta": {}
}