Account

Issue a key

The secret is shown once and never again. name is trimmed and limited to 80 characters; a blank name is not stored blank, it gets a descriptive default naming what the key can do ('read-only key' or 'ordering key'). Scopes default to ['read']; a read-only key cannot issue a key with the order scope (403). At most 20 active keys.

post/v1/keys

Request

  • Base URL: https://api.placementapi.com
  • URL: https://api.placementapi.com/v1/keys
  • Auth: HTTP bearer

Request body

namestring

A label so the key list stays readable, trimmed. Blank or omitted stores the scope-based default ('read-only key' or 'ordering key').

scopesstring[]

Ordering is opt-in per key. An explicit array matching neither scope is refused (400) rather than silently issuing a read-only key.

Response

OK

key_idstring
namestring

The effective stored name: the trimmed name sent, or the scope-based default when blank.

scopesstring[]
can_orderboolean
keystring

The pk_live_… secret. Shown once.

warningstring

Changes

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