MImiddesk
subAccounts

Create a sub-account API key

Changed on

Creates a sandbox or production API key for a sub-account. Treat the returned key value as a secret. For rotation, create a replacement, cut traffic over, then revoke the old key.

post/v1/sub_accounts/{sub_account_id}/api_keys

Request

Path parameters

sub_account_idstring required

Sub-account ID

Request body

namestring required
environment'sandbox' | 'production' required

Response

sub-account API key created

object'api_key' required
idstring uuid required
namestring required
valuestring required
live_modeboolean required
created_atstring date-time required
updated_atstring date-time required
api_version'2020-01-01' | '2020-05-11' required

Changes

  • 4c9cd4e834baRevision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security bearer_auth was added to the API

  • 668373c892ceRevision changes
    • info

      api operation id createSubAccountApiKey removed and replaced with subAccounts_createSubAccountApiKey