Sign in
Contact

Create contact

post/v1/contacts

Request body

idinteger
departmentIdinteger
firstNamestring required
lastNamestring nullable
fullNamestring nullable
emailstring email nullable
phonestring nullable

Phone number of the contact, with country code, without leading + (plus) sign

companyIdinteger nullable
companyNamestring nullable
groupIdsstring nullable

Contact group ids separated by commas

countryCodestring nullable

ISO Alpha-2 country code, see <a href="https://www.iban.com/country-codes">https://www.iban.com/country-codes</a>

statestring nullable
citystring nullable
townstring nullable
zipstring nullable
addressstring nullable
statusstring nullable
<p>Enum values:</p><ul><li><i>C = Customer</i></li><li><i>L = Lead</i></li><li><i>P = Prospect</i></li><li><i>O = Lost</i></li><li><i>R = Reseller</i></li><li><i>T = Partner</i></li><li><i>S = Supplier</i></li></ul>
departmentstring nullable
jobstring nullable
createdUserIdinteger
createdDatestring date-time
updatedUserIdinteger
updatedDatestring date-time nullable
colorstring nullable

Contact's background color, only used if there's no PhotoUrl

photoUrlstring nullable

Contact's photo URL

customFieldsstring nullable

A stringified JSON object mapping custom field names to values

Example: {"My Text Custom Field":"Field Value","My Numeric Custom Field":2}

blockedinteger nullable

Whether the contact is blocked. If true; emails, chats, calls etc. from this contact will be ignored.

visitorstring nullable

Contact's unique identifier for chat conversations

isEmailAllowedinteger nullable
isCallAllowedinteger nullable
isSmsAllowedinteger nullable
isWaMarketingAllowedinteger nullable

Read-only provider consent state; it is surfaced on the contact model for filtering but is deliberately excluded from contact editing.

waUserIdstring nullable

Allows identity lookup to continue when Meta no longer exposes the phone number.

waUsernamestring nullable

Provides a display fallback without replacing the contact's user-managed name.

lastSeenstring date-time nullable
lastContactedstring date-time nullable
lastHeardstring date-time nullable

Example request

{
  "firstName": "John",
  "lastName": "Doe",
  "fullName": "John Doe",
  "phone": "12124567890",
  "countryCode": "US",
  "department": "Product",
  "job": "Software Engineer",
  "color": "#4c65ff"
}

Response

Created

idinteger
departmentIdinteger
firstNamestring required
lastNamestring nullable
fullNamestring nullable
emailstring email nullable
phonestring nullable

Phone number of the contact, with country code, without leading + (plus) sign

companyIdinteger nullable
companyNamestring nullable
groupIdsstring nullable

Contact group ids separated by commas

countryCodestring nullable

ISO Alpha-2 country code, see <a href="https://www.iban.com/country-codes">https://www.iban.com/country-codes</a>

statestring nullable
citystring nullable
townstring nullable
zipstring nullable
addressstring nullable
statusstring nullable
<p>Enum values:</p><ul><li><i>C = Customer</i></li><li><i>L = Lead</i></li><li><i>P = Prospect</i></li><li><i>O = Lost</i></li><li><i>R = Reseller</i></li><li><i>T = Partner</i></li><li><i>S = Supplier</i></li></ul>
departmentstring nullable
jobstring nullable
createdUserIdinteger
createdDatestring date-time
updatedUserIdinteger
updatedDatestring date-time nullable
colorstring nullable

Contact's background color, only used if there's no PhotoUrl

photoUrlstring nullable

Contact's photo URL

customFieldsstring nullable

A stringified JSON object mapping custom field names to values

Example: {"My Text Custom Field":"Field Value","My Numeric Custom Field":2}

blockedinteger nullable

Whether the contact is blocked. If true; emails, chats, calls etc. from this contact will be ignored.

visitorstring nullable

Contact's unique identifier for chat conversations

isEmailAllowedinteger nullable
isCallAllowedinteger nullable
isSmsAllowedinteger nullable
isWaMarketingAllowedinteger nullable

Read-only provider consent state; it is surfaced on the contact model for filtering but is deliberately excluded from contact editing.

waUserIdstring nullable

Allows identity lookup to continue when Meta no longer exposes the phone number.

waUsernamestring nullable

Provides a display fallback without replacing the contact's user-managed name.

lastSeenstring date-time nullable
lastContactedstring date-time nullable
lastHeardstring date-time nullable

Example response

{
  "firstName": "John",
  "lastName": "Doe",
  "fullName": "John Doe",
  "phone": "12124567890",
  "countryCode": "US",
  "department": "Product",
  "job": "Software Engineer",
  "color": "#4c65ff"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.