API Reference
  1. Customer Portal
  2. Contacts

Create a contact

post
https://{hostname}/api/v1/contact

Creates a contact, optionally attaching it to a business. If a contact
with the same externalId (or email) already exists, it is updated
instead of creating a duplicate.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The writable fields of a contact.

string
required

The contact's email address. Used to match an existing contact when no externalId is given.

string

The contact's identifier in your system. Preferred over email for matching an existing contact.

string

The contact's first name.

string

The contact's last name.

string

A contact phone number.

business
object

The business to attach this contact to.

string
enum

The contact's role on the business. Ingestion may only set Admin or Member.

Allowed:
Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?