v1

latestOpenAPI 3.1.0MIT2026-08-0652106151.4 KB
consumerkey

Create Consumer Key

Create new Consumer Key

Note: Consumer Key creation is not allwed when authenticated via Consumer Key.

post/user/consumerKeys

Request body

labelstring

Consumer Key label.

permissionsstring[] required

Permissions granted to this consumer key. At least one value is required.

ipsstring[]

IP addresses allowed to use this consumer key. Empty array or omitted means no restriction.

Example request

{
  "label": "QAkey.",
  "permissions": [
    "SEND_SMTP",
    "SEND_API",
    "APIS"
  ],
  "ips": [
    "192.168.1.1"
  ]
}

Response

Sucess

Consumer Key Created Sucessfully.

consumerKeystring

Consumer Key

consumerSecretstring

Consumer Secret

Example response

{
  "consumerKey": "b914ad238d0e8e8851b81e86ce46ae1d",
  "consumerSecret": "JOSenWTYopGjhZ1CDvsEbcK9PNUA06Xy"
}