Skip to main content
POST
/
v1
/
customers
Create a new contact
curl --request POST \
  --url https://api.nomod.com/v1/customers \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "jsmith@example.com",
  "phone_number": "<string>",
  "business_name": "<string>",
  "job_title": "<string>",
  "country": "<string>",
  "province": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "street": "<string>",
  "city": "<string>",
  "zip_code": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "first_name": "<string>",
  "last_name": "<string>",
  "business_name": "<string>",
  "job_title": "<string>",
  "province": 123,
  "city": "<string>",
  "street": "<string>",
  "zip_code": "<string>",
  "email": "jsmith@example.com",
  "phone_number": "<string>",
  "country": "<string>"
}

Authorizations

​
X-API-KEY
string
header
required

Your API key. This is required by all endpoints to access our API programatically. You can view your API Key by navigating to the app settings

Body

application/json
​
first_name
string

First name

Required string length: 1 - 150
​
last_name
string

Last name

Maximum string length: 150
​
email
string<email>

Email address.

​
phone_number
string

Phone e.g., +971500123456.

Maximum string length: 15
​
business_name
string

Business name.

Maximum string length: 50
​
job_title
string

Job Title

Maximum string length: 50
​
country
string

Country code. get it from /countries endpoint

Maximum string length: 2
​
province
string<uuid>

Province ID. get it from /provinces endpoint

​
street
string

Street address

Maximum string length: 100
​
city
string

City name.

Maximum string length: 100
​
zip_code
string

Zip/Postal code.

Maximum string length: 16

Response

​
id
string<uuid>
required
​
created
string<date-time>
required
​
first_name
string
required
​
last_name
string
required
​
business_name
string
required
​
job_title
string
required
​
province
integer
required
​
city
string
required
​
street
string
required
​
zip_code
string
required
​
email
string<email>
required
​
phone_number
string
required
​
country
string