api-keys

Creates an API key for the authenticated account and returns the full key in the response body.

post/api/keys

Request

  • Base URL: https://api.pricklymails.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.pricklymails.com/api/keys
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Request body

enabled_checksstring[] nullable

Verification checks to enable: "syntax", "mx", "smtp", "disposable", "role", "free" or "catchall".

environmentstring nullable

Environment of the key: "live" or "test". Defaults to "live" when absent.

namestring required

Display name shown in the dashboard.

scopesstring[] nullable

Scopes to grant, for example "email:verify:single".

Response

Key created; raw_key is shown once.

raw_keystring required

The full API key. It is returned only once, so store it securely.

Changes

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