customers reference

This reference follows the current server implementation. Use the SDK for customer flows; it manages identity proof and retries. Authentication and errors apply to every endpoint. Types below describe JSON: dates are ISO strings, ? means optional, and null differs from an omitted field. Responses may include additional fields. Schemas also enforce constraints that TypeScript cannot express; download the request JSON Schemas. Named response types are defined in the data model reference.

POST /v1/customers/:customerId/attributes

Authentication: Public or secret app API key; customer/session proof is still required wherever the operation acts on an identity.

Path parameters: customerId (string). Every target must belong to the authenticated app or workspace.

Request

Send JSON with Content-Type: application/json. Where multiple shapes are shown, the handler selects the applicable operation or validates nested input.

{ attributes: Record<string, string | null>;
  }

Validation schemas: setCustomerAttributesSchema in the downloadable schema registry.

Response

JSON response shape

{ error: string;
  message: string;
  }

JSON response shape

{ ok: true;
  }

Errors: validation/authentication failures use the common error envelope. A missing or inaccessible target returns an error; never interpret it as an empty successful result.

Implementation · Handler: handleSetCustomerAttributes.

GET /v1/customers/:customerId/attributes

Authentication: Public or secret app API key; customer/session proof is still required wherever the operation acts on an identity.

Path parameters: customerId (string). Every target must belong to the authenticated app or workspace.

Request

Use the path parameters above and any query options described below.

Handler inputs: path.customerId. Authentication values belong in headers; route IDs belong in the path.

Response

JSON response shape

{ error: string;
  message: string;
  }

JSON response shape

{ attributes: Record<string, string>;
  }

Errors: validation/authentication failures use the common error envelope. A missing or inaccessible target returns an error; never interpret it as an empty successful result.

Implementation · Handler: handleGetCustomerAttributes.