API Keys

Update Api Key

Update API key name, scopes, or Pinterest account allow-list.

patch/v1/api-keys/{key_id}

Request

  • Base URL: https://api.pinbridge.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.pinbridge.io/v1/api-keys/{key_id}
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

key_idstring uuid required

Headers

x-api-keystring nullable
authorizationstring nullable

Request body

namestring nullable

Human-readable name for this API key

scopesstring[] nullable

Scopes granted to this key. read covers list/get endpoints, write covers creating and updating pins, schedules, boards, assets and webhooks, and destructive covers deletes and revocations. Omit to grant every scope.

pinterest_account_idsstring[] nullable

Optional allow-list of Pinterest account IDs this key may act on. Omit or send null to allow every account in the workspace.

Response

Successful Response

idstring uuid required
workspace_idstring uuid required
namestring required
scopesstring[] required
pinterest_account_idsstring[] nullable
last_used_atstring date-time nullable
created_atstring date-time required
revoked_atstring date-time nullable
source'manual' | 'oauth' required

manual for keys created in the dashboard or API, oauth for keys minted when an AI agent or app connected through OAuth

client_namestring nullable

Name the OAuth client registered with. Null for manual keys, and for oauth keys whose client registered without a name.

authorized_by_emailstring nullable

Email of the member who authorized the connection. Null for manual keys, and for oauth keys whose authorizing member no longer exists.

Changes

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