Create Custom From Address

Create a Custom From Address

curl --request POST \
  --url https://test.onlinecheckwriter.com/api/v3/customFromAddresses \
  --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": "",
  "email": "example@domain.com",
  "note": "This is the billing address for Company A."
}
'

import requests

url = "https://test.onlinecheckwriter.com/api/v3/customFromAddresses"

payload = {
    "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."
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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.'
  })
};

fetch('https://test.onlinecheckwriter.com/api/v3/customFromAddresses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://test.onlinecheckwriter.com/api/v3/customFromAddresses",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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.'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://test.onlinecheckwriter.com/api/v3/customFromAddresses"

	payload := strings.NewReader("{\n  \"name\": \"John Doe\",\n  \"companyName\": \"Company A\",\n  \"addressLine1\": \"Address 1\",\n  \"addressLine2\": \"Address 2\",\n  \"city\": \"City\",\n  \"state\": \"ST\",\n  \"zip\": \"123456\",\n  \"phone\": \"\",\n  \"email\": \"example@domain.com\",\n  \"note\": \"This is the billing address for Company A.\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://test.onlinecheckwriter.com/api/v3/customFromAddresses")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"John Doe\",\n  \"companyName\": \"Company A\",\n  \"addressLine1\": \"Address 1\",\n  \"addressLine2\": \"Address 2\",\n  \"city\": \"City\",\n  \"state\": \"ST\",\n  \"zip\": \"123456\",\n  \"phone\": \"\",\n  \"email\": \"example@domain.com\",\n  \"note\": \"This is the billing address for Company A.\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://test.onlinecheckwriter.com/api/v3/customFromAddresses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"John Doe\",\n  \"companyName\": \"Company A\",\n  \"addressLine1\": \"Address 1\",\n  \"addressLine2\": \"Address 2\",\n  \"city\": \"City\",\n  \"state\": \"ST\",\n  \"zip\": \"123456\",\n  \"phone\": \"\",\n  \"email\": \"example@domain.com\",\n  \"note\": \"This is the billing address for Company A.\"\n}"

response = http.request(request)
puts response.read_body

{
  "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."
  }
}

POST

customFromAddresses

Create a Custom From Address

curl --request POST \
  --url https://test.onlinecheckwriter.com/api/v3/customFromAddresses \
  --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": "",
  "email": "example@domain.com",
  "note": "This is the billing address for Company A."
}
'

import requests

url = "https://test.onlinecheckwriter.com/api/v3/customFromAddresses"

payload = {
    "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."
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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.'
  })
};

fetch('https://test.onlinecheckwriter.com/api/v3/customFromAddresses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://test.onlinecheckwriter.com/api/v3/customFromAddresses",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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.'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://test.onlinecheckwriter.com/api/v3/customFromAddresses"

	payload := strings.NewReader("{\n  \"name\": \"John Doe\",\n  \"companyName\": \"Company A\",\n  \"addressLine1\": \"Address 1\",\n  \"addressLine2\": \"Address 2\",\n  \"city\": \"City\",\n  \"state\": \"ST\",\n  \"zip\": \"123456\",\n  \"phone\": \"\",\n  \"email\": \"example@domain.com\",\n  \"note\": \"This is the billing address for Company A.\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://test.onlinecheckwriter.com/api/v3/customFromAddresses")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"John Doe\",\n  \"companyName\": \"Company A\",\n  \"addressLine1\": \"Address 1\",\n  \"addressLine2\": \"Address 2\",\n  \"city\": \"City\",\n  \"state\": \"ST\",\n  \"zip\": \"123456\",\n  \"phone\": \"\",\n  \"email\": \"example@domain.com\",\n  \"note\": \"This is the billing address for Company A.\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://test.onlinecheckwriter.com/api/v3/customFromAddresses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"John Doe\",\n  \"companyName\": \"Company A\",\n  \"addressLine1\": \"Address 1\",\n  \"addressLine2\": \"Address 2\",\n  \"city\": \"City\",\n  \"state\": \"ST\",\n  \"zip\": \"123456\",\n  \"phone\": \"\",\n  \"email\": \"example@domain.com\",\n  \"note\": \"This is the billing address for Company A.\"\n}"

response = http.request(request)
puts response.read_body

{
  "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

header

required

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

Body

application/json

Payload to create a custom 'from' address.

name

string

required

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

Example:

"John Doe"

addressLine1

string

required

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

Example:

"Address 1"

addressLine2

string

required

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

Example:

"Address 2"

city

string

required

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

Example:

"City"

state

string

required

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

Example:

"ST"

zip

string

required

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

Example:

"123456"

companyName

string

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

Example:

"Company A"

phone

string | null

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

Example:

""

string | null

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

Example:

"example@domain.com"

note

string | null

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

Example:

"This is the billing address for Company A."

Response

Custom 'from' address created successfully.

success

boolean

Example:

true

data

object

Show child attributes

Get a Custom From address Get all Custom To Addresses

Get Started

Bank Account

Payee

Check

Mail Check

Authorizations

Body

Response