API Keys

Create an API key

Creates an API key and returns the full key value exactly once. This endpoint requires a read-write API key with access to all profiles; profile-scoped keys receive a 403. Store the returned key securely — it cannot be retrieved again after this response.

post/v1/api-keys

Request

  • Base URL: https://api.postzen.dev
  • URL: https://api.postzen.dev/v1/api-keys
  • Auth: HTTP bearer

Request body

namestring required

Human-readable label for the key.

scope'full' | 'profiles'

full grants access to all profiles; profiles restricts the key to profileIds.

profileIdsstring[]

PostZen profile ids. Required when scope is profiles, and forbidden when scope is full.

permission'read-write' | 'read'

read keys may only call GET endpoints.

Response

API key created.

messagestring required

Changes

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