Update a customer | Afternoon

import { AfternoonClient } from "afternoon-sdk";
async function main() {
    const client = new AfternoonClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.customers.update("cm5x9z8nv0000h85r7l9p2k1m", {});
}
main();

{
  "success": true,
  "customer": {
    "id": "cm5x9z8nv0000h85r7l9p2k1m",
    "name": "Acme Corp",
    "first_name": "Jane",
    "last_name": "Doe",
    "email": "jane@acme.com",
    "phone": "+14155551234",
    "url": "https://acme.com",
    "external_id": "cust_ext_123",
    "billing_address": {
      "country": "US",
      "state": "CA",
      "city": "San Francisco",
      "street": "123 Main St",
      "street2": "Suite 100",
      "zip": "94105"
    },
    "shipping_address": {
      "country": "US",
      "state": "CA",
      "city": "San Francisco",
      "street": "123 Main St",
      "street2": "Suite 100",
      "zip": "94105"
    },
    "created_at": "2024-01-15T10:30:00.000Z",
    "updated_at": "2024-01-15T10:30:00.000Z"
  },
  "request_id": "req_abc123"
}

Updates an existing customer. Only provided fields are changed.

Authentication

AuthorizationBearer

API key obtained from the Afternoon dashboard

Path parameters

idstringRequiredformat: "cuid"

Request

This endpoint expects an object.

namestringOptional<=255 characters

Business or display name

first_namestringOptional<=255 characters

Contact first name

last_namestringOptional<=255 characters

Contact last name

emailstringOptionalformat: "email"<=255 characters

Primary email address

phonestringOptional<=50 characters

Phone number

urlstringOptionalformat: "uri"<=2048 characters

Website URL

external_idstringOptional<=255 characters

Your internal identifier for this customer

billing_addressobjectOptional

Billing address

shipping_addressobjectOptional

Shipping address

Response

Customer updated

successboolean

customerobject

request_idstring

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error