Provider keys update
Rename a key, move it in its pool or replace its secret. {key} is a key id, or a provider for its first key.
PATCH/api/v1/api-keys/{key}
Parameters
Path
| Name | In | Description |
|---|---|---|
keyrequired | path | The record's id. |
Body
A JSON object. Fields not listed are ignored.
| Name | In | Description |
|---|---|---|
name | body | The new name. |
position | body, integer | Its place in the pool, 0 first. |
key | body | A new secret, verified on save. |
Example
curl
curl -X PATCH "https://crm.ashwanth.dev/api/v1/api-keys/{key}" \
-H "Authorization: Bearer $SALES_ENGINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "",
"position": 0,
"key": ""
}'CLI
sales-engine provider-keys update <key>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.
Path
requiredThe record's id.
Every documented field is listed above; leave out the ones you do not need.
Request
PATCH /api/v1/api-keys/%7Bkey%7D
Fill the path first.