INinstantly
APIKey

Create api key

Changed on

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

post/api/v2/api-keys

Request

  • Base URL
    https://api.instantly.ai
  • URL
    https://api.instantly.ai/api/v2/api-keys
  • Auth
    HTTP bearer

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": "01a19e6f-3f1d-731c-9048-24c8ae5af679",
  "name": "My API Key",
  "scopes": [
    "campaigns:create"
  ],
  "key": "ZmNhN2RjNGYtMThmNS00NDFlLTkwYWItM2IzOTQ4NWMyYjY5OkZpWHVkMjZla19TYzNTWDNCVTJEQkJfN3dfM3prNV9p",
  "organization_id": "01a19e6f-3f1e-7d9b-b6a2-aad79d1c53bd",
  "timestamp_created": "2026-11-02T22:44:13.214Z",
  "timestamp_updated": "2026-11-02T22:44:13.214Z"
}

Changes

  • c781051105a8Revision changes
    • warning

      added the new email_marketing_events:all enum value to the / response property for the response status

    • warning

      added the new email_marketing_events:create enum value to the / response property for the response status

    • warning

      added the new email_marketing_events:read enum value to the / response property for the response status

    • warning

      added the new supersearch_enrichments:all enum value to the / response property for the response status

    • warning

      added the new supersearch_enrichments:create enum value to the / response property for the response status

    • warning

      added the new supersearch_enrichments:delete enum value to the / response property for the response status

    • warning

      added the new supersearch_enrichments:read enum value to the / response property for the response status

    • warning

      added the new supersearch_enrichments:update enum value to the / response property for the response status

    • info

      added the new email_marketing_events:all enum value to the request property /

    • info

      added the new email_marketing_events:create enum value to the request property /

    • info

      added the new email_marketing_events:read enum value to the request property /

    • info

      added the new supersearch_enrichments:all enum value to the request property /

    • info

      added the new supersearch_enrichments:create enum value to the request property /

    • info

      added the new supersearch_enrichments:delete enum value to the request property /

    • info

      added the new supersearch_enrichments:read enum value to the request property /

    • info

      added the new supersearch_enrichments:update enum value to the request property /