v1

latestOpenAPI 3.0.02026-08-061380344.2 KB
Contacts

Create a Contact

Create a contact

Parameters

first_name OPTIONAL

The first name of the contact


"last_name** OPTIONAL

The last name of the contact


"type** OPTIONAL

An enum value representing the contact type. Supported options are:

'Auditor', 'Breeder', 'Buyer', 'Certifier', 'Contact', 'Consultant', 'Contractor', 'Customer', 'Donor', 'Employee', 'Purchaser', 'Supplier', 'Vendor', 'Veterinarian', 'Wholesale Customer'


"email** OPTIONAL

A properly formatted email address for the contact


"label** OPTIONAL

A string label or tag used to easily search for similar contact


"phone** OPTIONAL

Primary phone number


"cell** OPTIONAL

Mobile phone number


"fax** OPTIONAL

Fax phone number


"company** OPTIONAL

Name of the company that the contact works for


"description** OPTIONAL

A text description or summary of the contact


"address** OPTIONAL

Address information. Should be provided as follows, using the 2 character ISO country code:

"address": {
"country": "us",
"street": "PO Box 123",
"city": "Boulder",
"state": "CO",
"postal": "80301"
}


"tax_exempt** OPTIONAL

A Boolean (true/false) value indicating if orders for this customer should have sales tax calculated.

post/contacts

Headers

Content-Typestring

Request body

object required

Example request

{
  "type": "Contact",
  "first_name": "Bob",
  "last_name": "Surname",
  "email": "email@email.com",
  "label": "",
  "phone": "5558675309",
  "cell": null,
  "fax": null,
  "company": "",
  "description": "",
  "address": {
    "country": "us",
    "street": "PO Box 123",
    "city": "Boulder",
    "state": "CO",
    "postal": "80301"
  }
}

Response

Successful response