Sales Engine
API documentation
Provider keysOperation providerKeys.reorder

Provider keys reorder

Set the order of one provider's pool: the first key is used first, the next takes over when it runs out of credit.

POST/api/v1/api-keys/order
Scope admin: Provider keys, developer keys, mailboxes, domains, settings, fixed costs.

Parameters

Body

A JSON object. Fields not listed are ignored.

NameInDescription
providerrequiredbodyThe provider.
idsrequiredbody, arrayEvery key id of that provider, in the order to try them.

Example

curl
curl -X POST "https://crm.ashwanth.dev/api/v1/api-keys/order" \
  -H "Authorization: Bearer $SALES_ENGINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "provider": "",
  "ids": []
}'
CLI
sales-engine provider-keys reorder --provider "..." --ids '[]'

The JSON above lists every documented field with a typed placeholder; send only the ones you mean.

Response

A 200 with the result under data, on creation too. Errors come back as an error object with a stable code; see Errors.

Shape
{
  "data": { ... }
}

Run it below to see the live shape for your workspace.

Try it

Runs against this server, as the workspace behind the key.
Kept in this page while you browse the docs, gone on reload, never stored. Signed in to the app? Leave it blank and the call runs as you.
Every documented field is listed above; leave out the ones you do not need.
Request
POST /api/v1/api-keys/order

Also in Provider keys