Sign in

v1

latestOpenAPI 3.0.0proprietary2026-07-261695971.5 MB
Contact

Update a Contact

Updates a given Contact. Any parameters not provided are left unchanged.

patch/contacts/{contactId}

Path parameters

contactIdstring uuid required

The unique identifier for a resource.

Example:9a93d3b5-fb3b-4abf-9e70-26315b33506c

Contact Id

Request body

first_namestring
last_namestring
emailstring email
locale'en' | 'fr' | 'de' | 'it' | 'nl' | 'es' | 'pl' | 'pt' | 'ro'

Locale settings used for communication.

phone_numberstring nullable

E.164 format

company_namestring safe-string nullable

This property is a Safe String.

job_titlestring safe-string nullable

This property is a Safe String.

address_line_1string safe-string nullable

This property is a Safe String.

address_line_2string safe-string nullable

This property is a Safe String.

address_citystring safe-string nullable

This property is a Safe String.

address_postal_codestring safe-string nullable

This property is a Safe String.

address_countrystring safe-string nullable

This property is a Safe String.

workspace_idstring uuid nullable

Example request

{
  "email": "john.doe@example.com",
  "locale": "fr",
  "phone_number": "+41446667700",
  "company_name": "Youtrust SAS",
  "job_title": "Developer",
  "address_line_1": "34 Rue Malfilatre",
  "address_line_2": "1st floor",
  "address_city": "Caen",
  "address_postal_code": "14000",
  "address_country": "France",
  "workspace_id": "69120884-d29a-4b1a-ac7b-a9e73a872795"
}

Response

OK

idstring uuid required

Unique identifier of the Contact.

first_namestring required

First name of the Contact.

last_namestring required

Last name of the Contact.

emailstring email required

Email of the Contact.

locale'en' | 'fr' | 'de' | 'it' | 'nl' | 'es' | 'pl' | 'pt' | 'ro' required

Locale of the Contact.

phone_numberstring required

Phone number of the Contact.

company_namestring required

Company name of the Contact.

job_titlestring required

Job title of the Contact.

address_line_1string required

Primary address line, typically including street number and name.

address_line_2string required

Additional address information, such as apartment, suite, or building name.

address_citystring required

City of the Contact’s address.

address_postal_codestring required

Postal or ZIP code of the Contact’s address.

address_countrystring required

Country of the Contact’s address.

workspace_idstring uuid required

Unique identifier of the Workspace in which the Contact is visible.

Example response

{
  "id": "550e8402-e29b-41d4-a716-446655440000",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com",
  "locale": "fr",
  "phone_number": "+41446667700",
  "company_name": "Acme Corp",
  "job_title": "Dynamic Communications Director",
  "address_line_1": "742 Evergreen Terrace",
  "address_line_2": "Apt. 2B",
  "address_city": "Springfield",
  "address_postal_code": "62704",
  "address_country": "United States",
  "workspace_id": "550e8402-e29b-41d4-a716-446655440000"
}