v1

latestOpenAPI 3.1.02026-07-2616459400.5 KB
API Management

Create API key

This endpoint allows you to create an API key with relevant permissions as per users need. The scopes that need to included in the API need to be passed in the API call as comma seperated values.<br> Following are the supported scopes -

  • "email.send"
  • "domain.read"
  • "domain.write"
  • "suppression.write"
  • "template.read"
  • "template.write"
  • "tags.write"
  • "subaccount.read"
  • "subaccount.write"
  • "events"
  • "logs"
  • "stats"
  • "apikey.read"
  • "apikey.write"
  • "webhook.read"
  • "webhook.write"
post/api_keys

Headers

on-behalf-ofstring
Example:on-behalf-of: <name of the subaccount>

The On Behalf Of header allows you to make API calls from a parent account on behalf of the parent's customer accounts

Request body

namestring
scopesstring[]
ip_addressstring[]

Response

Created

api_keystring
api_key_idinteger
namestring
scopesstring[]
ip_addressstring[]