Skip to main content
POST
Create API key

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of create_api_key.

name
string
required

Human-readable key name; unique among the team's live keys.

Required string length: 1 - 255
permissions
enum<string>[]
required

The explicit token list the key gets; inside the issuer's own grant.

A permission token of the gs catalog (can_view_teams, can_manage_webhooks, ...); * only from an unrestricted issuer. Playtables and inbox reads carry no tokens of their own yet.

Available options:
can_view_teams,
can_manage_teams,
can_view_team_members,
can_manage_team_members,
can_view_api_keys,
can_manage_api_keys,
can_view_oauth_clients,
can_manage_oauth_clients,
can_view_sessions,
can_manage_sessions,
can_view_account_shares,
can_manage_account_shares,
can_manage_account_transfers,
can_view_billing,
can_manage_billing,
can_view_ssl_certificates,
can_manage_ssl_certificates,
can_view_notifications,
can_manage_notifications,
can_view_support_requests,
can_manage_support_requests,
can_view_linkedin_connections,
can_act_linkedin_connections,
can_view_linkedin_messages,
can_act_linkedin_messages,
can_act_linkedin_engagements,
can_view_linkedin_searches,
can_act_linkedin_searches,
can_view_linkedin_enrichment,
can_act_linkedin_enrichment,
can_view_linkedin_accounts,
can_update_linkedin_accounts,
can_manage_linkedin_accounts,
can_open_cloud_browser,
can_change_proxy,
can_edit_schedule,
can_manage_smart_limits,
can_manage_cloud_browser_external_links,
can_share_vendor_profiles,
can_act_linkedin_custom_requests,
can_view_email_messages,
can_act_email_messages,
can_view_email_engagements,
can_view_email_accounts,
can_update_email_accounts,
can_manage_email_accounts,
can_view_email_suppressions,
can_manage_email_suppressions,
can_view_email_tracking_domains,
can_manage_email_tracking_domains,
can_view_email_sending_domains,
can_manage_email_sending_domains,
can_view_mass_actions,
can_manage_mass_actions,
can_view_webhooks,
can_manage_webhooks,
can_view_whitelabels,
can_manage_whitelabels,
can_view_integrations,
can_manage_integrations,
*
account_sids
string[] | null

The sender identities the key may act on (ln_ac_...), inside the issuer's own slice; omitted or null = the issuer's whole slice.

Required array length: 1 - 100 elements

A LinkedIn account sid (ln_ac_...): one sender identity of the key's slice.

Required string length: 18
Pattern: ^ln_ac_
expires_at
string | null

ISO 8601 UTC; omit = now plus three years; null = perpetual.

Response

create success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
create
item
object
required
already_exists
boolean
required
meta
object
required
plaintext_token
string

The full secret, shown ONCE on a real mint; absent when already_exists is true.