Add a new contact

post

https://ship.cars/api/shipperlite/posting/v3/contacts

This method adds a new contact to the contact book of the current user

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

string

Internal ID of the contact.

companyName

string

^{0}|(?=.*\S)[\p{L}\p{M}\p{N}\p{P}\p{S}\p{Z} ]{1,100}$

Formal name of the company.

string

length between 0 and 254

Email address.

name

string

required

^{0}|(?=.*\S)[\p{L}\p{M}\p{N}\p{P}\p{S}\p{Z} ]{1,100}$

Name(s) of the person.

primaryPhone

string

required

^{0}|(\+?1[ -]?)?$?\d{3}$?[ -]?\d{3}[ -]?\d{4}$

Required primary phone used for contacting.

primaryPhoneNotes

string

length between 0 and 200

Notes related to the primary phone, if applicable.

secondaryPhone

string

^{0}|(\+?1[ -]?)?$?\d{3}$?[ -]?\d{3}[ -]?\d{4}$

Secondary phone used for contacting, if applicable.

secondaryPhoneNotes

string

length between 0 and 200

Notes related to the secondary phone, if applicable.

thirdPhone

string

^{0}|(\+?1[ -]?)?$?\d{3}$?[ -]?\d{3}[ -]?\d{4}$

Third phone used for contacting, if applicable.

thirdPhoneNotes

string

length between 0 and 200

Notes related to the third phone, if applicable.

workingHours

string

length between 0 and 200

Official working hours of the company/entity

location

object

Required location information.

type

string

enum

Contact type

Allowed:

notes

string

length between 0 and 200

Contact notes, if applicable.

Responses

Language

Credentials

OAuth2

Loading…

Response

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

application/json

201Created

400Bad Request