Create contact

post

https://api.wafeq.com/v1/contacts/

Endpoint for creating a new contact.

Body Params

additional_number

string

Additional number for the address, if applicable.

address

string

The street address of the contact.

attachments

array of strings

A list of attachments associated with this contact.

attachments

building_number

string

The building number. Should be 4 digits for KSA addresses. For other countries, follow local conventions.

city

string

The city where the contact is located.

code

string

The unique contact code used for identification purposes.

company_identification

array of objects

The company identification of the contact.

CompanyIdentificationCustomerSchema

country

string

enum

SA - Kingdom of Saudi Arabia
AE - United Arab Emirates
QA - Qatar
BH - Bahrain
KW - Kuwait
OM - Oman
EG - Egypt
US - United States of America
AF - Afghanistan
AX - Åland Islands
...

Full information for CountryEnum

district

string

The district or neighborhood within the city where the contact is located.

string

The primary email address for contacting the contact.

external_id

string

length ≤ 255

External identifier for the contact.

name

string

required

The full name or business name of the contact.

phone

string

The primary phone number for contacting the contact.

postal_code

string

The postal code or ZIP code. Should be 5 digits for KSA addresses. For other countries, follow local postal code formats.

relationship

array

A list of tags describing the relationship with the contact. Can be Customer, Supplier, Investor, Partner, Other.

relationship

tax_registration_number

string

The tax registration number of the contact, if applicable.

Headers

X-Wafeq-Idempotency-Key

string

Client-provided UUID to uniquely identify a request

Response

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201