Skip to main content

Create an API Key

POST 
/api/partner-gateway/v1/authentication

Creates a new API key for your account and returns the full key value in the response. IMPORTANT: The full key value is shown only once in this response. It cannot be retrieved again through any endpoint, so you must copy and store it securely immediately after creation. The key becomes active instantly and can be used to authenticate requests by passing it in the X-API-Key header. You must scope the key by listing operations (e.g. SMS, RCS, WHATSAPP) in the operations field of the request body, so that each integration gets a least-privilege key. The operations you request must be a subset of the operations held by the key making this call: a key cannot grant privileges it does not have itself. Use GET /authentication/me to check what your current key is scoped to before choosing them. If you lose a key, the only option is to delete it with DELETE /authentication/{id} and create a new one. Keys created here are identified by their id and userId and carry no username, so the username field of the response is always null. Returns 400 if the request body is malformed or missing required fields, including an absent or empty operations list. Returns 403 if the requested operations exceed the scope of the key making the call. Returns 500 if an internal error occurs.

Request​

Responses​

API Key created successfully

Last updated on