Hanzo
OpenapiCrm

Adds a person to the caller's org and answers 201 with the stored record.

Adds a person to the caller's org and answers 201 with the stored record.

POST /v1/crm/contacts

Addresshttps://api.hanzo.ai/v1/crm/contacts
MethodPOST
Operationpost_crm_contacts
AuthAuthorization: Bearer $HANZO_API_KEY

Adds a person to the caller's org and answers 201 with the stored record. One of firstName, lastName or email is required, and a companyId must name a company in the same org.

Request

10 fields, body application/json (required).

FieldInTypeRequiredDescription
citybodystringCity is where the person is based.
companyIdbodystringCompanyID links the contact to one of the org's companies.
emailbodystringEmail is the person's email address.
firstNamebodystringFirstName is the person's given name.
idbodystringID names the contact to update and comes from the path.
jobTitlebodystringJobTitle is the person's role at their company.
lastNamebodystringLastName is the person's family name.
linkedinLinkbodystringLinkedin is the person's LinkedIn URL.
phonebodystringPhone is the person's phone number.
xLinkbodystringXLink is the person's X (Twitter) URL.

Response

StatusBodyMeaning
201Contactcreated

201 body — 12 fields.

FieldInTypeAlwaysDescription
citybodystringCity is where the person is based.
companyIdbodystringCompanyID links the contact to one of the org's companies; empty when the contact stands alone, and cleared when its company is deleted.
createdAtbodyintegerCreatedAt is the unix second the contact was created.
emailbodystringEmail is the person's email address.
firstNamebodystringFirstName is the person's given name.
idbodystringID is the server-minted contact id ("cont_" + 128 random bits).
jobTitlebodystringJobTitle is the person's role at their company.
lastNamebodystringLastName is the person's family name.
linkedinLinkbodystringLinkedin is the person's LinkedIn URL.
phonebodystringPhone is the person's phone number.
updatedAtbodyintegerUpdatedAt is the unix second of the last write.
xLinkbodystringXLink is the person's X (Twitter) URL.

Failure carries the platform error shape — see Errors.

Examples

hanzo crm contacts create

CRM API · All Hanzo APIs · Interactive reference

How is this guide?

On this page