v8

OpenAPI 3.1.02026-08-033623795.0 MB
Companies

Create child company API key

Create an API key for a connected account (child company) owned by a parent company.

post/companies/{parent_company_id}/api_keys

Path parameters

parent_company_idstring required

The unique identifier of the parent platform company (e.g. 'biz_xxx').

Request body

child_company_idstring required

The unique identifier of the connected account to create the API key for (e.g. 'biz_xxx').

namestring nullable

A human-readable name for the API key, such as 'Production API Key'.

role'owner' | 'admin' | 'moderator' | 'sales_manager' | 'advertiser'

The different system roles that can be assigned.

Response

A successful response

idstring required

The unique identifier for the authorized api key.

namestring nullable required

A user set name to identify an API key

secret_keystring required

The secret key used to authenticate requests. Only returned at creation time.