POST
/
customFromAddresses
{
  "success": true,
  "data": {
    "id": "5EJy7VeBQGzn1m3",
    "name": "John Doe",
    "companyName": "Company A",
    "addressLine1": "Address 1",
    "addressLine2": "Address 2",
    "city": "City",
    "state": "ST",
    "zip": "123456",
    "phone": "",
    "email": "example@domain.com",
    "note": "This is the billing address for Company A."
  }
}

Authorizations

​
Authorization
string
headerrequired

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

Body

application/json
​
name
string
required

The name associated with the address. Must be no longer than 50 characters.

​
addressLine1
string
required

The first line of the address. Must be no longer than 100 characters.

​
addressLine2
string
required

The second line of the address. Optional and must be no longer than 100 characters.

​
city
string
required

The city of the address. Must be no longer than 100 characters.

​
state
string
required

The state of the address. Must be a 2-letter state short-name code.

​
zip
string
required

The postal code of the address. Must be no longer than 15 characters.

​
companyName
string

The company name associated with the address. Optional and must be no longer than 50 characters.

​
phone
string | null

The phone number associated with the address. Optional and must be no longer than 15 characters.

​
email
string | null

The email address associated with the address. Optional and must be no longer than 100 characters.

​
note
string | null

An internal note that identifies this address. Optional and must be no longer than 200 characters.

Response

201 - application/json
​
success
boolean
​
data
object
Get a Custom From addressGet all Custom To Addresses