Create or Update Contact

post

https://api.getpinch.com.au/test/contacts

Creates a new contact or updates an existing one. If an id is provided in the request body, the contact will be updated; otherwise a new contact will be created.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

string

If provided, updates existing contact

isPrimaryContact

boolean

Whether this is the primary contact

firstName

string

First name

lastName

string

Last name

string

Email address

phone

string

Phone number

streetAddress

string

Street address

suburb

string

Suburb

postcode

string

Postcode

state

string

State

country

string

Country

dob

date

Date of birth in yyyy-MM-dd format

governmentNumber

string

deprecated

Use passportNumber or driversLicenseNumber instead

passportNumber

string

Passport number

passportCountryCode

string

Passport country code

driversLicenseNumber

string

Driver's license number

driversLicenseState

string

Driver's license state

driversLicenseCountryCode

string

Driver's license country code

driversLicenseCardNumber

string

Driver's license card number

driversLicenseExpiryDate

date

Driver's license expiry date

contactType

string

enum

required

The type of contact. Owner = a major shareholder and director; Director = any director; Shareholder = any shareholder; Executive = Any decision maker.

Allowed:

ownership

double | null

Ownership percentage

jobTitle

string

Job title

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400