v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB

APIKey

Create api key

Requires one of the following scopes: api_keys:create, api_keys:all, all:create, all:all

post/api/v2/api-keys

Request body

namestring required

scopesstring[] required

Example request

{
  "name": "My API Key",
  "scopes": [
    "campaigns:create"
  ]
}

Response

The API Key

idstring uuid required

namestring required

scopesstring[] required

keystring required

organization_idstring uuid required

timestamp_createdstring date-time required

timestamp_updatedstring date-time required

Example response

{
  "id": "019f94cd-837d-7036-ad0e-40ee80966f48",
  "name": "My API Key",
  "scopes": [
    "campaigns:create"
  ],
  "key": "a1b2c3d4e5f6g7h8i9j0",
  "organization_id": "019f94cd-838a-7e2f-ac76-250dd29596cb",
  "timestamp_created": "2026-07-24T15:45:24.362Z",
  "timestamp_updated": "2026-07-24T15:45:24.362Z"
}