Update contact

put

https://api.wafeq.com/v1/contacts/{id}/

Endpoint for updating an existing contact.

Path Params

string

required

Query Params

expand

string

Comma-separated related objects to return in full instead of as IDs. Accepted values: persons. Nested relations are joined with a dot.

Body Params

A contact of the organization, such as a customer or supplier.

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

ISO 3166 two-letter country code representing the country of the contact.

View the enum reference

custom_fields

string

The custom fields of the contact.

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.

is_customer

boolean

Whether the contact is a customer. A sales document sets it; you can set it, and remove it unless a sales document that is not deleted, drafts and voids included, names the contact.

is_free_zone

boolean

Whether the contact is licensed in a UAE free zone. Can be true only for an organization in the United Arab Emirates.

is_supplier

boolean

Whether the contact is a supplier. A purchase document sets it; you can set it, and remove it unless a purchase document that is not deleted, drafts and voids included, names the contact.

name

string

required

The full name or business name of the contact.

party_type

string

enum

The kind of party the contact is, for tax and e-invoicing purposes; null when not set.

View the enum reference

Allowed:

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. Customer and Supplier are deprecated: use is_customer and is_supplier. Adding either still sets the matching role.

relationship

tax_identification_number

string

The tax identification number (TIN) of the contact, if applicable. For UAE organizations, the 10-digit identity the FTA issued the taxpayer.

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

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

Language

Credentials

Header

Loading…

Response

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

application/json

200