Dispatch

Upsert a customer

PUT/v1/dispatch/customers/:ref

Creates the customer, or updates it if it exists. Safe to call every time; fields you leave out keep their value.

Parameters

Path parameters1

refstringRequired

The customer's external_id or its cst_ ID.

Body parameters2

name?string

Up to 120 characters.

metadata?object

Your own key-value data.

Returns

200The sample response is on the right.Errors return error and message; see Errors and limits.

PUTUpsert a customer

curl -X PUT "https://api.getensue.com/v1/dispatch/customers/acme" \
  -H "authorization: Bearer $ENSUE_API_KEY"

const res = await fetch("https://api.getensue.com/v1/dispatch/customers/acme", {
  method: "PUT",
  headers: {
    authorization: `Bearer ${process.env.ENSUE_API_KEY}`,
  },
});
console.log(await res.json());

import os, requests

res = requests.put(
    "https://api.getensue.com/v1/dispatch/customers/acme",
    headers={"authorization": f"Bearer {os.environ['ENSUE_API_KEY']}"},
)
print(res.json())

200Response

{
  "id": "cst_4h6w…",
  "external_id": "acme",
  "name": "Acme Inc",
  "metadata": {},
  "created": 1762761600000,
  "updated": 1762761600000
}

{"id":"cst_4h6w…","external_id":"acme","name":"Acme Inc","metadata":{},"created":1762761600000,"updated":1762761600000}