v1

Swagger 2.02026-07-13107162315.5 KB
Contact

Creates a new external contact, optionally linked to an existing company. If CompanyName is provided and not matched, a new company is created.

post/api/Contact

Request body

CompanyIDFKinteger

The ID of an existing company to associate the contact with. If omitted, CompanyName is used to find or create a company.

CompanyNamestring

The name of the company to associate the contact with. Used to find an existing company or create a new one if not found.

CurrencyCodestring

The currency code for a newly created company. Defaults to the account's default currency if not provided.

CompanyBillingAddressstring

The full formatted billing address string for a newly created company.

CompanyBillingAddressLinestring

The street address line for the billing address of a newly created company.

CompanyBillingAddressCitystring

The city for the billing address of a newly created company.

CompanyBillingAddressStatestring

The state or province for the billing address of a newly created company.

CompanyBillingAddressPostCodestring

The postcode or ZIP code for the billing address of a newly created company.

CompanyBillingAddressCountryCodestring

The ISO 2-letter country code for the billing address of a newly created company.

ContactEmailstring required

The contact's email address. Required.

Firstnamestring required

The contact's first name. Required.

Lastnamestring required

The contact's last name. Required.

PositionTitlestring

The contact's job title or position.

Mobilestring

The contact's mobile phone number.

Phonestring

The contact's phone number.

UpdateExistingboolean

If true, updates an existing contact with the same email address instead of creating a duplicate. Defaults to true.

SendWebhooksboolean

If true, fires the contact_created webhook event to any subscribed endpoints. Defaults to false to preserve existing integration behaviour.

Response

Returns the created contact with assigned Contact ID.

ContactIDinteger

The unique identifier of the contact.

CompanyIDFKinteger

The ID of the company this contact belongs to.

CompanyNamestring

The name of the company this contact belongs to.

Firstnamestring

The contact's first name.

Lastnamestring

The contact's last name.

Emailstring

The contact's email address.

Phonestring

The contact's phone number.

Mobilestring

The contact's mobile phone number.

PositionTitlestring

The contact's job title or position.

TimeZonestring

The contact's time zone identifier.

DateCreatedstring date-time

The UTC date and time when the contact record was created.

DateUpdatedstring date-time

The UTC date and time when the contact record was last updated.