Upsert Customer

POST

customer

upsert

Upsert Customer

curl --request POST \
  --url https://zeus-api.atlas.so/v1/customer/upsert \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "isVisitor": false,
  "userId": "<string>",
  "location": "<string>",
  "ip": "<string>",
  "customFields": {},
  "phoneNumber": "<string>",
  "fields": {},
  "account": {
    "id": "<string>",
    "name": "<string>",
    "email": "<string>",
    "website": "<string>",
    "customFields": {}
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "visitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://zeus-api.atlas.so/v1/customer/upsert"

payload = {
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "isVisitor": False,
    "userId": "<string>",
    "location": "<string>",
    "ip": "<string>",
    "customFields": {},
    "phoneNumber": "<string>",
    "fields": {},
    "account": {
        "id": "<string>",
        "name": "<string>",
        "email": "<string>",
        "website": "<string>",
        "customFields": {}
    },
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "visitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
    email: '<string>',
    firstName: '<string>',
    lastName: '<string>',
    isVisitor: false,
    userId: '<string>',
    location: '<string>',
    ip: '<string>',
    customFields: {},
    phoneNumber: '<string>',
    fields: {},
    account: {
      id: '<string>',
      name: '<string>',
      email: '<string>',
      website: '<string>',
      customFields: {}
    },
    id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    visitorId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://zeus-api.atlas.so/v1/customer/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://zeus-api.atlas.so/v1/customer/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([
    'email' => '<string>',
    'firstName' => '<string>',
    'lastName' => '<string>',
    'isVisitor' => false,
    'userId' => '<string>',
    'location' => '<string>',
    'ip' => '<string>',
    'customFields' => [
        
    ],
    'phoneNumber' => '<string>',
    'fields' => [
        
    ],
    'account' => [
        'id' => '<string>',
        'name' => '<string>',
        'email' => '<string>',
        'website' => '<string>',
        'customFields' => [
                
        ]
    ],
    'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'visitorId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  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://zeus-api.atlas.so/v1/customer/upsert"

	payload := strings.NewReader("{\n  \"email\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"isVisitor\": false,\n  \"userId\": \"<string>\",\n  \"location\": \"<string>\",\n  \"ip\": \"<string>\",\n  \"customFields\": {},\n  \"phoneNumber\": \"<string>\",\n  \"fields\": {},\n  \"account\": {\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"email\": \"<string>\",\n    \"website\": \"<string>\",\n    \"customFields\": {}\n  },\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"visitorId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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://zeus-api.atlas.so/v1/customer/upsert")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"isVisitor\": false,\n  \"userId\": \"<string>\",\n  \"location\": \"<string>\",\n  \"ip\": \"<string>\",\n  \"customFields\": {},\n  \"phoneNumber\": \"<string>\",\n  \"fields\": {},\n  \"account\": {\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"email\": \"<string>\",\n    \"website\": \"<string>\",\n    \"customFields\": {}\n  },\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"visitorId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://zeus-api.atlas.so/v1/customer/upsert")

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  \"email\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"isVisitor\": false,\n  \"userId\": \"<string>\",\n  \"location\": \"<string>\",\n  \"ip\": \"<string>\",\n  \"customFields\": {},\n  \"phoneNumber\": \"<string>\",\n  \"fields\": {},\n  \"account\": {\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"email\": \"<string>\",\n    \"website\": \"<string>\",\n    \"customFields\": {}\n  },\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"visitorId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "isVisitor": false,
  "userId": "<string>",
  "location": "<string>",
  "ip": "<string>",
  "customFields": {},
  "phoneNumber": "<string>",
  "fields": {},
  "account": {
    "id": "<string>",
    "name": "<string>",
    "email": "<string>",
    "website": "<string>",
    "customFields": {}
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "visitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Body

application/json

string | null

firstName

string | null

lastName

string | null

isVisitor

boolean | null

default:false

If is a visitor, this is set to true in the response

userId

string | null

Identifier for the customer in your system

location

string | null

customFields

Customfields · object | null

phoneNumber

string | null

fields

Fields · object | null

account

ChatbotAccount · object | null

Show child attributes

string<uuid> | null

visitorId

string<uuid> | null

If the customer was a visitor previously, set this to the visitor's id to link the visitor to this customer

Response

Customer · object | null

Successful Response

string | null

firstName

string | null

lastName

string | null

isVisitor

boolean | null

default:false

If is a visitor, this is set to true in the response

userId

string | null

Identifier for the customer in your system

location

string | null

customFields

Customfields · object | null

phoneNumber

string | null

fields

Fields · object | null

account

ChatbotAccount · object | null

Show child attributes

string<uuid> | null

visitorId

string<uuid> | null

If the customer was a visitor previously, set this to the visitor's id to link the visitor to this customer

Upsert Customer

curl --request POST \
  --url https://zeus-api.atlas.so/v1/customer/upsert \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "isVisitor": false,
  "userId": "<string>",
  "location": "<string>",
  "ip": "<string>",
  "customFields": {},
  "phoneNumber": "<string>",
  "fields": {},
  "account": {
    "id": "<string>",
    "name": "<string>",
    "email": "<string>",
    "website": "<string>",
    "customFields": {}
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "visitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://zeus-api.atlas.so/v1/customer/upsert"

payload = {
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "isVisitor": False,
    "userId": "<string>",
    "location": "<string>",
    "ip": "<string>",
    "customFields": {},
    "phoneNumber": "<string>",
    "fields": {},
    "account": {
        "id": "<string>",
        "name": "<string>",
        "email": "<string>",
        "website": "<string>",
        "customFields": {}
    },
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "visitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
    email: '<string>',
    firstName: '<string>',
    lastName: '<string>',
    isVisitor: false,
    userId: '<string>',
    location: '<string>',
    ip: '<string>',
    customFields: {},
    phoneNumber: '<string>',
    fields: {},
    account: {
      id: '<string>',
      name: '<string>',
      email: '<string>',
      website: '<string>',
      customFields: {}
    },
    id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    visitorId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://zeus-api.atlas.so/v1/customer/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://zeus-api.atlas.so/v1/customer/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([
    'email' => '<string>',
    'firstName' => '<string>',
    'lastName' => '<string>',
    'isVisitor' => false,
    'userId' => '<string>',
    'location' => '<string>',
    'ip' => '<string>',
    'customFields' => [
        
    ],
    'phoneNumber' => '<string>',
    'fields' => [
        
    ],
    'account' => [
        'id' => '<string>',
        'name' => '<string>',
        'email' => '<string>',
        'website' => '<string>',
        'customFields' => [
                
        ]
    ],
    'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'visitorId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  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://zeus-api.atlas.so/v1/customer/upsert"

	payload := strings.NewReader("{\n  \"email\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"isVisitor\": false,\n  \"userId\": \"<string>\",\n  \"location\": \"<string>\",\n  \"ip\": \"<string>\",\n  \"customFields\": {},\n  \"phoneNumber\": \"<string>\",\n  \"fields\": {},\n  \"account\": {\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"email\": \"<string>\",\n    \"website\": \"<string>\",\n    \"customFields\": {}\n  },\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"visitorId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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://zeus-api.atlas.so/v1/customer/upsert")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"isVisitor\": false,\n  \"userId\": \"<string>\",\n  \"location\": \"<string>\",\n  \"ip\": \"<string>\",\n  \"customFields\": {},\n  \"phoneNumber\": \"<string>\",\n  \"fields\": {},\n  \"account\": {\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"email\": \"<string>\",\n    \"website\": \"<string>\",\n    \"customFields\": {}\n  },\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"visitorId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://zeus-api.atlas.so/v1/customer/upsert")

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  \"email\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"isVisitor\": false,\n  \"userId\": \"<string>\",\n  \"location\": \"<string>\",\n  \"ip\": \"<string>\",\n  \"customFields\": {},\n  \"phoneNumber\": \"<string>\",\n  \"fields\": {},\n  \"account\": {\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"email\": \"<string>\",\n    \"website\": \"<string>\",\n    \"customFields\": {}\n  },\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"visitorId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "isVisitor": false,
  "userId": "<string>",
  "location": "<string>",
  "ip": "<string>",
  "customFields": {},
  "phoneNumber": "<string>",
  "fields": {},
  "account": {
    "id": "<string>",
    "name": "<string>",
    "email": "<string>",
    "website": "<string>",
    "customFields": {}
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "visitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Overview

Guides

API Reference

Upsert Customer

Authorizations

Body

Response