Upsert customer

curl --request POST \
  --url https://platform.runonatlas.com/external/customers/upsert \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "externalId": "external-customer-id-123",
  "billingAddress1": "123 Main St",
  "billingAddress2": "Apt 1",
  "billingCity": "Anytown",
  "billingCountry": "US",
  "billingState": "CA",
  "billingZipCode": "12345",
  "shippingAddress1": "123 Main St",
  "shippingAddress2": "Apt 1",
  "shippingCity": "Anytown",
  "shippingCountry": "US",
  "shippingState": "CA",
  "shippingZipCode": "12345",
  "email": "john.doe@example.com",
  "name": "John Doe",
  "quickBooksId": "quickbooks-customer-id-123",
  "stripeId": "stripe-customer-id-123",
  "xeroId": "xero-customer-id-123"
}
'

import requests

url = "https://platform.runonatlas.com/external/customers/upsert"

payload = {
    "externalId": "external-customer-id-123",
    "billingAddress1": "123 Main St",
    "billingAddress2": "Apt 1",
    "billingCity": "Anytown",
    "billingCountry": "US",
    "billingState": "CA",
    "billingZipCode": "12345",
    "shippingAddress1": "123 Main St",
    "shippingAddress2": "Apt 1",
    "shippingCity": "Anytown",
    "shippingCountry": "US",
    "shippingState": "CA",
    "shippingZipCode": "12345",
    "email": "john.doe@example.com",
    "name": "John Doe",
    "quickBooksId": "quickbooks-customer-id-123",
    "stripeId": "stripe-customer-id-123",
    "xeroId": "xero-customer-id-123"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    externalId: 'external-customer-id-123',
    billingAddress1: '123 Main St',
    billingAddress2: 'Apt 1',
    billingCity: 'Anytown',
    billingCountry: 'US',
    billingState: 'CA',
    billingZipCode: '12345',
    shippingAddress1: '123 Main St',
    shippingAddress2: 'Apt 1',
    shippingCity: 'Anytown',
    shippingCountry: 'US',
    shippingState: 'CA',
    shippingZipCode: '12345',
    email: 'john.doe@example.com',
    name: 'John Doe',
    quickBooksId: 'quickbooks-customer-id-123',
    stripeId: 'stripe-customer-id-123',
    xeroId: 'xero-customer-id-123'
  })
};

fetch('https://platform.runonatlas.com/external/customers/upsert', 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://platform.runonatlas.com/external/customers/upsert",
  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([
    'externalId' => 'external-customer-id-123',
    'billingAddress1' => '123 Main St',
    'billingAddress2' => 'Apt 1',
    'billingCity' => 'Anytown',
    'billingCountry' => 'US',
    'billingState' => 'CA',
    'billingZipCode' => '12345',
    'shippingAddress1' => '123 Main St',
    'shippingAddress2' => 'Apt 1',
    'shippingCity' => 'Anytown',
    'shippingCountry' => 'US',
    'shippingState' => 'CA',
    'shippingZipCode' => '12345',
    'email' => 'john.doe@example.com',
    'name' => 'John Doe',
    'quickBooksId' => 'quickbooks-customer-id-123',
    'stripeId' => 'stripe-customer-id-123',
    'xeroId' => 'xero-customer-id-123'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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://platform.runonatlas.com/external/customers/upsert"

	payload := strings.NewReader("{\n  \"externalId\": \"external-customer-id-123\",\n  \"billingAddress1\": \"123 Main St\",\n  \"billingAddress2\": \"Apt 1\",\n  \"billingCity\": \"Anytown\",\n  \"billingCountry\": \"US\",\n  \"billingState\": \"CA\",\n  \"billingZipCode\": \"12345\",\n  \"shippingAddress1\": \"123 Main St\",\n  \"shippingAddress2\": \"Apt 1\",\n  \"shippingCity\": \"Anytown\",\n  \"shippingCountry\": \"US\",\n  \"shippingState\": \"CA\",\n  \"shippingZipCode\": \"12345\",\n  \"email\": \"john.doe@example.com\",\n  \"name\": \"John Doe\",\n  \"quickBooksId\": \"quickbooks-customer-id-123\",\n  \"stripeId\": \"stripe-customer-id-123\",\n  \"xeroId\": \"xero-customer-id-123\"\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	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://platform.runonatlas.com/external/customers/upsert")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"externalId\": \"external-customer-id-123\",\n  \"billingAddress1\": \"123 Main St\",\n  \"billingAddress2\": \"Apt 1\",\n  \"billingCity\": \"Anytown\",\n  \"billingCountry\": \"US\",\n  \"billingState\": \"CA\",\n  \"billingZipCode\": \"12345\",\n  \"shippingAddress1\": \"123 Main St\",\n  \"shippingAddress2\": \"Apt 1\",\n  \"shippingCity\": \"Anytown\",\n  \"shippingCountry\": \"US\",\n  \"shippingState\": \"CA\",\n  \"shippingZipCode\": \"12345\",\n  \"email\": \"john.doe@example.com\",\n  \"name\": \"John Doe\",\n  \"quickBooksId\": \"quickbooks-customer-id-123\",\n  \"stripeId\": \"stripe-customer-id-123\",\n  \"xeroId\": \"xero-customer-id-123\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.runonatlas.com/external/customers/upsert")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"externalId\": \"external-customer-id-123\",\n  \"billingAddress1\": \"123 Main St\",\n  \"billingAddress2\": \"Apt 1\",\n  \"billingCity\": \"Anytown\",\n  \"billingCountry\": \"US\",\n  \"billingState\": \"CA\",\n  \"billingZipCode\": \"12345\",\n  \"shippingAddress1\": \"123 Main St\",\n  \"shippingAddress2\": \"Apt 1\",\n  \"shippingCity\": \"Anytown\",\n  \"shippingCountry\": \"US\",\n  \"shippingState\": \"CA\",\n  \"shippingZipCode\": \"12345\",\n  \"email\": \"john.doe@example.com\",\n  \"name\": \"John Doe\",\n  \"quickBooksId\": \"quickbooks-customer-id-123\",\n  \"stripeId\": \"stripe-customer-id-123\",\n  \"xeroId\": \"xero-customer-id-123\"\n}"

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

{
  "createdAt": "2021-01-01T00:00:00.000Z",
  "id": "atlas-internal-customer-id-123",
  "updatedAt": "2021-01-01T00:00:00.000Z",
  "merchantId": "atlas-internal-merchant-id-123",
  "billingAddress1": "123 Main St",
  "billingAddress2": "Apt 1",
  "billingCity": "Anytown",
  "billingCountry": "US",
  "billingState": "CA",
  "billingZipCode": "12345",
  "shippingAddress1": "123 Main St",
  "shippingAddress2": "Apt 1",
  "shippingCity": "Anytown",
  "shippingCountry": "US",
  "shippingState": "CA",
  "shippingZipCode": "12345",
  "email": "john.doe@example.com",
  "externalId": "external-customer-id-123",
  "name": "John Doe",
  "quickBooksId": "quickbooks-customer-id-123",
  "stripeId": "stripe-customer-id-123"
}

POST

external

customers

upsert

Upsert customer

curl --request POST \
  --url https://platform.runonatlas.com/external/customers/upsert \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "externalId": "external-customer-id-123",
  "billingAddress1": "123 Main St",
  "billingAddress2": "Apt 1",
  "billingCity": "Anytown",
  "billingCountry": "US",
  "billingState": "CA",
  "billingZipCode": "12345",
  "shippingAddress1": "123 Main St",
  "shippingAddress2": "Apt 1",
  "shippingCity": "Anytown",
  "shippingCountry": "US",
  "shippingState": "CA",
  "shippingZipCode": "12345",
  "email": "john.doe@example.com",
  "name": "John Doe",
  "quickBooksId": "quickbooks-customer-id-123",
  "stripeId": "stripe-customer-id-123",
  "xeroId": "xero-customer-id-123"
}
'

import requests

url = "https://platform.runonatlas.com/external/customers/upsert"

payload = {
    "externalId": "external-customer-id-123",
    "billingAddress1": "123 Main St",
    "billingAddress2": "Apt 1",
    "billingCity": "Anytown",
    "billingCountry": "US",
    "billingState": "CA",
    "billingZipCode": "12345",
    "shippingAddress1": "123 Main St",
    "shippingAddress2": "Apt 1",
    "shippingCity": "Anytown",
    "shippingCountry": "US",
    "shippingState": "CA",
    "shippingZipCode": "12345",
    "email": "john.doe@example.com",
    "name": "John Doe",
    "quickBooksId": "quickbooks-customer-id-123",
    "stripeId": "stripe-customer-id-123",
    "xeroId": "xero-customer-id-123"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    externalId: 'external-customer-id-123',
    billingAddress1: '123 Main St',
    billingAddress2: 'Apt 1',
    billingCity: 'Anytown',
    billingCountry: 'US',
    billingState: 'CA',
    billingZipCode: '12345',
    shippingAddress1: '123 Main St',
    shippingAddress2: 'Apt 1',
    shippingCity: 'Anytown',
    shippingCountry: 'US',
    shippingState: 'CA',
    shippingZipCode: '12345',
    email: 'john.doe@example.com',
    name: 'John Doe',
    quickBooksId: 'quickbooks-customer-id-123',
    stripeId: 'stripe-customer-id-123',
    xeroId: 'xero-customer-id-123'
  })
};

fetch('https://platform.runonatlas.com/external/customers/upsert', 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://platform.runonatlas.com/external/customers/upsert",
  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([
    'externalId' => 'external-customer-id-123',
    'billingAddress1' => '123 Main St',
    'billingAddress2' => 'Apt 1',
    'billingCity' => 'Anytown',
    'billingCountry' => 'US',
    'billingState' => 'CA',
    'billingZipCode' => '12345',
    'shippingAddress1' => '123 Main St',
    'shippingAddress2' => 'Apt 1',
    'shippingCity' => 'Anytown',
    'shippingCountry' => 'US',
    'shippingState' => 'CA',
    'shippingZipCode' => '12345',
    'email' => 'john.doe@example.com',
    'name' => 'John Doe',
    'quickBooksId' => 'quickbooks-customer-id-123',
    'stripeId' => 'stripe-customer-id-123',
    'xeroId' => 'xero-customer-id-123'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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://platform.runonatlas.com/external/customers/upsert"

	payload := strings.NewReader("{\n  \"externalId\": \"external-customer-id-123\",\n  \"billingAddress1\": \"123 Main St\",\n  \"billingAddress2\": \"Apt 1\",\n  \"billingCity\": \"Anytown\",\n  \"billingCountry\": \"US\",\n  \"billingState\": \"CA\",\n  \"billingZipCode\": \"12345\",\n  \"shippingAddress1\": \"123 Main St\",\n  \"shippingAddress2\": \"Apt 1\",\n  \"shippingCity\": \"Anytown\",\n  \"shippingCountry\": \"US\",\n  \"shippingState\": \"CA\",\n  \"shippingZipCode\": \"12345\",\n  \"email\": \"john.doe@example.com\",\n  \"name\": \"John Doe\",\n  \"quickBooksId\": \"quickbooks-customer-id-123\",\n  \"stripeId\": \"stripe-customer-id-123\",\n  \"xeroId\": \"xero-customer-id-123\"\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	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://platform.runonatlas.com/external/customers/upsert")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"externalId\": \"external-customer-id-123\",\n  \"billingAddress1\": \"123 Main St\",\n  \"billingAddress2\": \"Apt 1\",\n  \"billingCity\": \"Anytown\",\n  \"billingCountry\": \"US\",\n  \"billingState\": \"CA\",\n  \"billingZipCode\": \"12345\",\n  \"shippingAddress1\": \"123 Main St\",\n  \"shippingAddress2\": \"Apt 1\",\n  \"shippingCity\": \"Anytown\",\n  \"shippingCountry\": \"US\",\n  \"shippingState\": \"CA\",\n  \"shippingZipCode\": \"12345\",\n  \"email\": \"john.doe@example.com\",\n  \"name\": \"John Doe\",\n  \"quickBooksId\": \"quickbooks-customer-id-123\",\n  \"stripeId\": \"stripe-customer-id-123\",\n  \"xeroId\": \"xero-customer-id-123\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.runonatlas.com/external/customers/upsert")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"externalId\": \"external-customer-id-123\",\n  \"billingAddress1\": \"123 Main St\",\n  \"billingAddress2\": \"Apt 1\",\n  \"billingCity\": \"Anytown\",\n  \"billingCountry\": \"US\",\n  \"billingState\": \"CA\",\n  \"billingZipCode\": \"12345\",\n  \"shippingAddress1\": \"123 Main St\",\n  \"shippingAddress2\": \"Apt 1\",\n  \"shippingCity\": \"Anytown\",\n  \"shippingCountry\": \"US\",\n  \"shippingState\": \"CA\",\n  \"shippingZipCode\": \"12345\",\n  \"email\": \"john.doe@example.com\",\n  \"name\": \"John Doe\",\n  \"quickBooksId\": \"quickbooks-customer-id-123\",\n  \"stripeId\": \"stripe-customer-id-123\",\n  \"xeroId\": \"xero-customer-id-123\"\n}"

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

{
  "createdAt": "2021-01-01T00:00:00.000Z",
  "id": "atlas-internal-customer-id-123",
  "updatedAt": "2021-01-01T00:00:00.000Z",
  "merchantId": "atlas-internal-merchant-id-123",
  "billingAddress1": "123 Main St",
  "billingAddress2": "Apt 1",
  "billingCity": "Anytown",
  "billingCountry": "US",
  "billingState": "CA",
  "billingZipCode": "12345",
  "shippingAddress1": "123 Main St",
  "shippingAddress2": "Apt 1",
  "shippingCity": "Anytown",
  "shippingCountry": "US",
  "shippingState": "CA",
  "shippingZipCode": "12345",
  "email": "john.doe@example.com",
  "externalId": "external-customer-id-123",
  "name": "John Doe",
  "quickBooksId": "quickbooks-customer-id-123",
  "stripeId": "stripe-customer-id-123"
}

Authorizations

x-api-key

string

header

required

You can obtain this key from the Atlas dashboard. It must be of type secret

Body

application/json

externalId

string

required

The external ID of the customer (e.g. the customer ID in your system)

Minimum string length: 1

Example:

"external-customer-id-123"

billingAddress1

string | null

Billing address line 1

Minimum string length: 1

Example:

"123 Main St"

billingAddress2

string | null

Billing address line 2

Minimum string length: 1

Example:

"Apt 1"

billingCity

string | null

Billing city

Minimum string length: 1

Example:

"Anytown"

billingCountry

string | null

Billing country

Minimum string length: 1

Example:

"US"

billingState

string | null

Billing state

Minimum string length: 1

Example:

"CA"

billingZipCode

string | null

Billing zip code. Must be 5 digits or 5+4 format.

Pattern: ^\d{5}(-\d{4})?$

Example:

"12345"

shippingAddress1

string | null

Shipping address line 1

Minimum string length: 1

Example:

"123 Main St"

shippingAddress2

string | null

Shipping address line 2

Minimum string length: 1

Example:

"Apt 1"

shippingCity

string | null

Shipping city

Minimum string length: 1

Example:

"Anytown"

shippingCountry

string | null

Shipping country

Minimum string length: 1

Example:

"US"

shippingState

string | null

Shipping state

Minimum string length: 1

Example:

"CA"

shippingZipCode

string | null

Shipping zip code. Must be 5 digits or 5+4 format.

Pattern: ^\d{5}(-\d{4})?$

Example:

"12345"

string<email> | null

The email of the customer

Minimum string length: 1

Example:

"john.doe@example.com"

name

string | null

The name of the customer

Minimum string length: 1

Example:

"John Doe"

quickBooksId

string | null

The QuickBooks ID of the customer

Minimum string length: 1

Example:

"quickbooks-customer-id-123"

stripeId

string | null

The Stripe ID of the customer

Minimum string length: 1

Example:

"stripe-customer-id-123"

xeroId

string | null

The Xero ID of the customer

Minimum string length: 1

Example:

"xero-customer-id-123"

Response

The customer that has been upserted.

createdAt

string<date>

required

The date and time the customer was created

Example:

"2021-01-01T00:00:00.000Z"

string

required

The Atlas customer ID

Minimum string length: 1

Example:

"atlas-internal-customer-id-123"

updatedAt

string<date>

required

The date and time the customer was last updated

Example:

"2021-01-01T00:00:00.000Z"

merchantId

string

required

The Atlas merchant ID

Minimum string length: 1

Example:

"atlas-internal-merchant-id-123"

billingAddress1

string | null

Billing address line 1

Minimum string length: 1

Example:

"123 Main St"

billingAddress2

string | null

Billing address line 2

Minimum string length: 1

Example:

"Apt 1"

billingCity

string | null

Billing city

Minimum string length: 1

Example:

"Anytown"

billingCountry

string | null

Billing country

Minimum string length: 1

Example:

"US"

billingState

string | null

Billing state

Minimum string length: 1

Example:

"CA"

billingZipCode

string | null

Billing zip code. Must be 5 digits or 5+4 format.

Pattern: ^\d{5}(-\d{4})?$

Example:

"12345"

shippingAddress1

string | null

Shipping address line 1

Minimum string length: 1

Example:

"123 Main St"

shippingAddress2

string | null

Shipping address line 2

Minimum string length: 1

Example:

"Apt 1"

shippingCity

string | null

Shipping city

Minimum string length: 1

Example:

"Anytown"

shippingCountry

string | null

Shipping country

Minimum string length: 1

Example:

"US"

shippingState

string | null

Shipping state

Minimum string length: 1

Example:

"CA"

shippingZipCode

string | null

Shipping zip code. Must be 5 digits or 5+4 format.

Pattern: ^\d{5}(-\d{4})?$

Example:

"12345"

string<email> | null

The email of the customer

Minimum string length: 1

Example:

"john.doe@example.com"

externalId

string | null

The external ID of the customer (e.g. the customer ID in your system)

Minimum string length: 1

Example:

"external-customer-id-123"

name

string | null

The name of the customer

Minimum string length: 1

Example:

"John Doe"

quickBooksId

string | null

The QuickBooks ID of the customer

Minimum string length: 1

Example:

"quickbooks-customer-id-123"

stripeId

string | null

The Stripe ID of the customer

Minimum string length: 1

Example:

"stripe-customer-id-123"

Create Stripe setup checkout session for payment method update Bulk upsert customers

Events

Customers

Invoices

Subscriptions

Upsert customer

Authorizations

Body

Response