POST
/
customToAddresses
{
  "success": true,
  "data": {
    "id": "5EJy7VeBQGzn1m3",
    "name": "John Doe",
    "companyName": "Company A",
    "addressLine1": "Address 1",
    "addressLine2": "Address 2",
    "city": "City",
    "state": "ST",
    "zip": "123456",
    "phone": "1234567890",
    "email": "john.doe@example.com",
    "note": "Note."
  }
}

Authorizations

​
Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required

Name of the recipient.

Maximum length: 50
​
addressLine1
string
required

First line of the address.

Maximum length: 100
​
city
string
required

City of the address.

Maximum length: 100
​
state
string
required

State code (2-letter abbreviation).

Maximum length: 2
​
zip
string
required

Zip code of the address.

Maximum length: 15
​
companyName
string | null

Company name of the recipient.

Maximum length: 50
​
addressLine2
string | null

Second line of the address.

Maximum length: 100
​
phone
string | null

Phone number of the recipient.

Maximum length: 15
​
email
string | null

Email address of the recipient.

​
note
string | null

An internal note for the address.

Maximum length: 200

Response

201 - application/json
​
success
boolean
​
data
object
Get a Custom To address