Update Customer

curl --request PATCH \
  --url https://mapi.zbx.boomfi.xyz/v1/customers/{customerID} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "customer_ident": "<string>",
  "discord": "<string>",
  "email": "<string>",
  "name": "<string>",
  "number": "<string>",
  "twitter": "<string>",
  "wallet_address": "<string>"
}
'

import requests

url = "https://mapi.zbx.boomfi.xyz/v1/customers/{customerID}"

payload = {
    "customer_ident": "<string>",
    "discord": "<string>",
    "email": "<string>",
    "name": "<string>",
    "number": "<string>",
    "twitter": "<string>",
    "wallet_address": "<string>"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    customer_ident: '<string>',
    discord: '<string>',
    email: '<string>',
    name: '<string>',
    number: '<string>',
    twitter: '<string>',
    wallet_address: '<string>'
  })
};

fetch('https://mapi.zbx.boomfi.xyz/v1/customers/{customerID}', 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://mapi.zbx.boomfi.xyz/v1/customers/{customerID}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'customer_ident' => '<string>',
    'discord' => '<string>',
    'email' => '<string>',
    'name' => '<string>',
    'number' => '<string>',
    'twitter' => '<string>',
    'wallet_address' => '<string>'
  ]),
  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://mapi.zbx.boomfi.xyz/v1/customers/{customerID}"

	payload := strings.NewReader("{\n  \"customer_ident\": \"<string>\",\n  \"discord\": \"<string>\",\n  \"email\": \"<string>\",\n  \"name\": \"<string>\",\n  \"number\": \"<string>\",\n  \"twitter\": \"<string>\",\n  \"wallet_address\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://mapi.zbx.boomfi.xyz/v1/customers/{customerID}")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer_ident\": \"<string>\",\n  \"discord\": \"<string>\",\n  \"email\": \"<string>\",\n  \"name\": \"<string>\",\n  \"number\": \"<string>\",\n  \"twitter\": \"<string>\",\n  \"wallet_address\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://mapi.zbx.boomfi.xyz/v1/customers/{customerID}")

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

request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customer_ident\": \"<string>\",\n  \"discord\": \"<string>\",\n  \"email\": \"<string>\",\n  \"name\": \"<string>\",\n  \"number\": \"<string>\",\n  \"twitter\": \"<string>\",\n  \"wallet_address\": \"<string>\"\n}"

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

{
  "created_at": "<string>",
  "deleted_at": "<string>",
  "email": "<string>",
  "id": "<string>",
  "metadata": [
    123
  ],
  "name": "<string>",
  "org_id": "<string>",
  "phone": "<string>",
  "properties": [
    123
  ],
  "reference": "<string>",
  "updated_at": "<string>",
  "wallet_address": "<string>"
}

{
  "error": {
    "code": 400,
    "errors": [
      {
        "domain": "orders",
        "reason": "InsufficientQuantity"
      }
    ],
    "message": "Insufficient quantity"
  }
}

{
  "error": {
    "code": 400,
    "errors": [
      {
        "domain": "orders",
        "reason": "InsufficientQuantity"
      }
    ],
    "message": "Insufficient quantity"
  }
}

PATCH

customers

{customerID}

Update Customer

curl --request PATCH \
  --url https://mapi.zbx.boomfi.xyz/v1/customers/{customerID} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "customer_ident": "<string>",
  "discord": "<string>",
  "email": "<string>",
  "name": "<string>",
  "number": "<string>",
  "twitter": "<string>",
  "wallet_address": "<string>"
}
'

import requests

url = "https://mapi.zbx.boomfi.xyz/v1/customers/{customerID}"

payload = {
    "customer_ident": "<string>",
    "discord": "<string>",
    "email": "<string>",
    "name": "<string>",
    "number": "<string>",
    "twitter": "<string>",
    "wallet_address": "<string>"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    customer_ident: '<string>',
    discord: '<string>',
    email: '<string>',
    name: '<string>',
    number: '<string>',
    twitter: '<string>',
    wallet_address: '<string>'
  })
};

fetch('https://mapi.zbx.boomfi.xyz/v1/customers/{customerID}', 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://mapi.zbx.boomfi.xyz/v1/customers/{customerID}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'customer_ident' => '<string>',
    'discord' => '<string>',
    'email' => '<string>',
    'name' => '<string>',
    'number' => '<string>',
    'twitter' => '<string>',
    'wallet_address' => '<string>'
  ]),
  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://mapi.zbx.boomfi.xyz/v1/customers/{customerID}"

	payload := strings.NewReader("{\n  \"customer_ident\": \"<string>\",\n  \"discord\": \"<string>\",\n  \"email\": \"<string>\",\n  \"name\": \"<string>\",\n  \"number\": \"<string>\",\n  \"twitter\": \"<string>\",\n  \"wallet_address\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://mapi.zbx.boomfi.xyz/v1/customers/{customerID}")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer_ident\": \"<string>\",\n  \"discord\": \"<string>\",\n  \"email\": \"<string>\",\n  \"name\": \"<string>\",\n  \"number\": \"<string>\",\n  \"twitter\": \"<string>\",\n  \"wallet_address\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://mapi.zbx.boomfi.xyz/v1/customers/{customerID}")

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

request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customer_ident\": \"<string>\",\n  \"discord\": \"<string>\",\n  \"email\": \"<string>\",\n  \"name\": \"<string>\",\n  \"number\": \"<string>\",\n  \"twitter\": \"<string>\",\n  \"wallet_address\": \"<string>\"\n}"

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

{
  "created_at": "<string>",
  "deleted_at": "<string>",
  "email": "<string>",
  "id": "<string>",
  "metadata": [
    123
  ],
  "name": "<string>",
  "org_id": "<string>",
  "phone": "<string>",
  "properties": [
    123
  ],
  "reference": "<string>",
  "updated_at": "<string>",
  "wallet_address": "<string>"
}

{
  "error": {
    "code": 400,
    "errors": [
      {
        "domain": "orders",
        "reason": "InsufficientQuantity"
      }
    ],
    "message": "Insufficient quantity"
  }
}

{
  "error": {
    "code": 400,
    "errors": [
      {
        "domain": "orders",
        "reason": "InsufficientQuantity"
      }
    ],
    "message": "Insufficient quantity"
  }
}

Authorizations

X-API-KEY

string

header

required

Path Parameters

customerID

string

required

Unique customer identifier (cus_... or raw UUID)

Body

application/json

Request

customer_ident

string

Merchant-defined customer reference / external identifier.

discord

string

Discord username or handle (stored in customer properties).

string

Customer email address.

name

string

Customer display name.

number

string

Phone number (E.164 preferred).

twitter

string

Twitter / X handle (stored in customer properties).

wallet_address

string

Blockchain wallet address associated with the customer.

Response

created_at

string

When the resource was created (RFC3339).

deleted_at

string

When the resource was soft-deleted (RFC3339), if applicable.

string

Email address.

string

Unique resource identifier.

metadata

integer[]

Arbitrary merchant-defined metadata.

name

string

Display name.

org_id

string

Organisation ID that owns this resource.

phone

string

Phone number.

properties

integer[]

Additional properties as a key-value map.

reference

string

Merchant-defined reference string.

updated_at

string

When the resource was last updated (RFC3339).

wallet_address

string

Blockchain wallet address.

Basics

Paylinks

Plans

Subscriptions

Customers

Invoices

Payments

Events

Organisation

Secrets

Accounts

Bank Address Book

Virtual Accounts

Partners

Partner Automations

Partner Balance Monitoring

Instruments

Quotes

Orders

Trades

Update Customer

Authorizations

Path Parameters

Body

Response