Skip to content
API referenceCustomers API

Set a customer's company roles

For AI assistants: the facts every SparkLayer API call needs
  • Base URLs: Live https://app.sparklayer.io, test https://test.app.sparklayer.io. Each environment has its own data and its own API keys.
  • Access: API access needs the Pro or Enterprise plan. Create credentials (Site ID, Client ID, Client Secret) in the SparkLayer Dashboard at Settings > API.
  • Access token: POST {base}/api/auth/token with a Site-Id header and a JSON body (not form-encoded): {"grant_type":"client_credentials","client_id":"…","client_secret":"…"}. It returns access_token, valid for 3,600 seconds. There is no refresh token: cache the token and request a new one shortly before it expires.
  • Every request: Authorization: Bearer <access_token> and Site-Id: <site id>, plus Content-Type: application/json when there is a body. Set a User-Agent that names your integration.
  • Errors: RFC 7807 problem details: title, status, detail and an optional errors[] of { code, message, property }. Some error responses have no body. Retry 5xx, 429 (honouring Retry-After) and concurrent-update 409s with exponential backoff; on 401, get a new token once and retry; don't retry other 4xx without changing the request.
  • Pagination: Most list endpoints return everything. GET /api/v2/price-lists pages with page and page_size (up to 250) until pagination.current_page equals total_pages. GET /api/v1/purchases uses limit (up to 500) and offset: stop when a page has fewer than limit results.
  • Ground rules: Use only endpoints, fields and SDK methods that the docs or OpenAPI specs define. Prefer GET /api/v2/price-lists over the deprecated v1, and the Customers API (/api/v2/customers) over the legacy DELETE /api/v1/customers in the Core API. Products are matched by SKU. Keep credentials in environment variables or a secrets manager, never in code.
  • Read the docs as Markdown: Add .md to any page URL. Index of every page: docs.sparklayer.io/llms.txt. Every API operation, compactly: docs.sparklayer.io/llms-api.txt. The developer guides in full: docs.sparklayer.io/developers/llms.txt.
  • OpenAPI specs: customers, core, ordering, pricing, purchasing, stock, files, sync-log: https://docs.sparklayer.io/openapi/<api>.yaml (also .json). Ignite: https://docs.sparklayer.io/openapi/ignite.yaml.
  • MCP: Search and read these docs from your assistant with the docs MCP server at https://docs.sparklayer.io/mcp.
Build with AI: ready-made prompts and MCP setup
PUT
/api/v2/customers/{lookupBy}/{identifier}/company-roles

Replaces the customer's role in a company, or their roles in its locations, and returns 204.

  • Each key is co:<type>:<identifier> for the company or se:<type>:<identifier> for a location (section), where <type> is s (SparkLayer ID), p (platform ID) or x (integration ID). All the keys are for one company.
  • Each value is a role slug. A company key set to null gives the company for the location keys without giving a company-wide role.
  • An empty object removes the customer from every company and location, except where they are an admin.
  • Sales roles can't be assigned here: assign them in the Dashboard.

Authorization

bearerAuth
AuthorizationBearer <token>

Send Authorization: Bearer <access_token>, together with your Site-Id header, on every request. Get the token from POST /api/auth/token with your Site ID in the Site-Id header and a JSON body (not form-encoded, so standard OAuth 2.0 client libraries don't work): {"grant_type": "client_credentials", "client_id": "…", "client_secret": "…"}. Tokens are valid for 3,600 seconds and there is no refresh token: request a new one shortly before it expires. Create API credentials in the SparkLayer Dashboard under Settings > API. See Authentication.

In: header

Path Parameters

lookupBy*string

What identifier is: sparklayer (the customer's SparkLayer ID), platform (their ID on your eCommerce platform) or email (their email address).

Value in

  • "sparklayer"
  • "platform"
  • "email"
identifier*string

The customer's ID or email address, of the kind set by lookupBy. SparkLayer IDs are UUIDs; legacy cu_ IDs work too, except for shopping lists and favourites. Email lookups are exact and case-sensitive: URL-encode the address, with + as %2B.

Header Parameters

Site-Id*string

Your SparkLayer Site ID, from Settings > API in the SparkLayer Dashboard.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Replace the customer's company-level role assignment or section-level role assignments within one company. Keys must use co:<id_type>: for the company target or se:<id_type>: for section targets. id_type must be s (SparkLayer ID), p (platform/external_id), or x (integration_id). A company key with a string value assigns a company-level role. A company key with null provides the company context for section role keys. Send an empty object to detach the customer from all companies and sections.

[key: string]?string|null

Response Body

application/problem+json

curl -X PUT "https://app.sparklayer.io/api/v2/customers/platform/7843024560291/company-roles" \  -H "Authorization: Bearer <ACCESS_TOKEN>" \  -H "Site-Id: jones-climbing" \  -H "Content-Type: application/json" \  -d '{    "co:s:9151f21f-43ae-43b4-92f3-f4af67cdf544": null,    "se:p:dept-123": "limited-customer",    "se:x:dept-integration-456": "main"  }'
Empty

PATCHUpdate a customer

Changes only the fields you send, then saves the customer with the same checks as **Create or update a customer**. Returns `404` if no customer matches. - **`addresses` replaces all the customer's addresses**, if you send it. - **`payment_on_account` replaces the whole object**: include `currency_code` and `net_terms` to keep them. It also records the balance, as in **Create or update a customer**. - **`tax_exempt` can't be changed here.** Use **Create or update a customer**. - **The identifier you look the customer up by can't change.** To change a customer's email address, look them up by `sparklayer` or `platform`.

GETList a customer's addresses

Returns all the customer's addresses, as a single array.