Skip to main content
POST
/
customToAddresses
Create a Custom To Address
curl --request POST \
  --url https://test.onlinecheckwriter.com/api/v3/customToAddresses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "John Doe",
  "companyName": "Company A",
  "addressLine1": "Address 1",
  "addressLine2": "Address 2",
  "city": "City",
  "state": "ST",
  "zip": "123456",
  "phone": "1234567890",
  "email": "[email protected]",
  "note": "Note."
}
'
{
  "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": "[email protected]",
    "note": "Note."
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Payload to create a new custom 'to' address.

​
name
string
required

Name of the recipient.

Maximum string length: 50
Example:

"John Doe"

​
addressLine1
string
required

First line of the address.

Maximum string length: 100
Example:

"Address 1"

​
city
string
required

City of the address.

Maximum string length: 100
Example:

"City"

​
state
string
required

State code (2-letter abbreviation).

Maximum string length: 2
Example:

"ST"

​
zip
string
required

Zip code of the address.

Maximum string length: 15
Example:

"123345"

​
companyName
string | null

Company name of the recipient.

Maximum string length: 50
Example:

"Company A"

​
addressLine2
string | null

Second line of the address.

Maximum string length: 100
Example:

"Address 2"

​
phone
string | null

Phone number of the recipient.

Maximum string length: 15
Example:

"1234567890"

​
email
string | null

Email address of the recipient.

Example:

"[email protected]"

​
note
string | null

An internal note for the address.

Maximum string length: 200
Example:

"Note."

Response

Custom 'to' address created successfully.

​
success
boolean
Example:

true

​
data
object