create_api_key
Create a new PricklyMails API key under the caller's account and return its raw value once (field raw_key). Pass that value as the api_key argument to verify_email or get_verification to bill verifications against it. environment picks live (default, real billing and real SMTP) or test (a deterministic sandbox: no SMTP, no wallet debit). scopes and enabled_checks default to the project defaults when omitted. Requires the api_keys:create scope on the caller's session.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Display name for the new key, shown in the PricklyMails dashboard. | |
| scopes | No | Optional scope wire strings (e.g. email:verify:single, results:read); when absent the project default scopes are applied. | |
| environment | No | Optional environment, live or test (defaults to live). A test key (pm_test_*) runs a deterministic sandbox: the worker never dials SMTP or resolves DNS, and nothing is reserved or billed from the wallet, so it is safe for integration testing. | |
| enabled_checks | No | Optional check wire strings (syntax, mx, smtp, disposable, role, free, catchall); when absent the default check set is applied. |