GEgetsales
api_keys

Update API key

Rename a key or replace its permissions (a full replacement, inside the issuer's grant: 403 grant_exceeds_ceiling). The identity and the secret are untouched (rotate_api_key changes the secret). At least one field. The change binds here at once; a peer that cached the key's verdict keeps the old set for up to 300 seconds.

Contract:

  • MCP tool update_api_key, registry package mcp.id/api_keys, mount id.access.
  • Operation update, response envelope update.
  • Flags: none.
patch/api/api-keys/{sid}

Request

  • Base URL
    https://beta.getsales.io/id/v1
  • Auth
    HTTP bearer and API key in header Team-SID

Path parameters

sidstring required

API key sid (id_ak_...).

Request body

namestring

New name, 1..255 chars.

permissionsstring[]

FULL replacement of the key's permission list.

account_sidsstring[] nullable

FULL replacement of the key's sender slice (ln_ac_...), inside the issuer's own; null = the issuer's whole slice.

Response

update success envelope.

successtrue required
operation'update' required
updated_fieldsstring[] required
previous_valuesobject required
kept_fieldsstring[]

The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed.

Changes

No recorded changes to this operation across all 1 revision of this API.