Dispatch

Create a customer

POST/v1/dispatch/customers

Creates a customer. Returns 409 customer_exists if the external_id is taken.

Parameters

Body parameters3

external_idstringRequired

Your own ID for the customer.

name?string

Up to 120 characters.

metadata?object

Your own key-value data.

Returns

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

POSTCreate a customer

curl -X POST "https://api.getensue.com/v1/dispatch/customers" \
  -H "authorization: Bearer $ENSUE_API_KEY" \
  -H "content-type: application/json" \
  -d '{"external_id":"acme","name":"Acme Inc"}'

const res = await fetch("https://api.getensue.com/v1/dispatch/customers", {
  method: "POST",
  headers: {
    authorization: `Bearer ${process.env.ENSUE_API_KEY}`,
    "content-type": "application/json",
  },
  body: JSON.stringify({
    "external_id": "acme",
    "name": "Acme Inc"
  }),
});
console.log(await res.json());

import os, requests

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

201Response

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