Create a new contact

post

https://api.maximizer.com/ferret/v1/contacts

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

🚧
Notice to Ferret API (v1) users
We’re excited to announce the beta release of Ferret API v2, offering a more consistent and expanded approach, with access to a wider range of objects.
New clients are encouraged to start with Ferret API v2 and/or Octopus API to take advantage of the latest updates. Existing clients are also encouraged to transition to v2, although Ferret API v1 will remain stable and fully operational. For those looking to migrate to the Octopus API, we’ve prepared a detailed migration guide.

Body Params

Command to create a contact

companyName

string | null

Parent company name

Automatically overriden when the LegacyCompanyKey is sent

legacyCompanyKey

string | null

Parent company key

Applicable only when the ContactType is 0 (Contact)

firstName

string | null

Contact's first name

middleName

string | null

Contact's middle name

lastName

string

required

length ≥ 1

Contact's last name

legacyPosition

string | null

Contact's position or title

website

string | null

Contact's website

legacyAccountManagerKey

string | null

Contact's account manager

contactType

int32

enum

required

0 = Contact, 1 = Lead

Allowed:

phones

array of objects | null

Contact's phones

Up to 4 phones when contact type is 0 (contact) or up to 2 phones when contact type is 1 (lead)

phones

emails

array of objects | null

Contact's emails

Up to 3 emails when contact type is 0 (contact) or up to 1 email when contact type is 1 (lead)

emails

addresses

array of objects | null

Contact's addresses

Up to 1 address

addresses

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Response

Notice to Ferret API (v1) users

200Success