import requestsresp = requests.post( "https://api.tracklysms.com/api/v2/accounts/children/1042/api-keys", headers={"X-Api-Key": "trk_your_parent_key"}, json={"name": "prod", "permissions": ["api.full"]},)key = resp.json()["apiKey"]["key"] # store this now — shown once
import requestsresp = requests.post( "https://api.tracklysms.com/api/v2/accounts/children/1042/api-keys", headers={"X-Api-Key": "trk_your_parent_key"}, json={"name": "prod", "permissions": ["api.full"]},)key = resp.json()["apiKey"]["key"] # store this now — shown once
Mints a new API key for a child. Use your parent key with accounts.write. The child then authenticates its own requests with the returned key.The server rechecks parent authority when it creates the key. If the parent credential, account ownership, or child key capacity changes concurrently, creation returns 409 create_key_conflict; reload the current configuration before trying again. If creation cannot be confirmed, 409 api_key_outcome_unknown returns no plaintext and includes retryable: false. Do not repeat the mint; contact support with its supportReference.
The plaintext key is returned exactly once, in this response. Store it immediately — it cannot be retrieved later, only rotated or revoked.
Path Parameters
integer
required
The child account’s accountId.
Body Parameters
string
required
A label for the key (e.g. prod, staging). Max 255 characters.
array
default:["api.full"]
A list of resource.action permission strings. The requested set must be a subset of the calling parent key’s own permissions. Sensitive resources (admin, system, billing, account, accounts, users, keys, api_keys, internal, root, super) and the wildcard * can never be granted.
object
Send restrictions for the key. list_numbers (array of up to 200 E.164 strings) limits the key to those sending lists; a send from any other list, or a schedule whose source lists include another list, is refused with 403 list_not_allowed_for_key. Numbers are normalized to E.164 on save. list_numbers is the only key accepted here; omit it or pass an empty list for no restriction.
integer
Maximum live sends per UTC day through the /v2/send family of endpoints for this key (positive integer, max 1,000,000); omit or null for no cap. Once reached, sends are refused with 429 daily_cap_exceeded until the next UTC day. Sandbox, scheduled, and OTP sends do not count. The key’s current usage is visible on Who Am I as send_policy.sends_today.
A parent key with active list restrictions, a dailySendCap, an IP allowlist, or required send approval cannot mint or rotate child keys (403 constrained_key_cannot_delegate). An otherwise unrestricted parent may delegate when list_numbers is omitted, null, or an empty list. Malformed or unsupported stored constraints block delegation. Rotation preserves the child’s cap, list restriction, and confirmation setting; both keys share one daily counter.
Partner-minted keys are live keys. To get a sandbox key, create one from the dashboard (see Sandbox & Testing).
boolean
default:false
Require human approval for SMS sends. Direct SMS/raw SMS, email, OTP, and send-enabling operations are blocked; use pending sends for SMS. A parent with this restriction cannot mint or rotate child keys (403 constrained_key_cannot_delegate). The response includes requireSendConfirmation.
Response Fields
object
The created key. Includes id, accountId, name, key (plaintext, once), keyPrefix, status, permissions, resourceConstraints, expiresAt, allowedIps, rateLimitOverride, sandbox, graceUntil, rotatedFrom, lastUsedIp, createdAt, and lastUsedAt.
import requestsresp = requests.post( "https://api.tracklysms.com/api/v2/accounts/children/1042/api-keys", headers={"X-Api-Key": "trk_your_parent_key"}, json={"name": "prod", "permissions": ["api.full"]},)key = resp.json()["apiKey"]["key"] # store this now — shown once
A permission is malformed, not a subset of the caller’s grant, or references a reserved resource.
400
key_cap_exceeded
The child has hit its active-key cap. The cap defaults to 25 and can vary by environment.
403
constrained_key_cannot_delegate
The calling key has IP restrictions, active or invalid resource constraints, or a daily cap.
403
api_key_has_no_owner
The calling key has no owning user to attribute the mint to.
404
child_not_found
No child with that ID under this parent.
409
child_deleted
The child has been deleted.
409
create_key_conflict
Parent authority, account ownership, or child key capacity changed concurrently. Reload the current configuration before minting.
409
api_key_outcome_unknown
Creation could not be confirmed. No plaintext is returned. Do not retry; contact support with the response’s supportReference.
502
create_key_failed
Key creation failed before a confirmed outcome; retry only when the response uses this code.
503
api_key_lineage_unavailable
The parent’s key history could not be validated. Contact support before retrying.
Also 403 not_a_parent_account / insufficient_scope / sandbox_read_only.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Trackly SMS","colors":{"primary":"#84DE4D","light":"#A8E87A","dark":"#5CB030"},"favicon":"https://mintcdn.com/trackly/m198FBazwIseN-2r/images/favicon.svg?fit=max\u0026auto=format\u0026n=m198FBazwIseN-2r\u0026q=85\u0026s=61a63692248026382c71445dd67beb20","logo":{"light":"https://mintcdn.com/trackly/m198FBazwIseN-2r/images/logo-light.svg?fit=max\u0026auto=format\u0026n=m198FBazwIseN-2r\u0026q=85\u0026s=675b2c397e9309f5fea1d36c1f87c412","dark":"https://mintcdn.com/trackly/m198FBazwIseN-2r/images/logo-dark.svg?fit=max\u0026auto=format\u0026n=m198FBazwIseN-2r\u0026q=85\u0026s=2d8dda3d4bf41d024a88f041f57b57a1"},"api":{"openapi":"openapi.json","playground":{"display":"interactive"},"mdx":{"server":"https://api.tracklysms.com/api","auth":{"method":"key","name":"X-Api-Key"}}},"background":{"decoration":null,"color":{"light":"#F3F7EF","dark":"#0C0F0C"}},"navbar":{"links":[{"label":"Discord","href":"https://discord.gg/trackly"},{"label":"Support","href":"mailto:support@tracklysms.com"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.tracklysms.com"}},"footer":{"socials":{"twitter":"https://twitter.com/tracklysms","linkedin":"https://linkedin.com/company/tracklysms"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"trackly","hasAudioNarration":false,"actualSubdomain":"trackly","customDomains":["docs.tracklysms.com"],"gitSource":{"type":"github","owner":"it-s-today-media","repo":"trackly_sms_python","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6b011652e6c40135846ae806","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Documentation","count":350},{"language":"default","tag":"API Reference","count":182},{"language":"default","tag":"Guides","count":55},{"language":"default","tag":"Voice Calls (v1)","count":33},{"language":"default","tag":"Number Requests (v2)","count":14},{"language":"default","tag":"Business Verification (v2)","count":13},{"language":"default","tag":"Platform Integrations","count":12},{"language":"default","tag":"Partner Accounts (v2)","count":11},{"language":"default","tag":"V2 API Reference","count":11},{"language":"default","tag":"Webhooks (v2)","count":11}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"/* cyrillic-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2JL7SUc.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa0ZL7SUc.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2ZL7SUc.woff2) format('woff2');\n unicode-range: U+1F00-1FFF;\n}\n/* greek */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1pL7SUc.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2pL7SUc.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa25L7SUc.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1ZL7.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2JL7SUc.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa0ZL7SUc.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2ZL7SUc.woff2) format('woff2');\n unicode-range: U+1F00-1FFF;\n}\n/* greek */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1pL7SUc.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2pL7SUc.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa25L7SUc.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1ZL7.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2JL7SUc.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa0ZL7SUc.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2ZL7SUc.woff2) format('woff2');\n unicode-range: U+1F00-1FFF;\n}\n/* greek */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1pL7SUc.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2pL7SUc.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa25L7SUc.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1ZL7.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2JL7SUc.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa0ZL7SUc.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2ZL7SUc.woff2) format('woff2');\n unicode-range: U+1F00-1FFF;\n}\n/* greek */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1pL7SUc.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2pL7SUc.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa25L7SUc.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1ZL7.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbY2o-flEEny0FZhsfKu5WU4zr3E_BX0PnT8RD8L6tTN1OVgaY.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbY2o-flEEny0FZhsfKu5WU4zr3E_BX0PnT8RD8L6tTPlOVgaY.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbY2o-flEEny0FZhsfKu5WU4zr3E_BX0PnT8RD8L6tTOVOVgaY.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbY2o-flEEny0FZhsfKu5WU4zr3E_BX0PnT8RD8L6tTNVOVgaY.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbY2o-flEEny0FZhsfKu5WU4zr3E_BX0PnT8RD8L6tTNFOVgaY.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbY2o-flEEny0FZhsfKu5WU4zr3E_BX0PnT8RD8L6tTOlOV.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\nh1,h2,h3{font-family:'JetBrains Mono', monospace;font-weight:700}body,p,li,td{font-family:'Inter', system-ui, -apple-system, sans-serif}"}]}
{"page":{"pagePath":"api-reference/v2/accounts/create-api-key","slug":"/api-reference/v2/accounts/create-api-key","pageMetadata":{"title":"Create API Key","api":"POST /v2/accounts/children/{child_id}/api-keys","description":"Mint a scoped API key for a child account. The plaintext key is returned exactly once.","href":"/api-reference/v2/accounts/create-api-key"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Mint a scoped API key for a child account. The plaintext key is returned exactly once.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Heading,Note,ParamField,ResponseField,Table,Warning}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Mints a new API key for a child. Use your `,_jsx(_components.strong,{children:`parent`}),` key with `,_jsx(_components.code,{children:`accounts.write`}),`. The child then authenticates its own requests with the returned key.`]}),`\n`,_jsxs(_components.p,{children:[`The server rechecks parent authority when it creates the key. If the parent credential, account ownership, or child key capacity changes concurrently, creation returns `,_jsx(_components.code,{children:`409 create_key_conflict`}),`; reload the current configuration before trying again. If creation cannot be confirmed, `,_jsx(_components.code,{children:`409 api_key_outcome_unknown`}),` returns no plaintext and includes `,_jsx(_components.code,{children:`retryable: false`}),`. Do not repeat the mint; contact support with its `,_jsx(_components.code,{children:`supportReference`}),`.`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`The plaintext `,_jsx(_components.code,{children:`key`}),` is returned `,_jsx(_components.strong,{children:`exactly once`}),`, in this response. Store it immediately — it cannot be retrieved later, only `,_jsx(_components.a,{href:`/api-reference/v2/accounts/rotate-api-key`,children:`rotated`}),` or `,_jsx(_components.a,{href:`/api-reference/v2/accounts/revoke-api-key`,children:`revoked`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`path-parameters`,children:`Path Parameters`}),`\n`,_jsx(ParamField,{path:`child_id`,type:`integer`,required:true,id:`param-child-id`,children:_jsxs(_components.p,{children:[`The child account’s `,_jsx(_components.code,{children:`accountId`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`body-parameters`,children:`Body Parameters`}),`\n`,_jsx(ParamField,{body:`name`,type:`string`,required:true,id:`param-name`,children:_jsxs(_components.p,{children:[`A label for the key (e.g. `,_jsx(_components.code,{children:`prod`}),`, `,_jsx(_components.code,{children:`staging`}),`). Max 255 characters.`]})}),`\n`,_jsx(ParamField,{body:`permissions`,type:`array`,default:[`api.full`],id:`param-permissions`,children:_jsxs(_components.p,{children:[`A list of `,_jsx(_components.code,{children:`resource.action`}),` permission strings. The requested set must be a `,_jsx(_components.strong,{children:`subset`}),` of the calling parent key’s own permissions. Sensitive resources (`,_jsx(_components.code,{children:`admin`}),`, `,_jsx(_components.code,{children:`system`}),`, `,_jsx(_components.code,{children:`billing`}),`, `,_jsx(_components.code,{children:`account`}),`, `,_jsx(_components.code,{children:`accounts`}),`, `,_jsx(_components.code,{children:`users`}),`, `,_jsx(_components.code,{children:`keys`}),`, `,_jsx(_components.code,{children:`api_keys`}),`, `,_jsx(_components.code,{children:`internal`}),`, `,_jsx(_components.code,{children:`root`}),`, `,_jsx(_components.code,{children:`super`}),`) and the wildcard `,_jsx(_components.code,{children:`*`}),` can never be granted.`]})}),`\n`,_jsx(ParamField,{body:`resourceConstraints`,type:`object`,id:`param-resource-constraints`,children:_jsxs(_components.p,{children:[`Send restrictions for the key. `,_jsx(_components.code,{children:`list_numbers`}),` (array of up to 200 E.164 strings) limits the key to those sending lists; a send from any other list, or a schedule whose source lists include another list, is refused with `,_jsx(_components.code,{children:`403 list_not_allowed_for_key`}),`. Numbers are normalized to E.164 on save. `,_jsx(_components.code,{children:`list_numbers`}),` is the only key accepted here; omit it or pass an empty list for no restriction.`]})}),`\n`,_jsx(ParamField,{body:`dailySendCap`,type:`integer`,id:`param-daily-send-cap`,children:_jsxs(_components.p,{children:[`Maximum live sends per UTC day through the `,_jsx(_components.code,{children:`/v2/send`}),` family of endpoints for this key (positive integer, max 1,000,000); omit or `,_jsx(_components.code,{children:`null`}),` for no cap. Once reached, sends are refused with `,_jsx(_components.code,{children:`429 daily_cap_exceeded`}),` until the next UTC day. Sandbox, scheduled, and OTP sends do not count. The key’s current usage is visible on `,_jsx(_components.a,{href:`/api-reference/v2/auth/whoami`,children:`Who Am I`}),` as `,_jsx(_components.code,{children:`send_policy.sends_today`}),`.`]})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`A parent key with active list restrictions, a `,_jsx(_components.code,{children:`dailySendCap`}),`, an IP allowlist, or required send approval cannot mint or rotate child keys (`,_jsx(_components.code,{children:`403 constrained_key_cannot_delegate`}),`). An otherwise unrestricted parent may delegate when `,_jsx(_components.code,{children:`list_numbers`}),` is omitted, null, or an empty list. Malformed or unsupported stored constraints block delegation. Rotation preserves the child’s cap, list restriction, and confirmation setting; both keys share one daily counter.`]})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Partner-minted keys are `,_jsx(_components.strong,{children:`live`}),` keys. To get a sandbox key, create one from the dashboard (see `,_jsx(_components.a,{href:`/api-reference/v2/sandbox`,children:`Sandbox \u0026 Testing`}),`).`]})}),`\n`,_jsxs(ParamField,{body:`requireSendConfirmation`,type:`boolean`,default:false,id:`param-require-send-confirmation`,children:[`Require human approval for SMS sends. Direct SMS/raw SMS, email, OTP, and send-enabling operations are blocked; use `,_jsx(_components.a,{href:`/api-reference/v2/pending-sends/create`,children:`pending sends`}),` for SMS. A parent with this restriction cannot mint or rotate child keys (`,_jsx(_components.code,{children:`403 constrained_key_cannot_delegate`}),`). The response includes `,_jsx(_components.code,{children:`requireSendConfirmation`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`response-fields`,children:`Response Fields`}),`\n`,_jsx(ResponseField,{name:`apiKey`,type:`object`,id:`param-api-key`,children:_jsxs(_components.p,{children:[`The created key. Includes `,_jsx(_components.code,{children:`id`}),`, `,_jsx(_components.code,{children:`accountId`}),`, `,_jsx(_components.code,{children:`name`}),`, `,_jsx(_components.code,{children:`key`}),` (`,_jsx(_components.strong,{children:`plaintext, once`}),`), `,_jsx(_components.code,{children:`keyPrefix`}),`, `,_jsx(_components.code,{children:`status`}),`, `,_jsx(_components.code,{children:`permissions`}),`, `,_jsx(_components.code,{children:`resourceConstraints`}),`, `,_jsx(_components.code,{children:`expiresAt`}),`, `,_jsx(_components.code,{children:`allowedIps`}),`, `,_jsx(_components.code,{children:`rateLimitOverride`}),`, `,_jsx(_components.code,{children:`sandbox`}),`, `,_jsx(_components.code,{children:`graceUntil`}),`, `,_jsx(_components.code,{children:`rotatedFrom`}),`, `,_jsx(_components.code,{children:`lastUsedIp`}),`, `,_jsx(_components.code,{children:`createdAt`}),`, and `,_jsx(_components.code,{children:`lastUsedAt`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`message`,type:`string`,id:`param-message`,children:_jsx(_components.p,{children:`A reminder to store the plaintext key now.`})}),`\n`,_jsx(Heading,{level:`2`,id:`examples`,children:`Examples`}),`\n`,`\n`,`\n`,_jsx(Heading,{level:`2`,id:`error-codes`,children:`Error Codes`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`HTTP Status`}),_jsx(_components.th,{children:`Error Code`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`missing_name`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`name`}),` is required.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`name_too_long`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`name`}),` exceeds 255 characters.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`invalid_permission`})}),_jsx(_components.td,{children:`A permission is malformed, not a subset of the caller’s grant, or references a reserved resource.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`key_cap_exceeded`})}),_jsx(_components.td,{children:`The child has hit its active-key cap. The cap defaults to 25 and can vary by environment.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`403`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`constrained_key_cannot_delegate`})}),_jsx(_components.td,{children:`The calling key has IP restrictions, active or invalid resource constraints, or a daily cap.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`403`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`api_key_has_no_owner`})}),_jsx(_components.td,{children:`The calling key has no owning user to attribute the mint to.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`404`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`child_not_found`})}),_jsx(_components.td,{children:`No child with that ID under this parent.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`409`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`child_deleted`})}),_jsx(_components.td,{children:`The child has been deleted.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`409`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`create_key_conflict`})}),_jsx(_components.td,{children:`Parent authority, account ownership, or child key capacity changed concurrently. Reload the current configuration before minting.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`409`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`api_key_outcome_unknown`})}),_jsxs(_components.td,{children:[`Creation could not be confirmed. No plaintext is returned. Do not retry; contact support with the response’s `,_jsx(_components.code,{children:`supportReference`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`502`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`create_key_failed`})}),_jsx(_components.td,{children:`Key creation failed before a confirmed outcome; retry only when the response uses this code.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`503`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`api_key_lineage_unavailable`})}),_jsx(_components.td,{children:`The parent’s key history could not be validated. Contact support before retrying.`})]})]})]}),`\n`,_jsxs(_components.p,{children:[`Also `,_jsx(_components.code,{children:`403 not_a_parent_account`}),` / `,_jsx(_components.code,{children:`insufficient_scope`}),` / `,_jsx(_components.code,{children:`sandbox_read_only`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create API Key","api":"POST /v2/accounts/children/{child_id}/api-keys","description":"Mint a scoped API key for a child account. The plaintext key is returned exactly once.","href":"/api-reference/v2/accounts/create-api-key"}}},"mdxSourceWithNoJs":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,ParamField,RequestExample,ResponseExample,ResponseField,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!RequestExample)_missingMdxReference(`RequestExample`,true);if(!ResponseExample)_missingMdxReference(`ResponseExample`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Mints a new API key for a child. Use your `,_jsx(_components.strong,{children:`parent`}),` key with `,_jsx(_components.code,{children:`accounts.write`}),`. The child then authenticates its own requests with the returned key.`]}),`\n`,_jsxs(_components.p,{children:[`The server rechecks parent authority when it creates the key. If the parent credential, account ownership, or child key capacity changes concurrently, creation returns `,_jsx(_components.code,{children:`409 create_key_conflict`}),`; reload the current configuration before trying again. If creation cannot be confirmed, `,_jsx(_components.code,{children:`409 api_key_outcome_unknown`}),` returns no plaintext and includes `,_jsx(_components.code,{children:`retryable: false`}),`. Do not repeat the mint; contact support with its `,_jsx(_components.code,{children:`supportReference`}),`.`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`The plaintext `,_jsx(_components.code,{children:`key`}),` is returned `,_jsx(_components.strong,{children:`exactly once`}),`, in this response. Store it immediately — it cannot be retrieved later, only `,_jsx(_components.a,{href:`/api-reference/v2/accounts/rotate-api-key`,children:`rotated`}),` or `,_jsx(_components.a,{href:`/api-reference/v2/accounts/revoke-api-key`,children:`revoked`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`path-parameters`,children:`Path Parameters`}),`\n`,_jsx(ParamField,{path:`child_id`,type:`integer`,required:true,id:`param-child-id`,children:_jsxs(_components.p,{children:[`The child account’s `,_jsx(_components.code,{children:`accountId`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`body-parameters`,children:`Body Parameters`}),`\n`,_jsx(ParamField,{body:`name`,type:`string`,required:true,id:`param-name`,children:_jsxs(_components.p,{children:[`A label for the key (e.g. `,_jsx(_components.code,{children:`prod`}),`, `,_jsx(_components.code,{children:`staging`}),`). Max 255 characters.`]})}),`\n`,_jsx(ParamField,{body:`permissions`,type:`array`,default:[`api.full`],id:`param-permissions`,children:_jsxs(_components.p,{children:[`A list of `,_jsx(_components.code,{children:`resource.action`}),` permission strings. The requested set must be a `,_jsx(_components.strong,{children:`subset`}),` of the calling parent key’s own permissions. Sensitive resources (`,_jsx(_components.code,{children:`admin`}),`, `,_jsx(_components.code,{children:`system`}),`, `,_jsx(_components.code,{children:`billing`}),`, `,_jsx(_components.code,{children:`account`}),`, `,_jsx(_components.code,{children:`accounts`}),`, `,_jsx(_components.code,{children:`users`}),`, `,_jsx(_components.code,{children:`keys`}),`, `,_jsx(_components.code,{children:`api_keys`}),`, `,_jsx(_components.code,{children:`internal`}),`, `,_jsx(_components.code,{children:`root`}),`, `,_jsx(_components.code,{children:`super`}),`) and the wildcard `,_jsx(_components.code,{children:`*`}),` can never be granted.`]})}),`\n`,_jsx(ParamField,{body:`resourceConstraints`,type:`object`,id:`param-resource-constraints`,children:_jsxs(_components.p,{children:[`Send restrictions for the key. `,_jsx(_components.code,{children:`list_numbers`}),` (array of up to 200 E.164 strings) limits the key to those sending lists; a send from any other list, or a schedule whose source lists include another list, is refused with `,_jsx(_components.code,{children:`403 list_not_allowed_for_key`}),`. Numbers are normalized to E.164 on save. `,_jsx(_components.code,{children:`list_numbers`}),` is the only key accepted here; omit it or pass an empty list for no restriction.`]})}),`\n`,_jsx(ParamField,{body:`dailySendCap`,type:`integer`,id:`param-daily-send-cap`,children:_jsxs(_components.p,{children:[`Maximum live sends per UTC day through the `,_jsx(_components.code,{children:`/v2/send`}),` family of endpoints for this key (positive integer, max 1,000,000); omit or `,_jsx(_components.code,{children:`null`}),` for no cap. Once reached, sends are refused with `,_jsx(_components.code,{children:`429 daily_cap_exceeded`}),` until the next UTC day. Sandbox, scheduled, and OTP sends do not count. The key’s current usage is visible on `,_jsx(_components.a,{href:`/api-reference/v2/auth/whoami`,children:`Who Am I`}),` as `,_jsx(_components.code,{children:`send_policy.sends_today`}),`.`]})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`A parent key with active list restrictions, a `,_jsx(_components.code,{children:`dailySendCap`}),`, an IP allowlist, or required send approval cannot mint or rotate child keys (`,_jsx(_components.code,{children:`403 constrained_key_cannot_delegate`}),`). An otherwise unrestricted parent may delegate when `,_jsx(_components.code,{children:`list_numbers`}),` is omitted, null, or an empty list. Malformed or unsupported stored constraints block delegation. Rotation preserves the child’s cap, list restriction, and confirmation setting; both keys share one daily counter.`]})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Partner-minted keys are `,_jsx(_components.strong,{children:`live`}),` keys. To get a sandbox key, create one from the dashboard (see `,_jsx(_components.a,{href:`/api-reference/v2/sandbox`,children:`Sandbox \u0026 Testing`}),`).`]})}),`\n`,_jsxs(ParamField,{body:`requireSendConfirmation`,type:`boolean`,default:false,id:`param-require-send-confirmation`,children:[`Require human approval for SMS sends. Direct SMS/raw SMS, email, OTP, and send-enabling operations are blocked; use `,_jsx(_components.a,{href:`/api-reference/v2/pending-sends/create`,children:`pending sends`}),` for SMS. A parent with this restriction cannot mint or rotate child keys (`,_jsx(_components.code,{children:`403 constrained_key_cannot_delegate`}),`). The response includes `,_jsx(_components.code,{children:`requireSendConfirmation`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`response-fields`,children:`Response Fields`}),`\n`,_jsx(ResponseField,{name:`apiKey`,type:`object`,id:`param-api-key`,children:_jsxs(_components.p,{children:[`The created key. Includes `,_jsx(_components.code,{children:`id`}),`, `,_jsx(_components.code,{children:`accountId`}),`, `,_jsx(_components.code,{children:`name`}),`, `,_jsx(_components.code,{children:`key`}),` (`,_jsx(_components.strong,{children:`plaintext, once`}),`), `,_jsx(_components.code,{children:`keyPrefix`}),`, `,_jsx(_components.code,{children:`status`}),`, `,_jsx(_components.code,{children:`permissions`}),`, `,_jsx(_components.code,{children:`resourceConstraints`}),`, `,_jsx(_components.code,{children:`expiresAt`}),`, `,_jsx(_components.code,{children:`allowedIps`}),`, `,_jsx(_components.code,{children:`rateLimitOverride`}),`, `,_jsx(_components.code,{children:`sandbox`}),`, `,_jsx(_components.code,{children:`graceUntil`}),`, `,_jsx(_components.code,{children:`rotatedFrom`}),`, `,_jsx(_components.code,{children:`lastUsedIp`}),`, `,_jsx(_components.code,{children:`createdAt`}),`, and `,_jsx(_components.code,{children:`lastUsedAt`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`message`,type:`string`,id:`param-message`,children:_jsx(_components.p,{children:`A reminder to store the plaintext key now.`})}),`\n`,_jsx(Heading,{level:`2`,id:`examples`,children:`Examples`}),`\n`,_jsxs(RequestExample,{children:[_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`4`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.tracklysms.com/api/v2/accounts/children/1042/api-keys`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-Api-Key: trk_your_parent_key\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{ \"name\": \"prod\", \"permissions\": [\"api.full\"] }'`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Python`,numberOfLines:`8`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`8`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`resp `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests.post(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.tracklysms.com/api/v2/accounts/children/1042/api-keys\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` headers`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"X-Api-Key\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"trk_your_parent_key\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`},`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` json`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"prod\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"permissions\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"api.full\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]},`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`key `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` resp.json()[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"apiKey\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`][`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"key\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`] `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# store this now — shown once`})]}),`\n`]})})})]}),`\n`,_jsx(ResponseExample,{children:_jsx(CodeBlock,{filename:`Success (201)`,numberOfLines:`22`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`22`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"apiKey\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"66b0f7c84a1d4b2e9c3a1f2e\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"accountId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1042`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"prod\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"key\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"trk_ab12cd34ef56gh78ij90kl12mn34op56\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"keyPrefix\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"trk_ab12\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"active\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"permissions\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"api.full\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"resourceConstraints\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {},`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"expiresAt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"allowedIps\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"rateLimitOverride\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"sandbox\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"graceUntil\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"rotatedFrom\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"lastUsedIp\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"createdAt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-07-26T14:05:00.000000\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"lastUsedAt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Store the plaintext key now — it cannot be retrieved later.\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})}),`\n`,_jsx(Heading,{level:`2`,id:`error-codes`,children:`Error Codes`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`HTTP Status`}),_jsx(_components.th,{children:`Error Code`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`missing_name`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`name`}),` is required.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`name_too_long`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`name`}),` exceeds 255 characters.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`invalid_permission`})}),_jsx(_components.td,{children:`A permission is malformed, not a subset of the caller’s grant, or references a reserved resource.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`key_cap_exceeded`})}),_jsx(_components.td,{children:`The child has hit its active-key cap. The cap defaults to 25 and can vary by environment.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`403`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`constrained_key_cannot_delegate`})}),_jsx(_components.td,{children:`The calling key has IP restrictions, active or invalid resource constraints, or a daily cap.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`403`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`api_key_has_no_owner`})}),_jsx(_components.td,{children:`The calling key has no owning user to attribute the mint to.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`404`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`child_not_found`})}),_jsx(_components.td,{children:`No child with that ID under this parent.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`409`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`child_deleted`})}),_jsx(_components.td,{children:`The child has been deleted.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`409`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`create_key_conflict`})}),_jsx(_components.td,{children:`Parent authority, account ownership, or child key capacity changed concurrently. Reload the current configuration before minting.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`409`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`api_key_outcome_unknown`})}),_jsxs(_components.td,{children:[`Creation could not be confirmed. No plaintext is returned. Do not retry; contact support with the response’s `,_jsx(_components.code,{children:`supportReference`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`502`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`create_key_failed`})}),_jsx(_components.td,{children:`Key creation failed before a confirmed outcome; retry only when the response uses this code.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`503`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`api_key_lineage_unavailable`})}),_jsx(_components.td,{children:`The parent’s key history could not be validated. Contact support before retrying.`})]})]})]}),`\n`,_jsxs(_components.p,{children:[`Also `,_jsx(_components.code,{children:`403 not_a_parent_account`}),` / `,_jsx(_components.code,{children:`insufficient_scope`}),` / `,_jsx(_components.code,{children:`sandbox_read_only`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create API Key","api":"POST /v2/accounts/children/{child_id}/api-keys","description":"Mint a scoped API key for a child account. The plaintext key is returned exactly once.","href":"/api-reference/v2/accounts/create-api-key"}}}},"mdxExtracts":{"tableOfContents":[{"title":"Path Parameters","slug":"path-parameters","depth":2,"children":[]},{"title":"Body Parameters","slug":"body-parameters","depth":2,"children":[]},{"title":"Response Fields","slug":"response-fields","depth":2,"children":[]},{"title":"Examples","slug":"examples","depth":2,"children":[]},{"title":"Error Codes","slug":"error-codes","depth":2,"children":[]}],"codeExamples":{"request":{"type":"RequestExample","children":[{"filename":"cURL","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"shellscript\">\u003ccode language=\"shellscript\" numberOfLines=\"4\">\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#DCDCAA\">curl\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -X\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> POST\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> https://api.tracklysms.com/api/v2/accounts/children/1042/api-keys\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -H\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"X-Api-Key: trk_your_parent_key\"\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -H\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"Content-Type: application/json\"\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -d\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> '{ \"name\": \"prod\", \"permissions\": [\"api.full\"] }'\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"Python","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"python\">\u003ccode language=\"python\" numberOfLines=\"8\">\u003cspan class=\"line\">\u003cspan style=\"color:#CF222E;--shiki-dark:#C586C0\">import\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> requests\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">resp \u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> requests.post(\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"https://api.tracklysms.com/api/v2/accounts/children/1042/api-keys\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#9CDCFE\"> headers\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"X-Api-Key\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"trk_your_parent_key\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">},\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#9CDCFE\"> json\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"name\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"prod\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">, \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"permissions\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"api.full\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">]},\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">)\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">key \u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> resp.json()[\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"apiKey\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">][\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"key\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">] \u003c/span>\u003cspan style=\"color:#6E7781;--shiki-dark:#6A9955\"># store this now — shown once\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]},"response":{"type":"ResponseExample","children":[{"filename":"Success (201)","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"22\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"apiKey\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"66b0f7c84a1d4b2e9c3a1f2e\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"accountId\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">1042\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"name\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"prod\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"key\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"trk_ab12cd34ef56gh78ij90kl12mn34op56\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"keyPrefix\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"trk_ab12\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"status\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"active\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"permissions\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"api.full\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"resourceConstraints\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {},\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"expiresAt\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">null\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"allowedIps\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"rateLimitOverride\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">null\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"sandbox\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">false\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"graceUntil\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">null\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"rotatedFrom\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">null\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"lastUsedIp\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">null\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"createdAt\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"2026-07-26T14:05:00.000000\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"lastUsedAt\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">null\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"message\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Store the plaintext key now — it cannot be retrieved later.\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}},"endpoint":{"title":"Create API Key","path":"/v2/accounts/children/{child_id}/api-keys","servers":[{"url":"https://api.tracklysms.com/api"}],"method":"post","request":{"security":[{"title":"API Key Auth","parameters":{"header":{"X-Api-Key":{"type":"apiKey"}},"query":{},"cookie":{}}}],"parameters":{"query":{},"header":{},"cookie":{},"path":{"child_id":{"schema":[{"type":"integer","description":"The child account’s `accountId` .","required":true}]}}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"name":[{"type":"string","description":"A label for the key (e.g. `prod` , `staging` ). Max 255 characters.","required":true}],"permissions":[{"type":"array","items":[{"type":"object","properties":{}}],"description":"A list of `resource.action` permission strings. The requested set must be a subset of the calling parent key’s own permissions. Sensitive resources ( `admin` , `system` , `billing` , `account` , `accounts` , `users` , `keys` , `api_keys` , `internal` , `root` , `super` ) and the wildcard `*` can never be granted."}],"resourceConstraints":[{"type":"object","properties":{},"description":"Send restrictions for the key. `list_numbers` (array of up to 200 E.164 strings) limits the key to those sending lists; a send from any other list, or a schedule whose source lists include another list, is refused with `403 list_not_allowed_for_key` . Numbers are normalized to E.164 on save. `list_numbers` is the only key accepted here; omit it or pass an empty list for no restriction."}],"dailySendCap":[{"type":"integer","description":"Maximum live sends per UTC day through the `/v2/send` family of endpoints for this key (positive integer, max 1,000,000); omit or `null` for no cap. Once reached, sends are refused with `429 daily_cap_exceeded` until the next UTC day. Sandbox, scheduled, and OTP sends do not count. The key’s current usage is visible on Who Am I as `send_policy.sends_today` ."}],"requireSendConfirmation":[{"type":"boolean","description":"Require human approval for SMS sends. Direct SMS/raw SMS, email, OTP, and send-enabling operations are blocked; use pending sends for SMS. A parent with this restriction cannot mint or rotate child keys ( `403 constrained_key_cannot_delegate` ). The response includes `requireSendConfirmation` ."}]}}],"examples":{"example":{"value":{"name":"\u003cstring>","permissions":[{}],"resourceConstraints":{},"dailySendCap":123,"requireSendConfirmation":true}}}}}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"apiKey":[{"type":"object","properties":{},"description":"The created key. Includes `id` , `accountId` , `name` , `key` ( plaintext, once ), `keyPrefix` , `status` , `permissions` , `resourceConstraints` , `expiresAt` , `allowedIps` , `rateLimitOverride` , `sandbox` , `graceUntil` , `rotatedFrom` , `lastUsedIp` , `createdAt` , and `lastUsedAt` ."}],"message":[{"type":"string","description":"A reminder to store the plaintext key now."}]}}],"examples":{"example":{"value":{"apiKey":{},"message":"\u003cstring>"}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"trackly","siteName":"Trackly SMS","title":"Create API Key - Trackly SMS","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-15T23:46:07.983Z","originalFileLocation":"api-reference/v2/accounts/create-api-key.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Mint a scoped API key for a child account. The plaintext key is returned exactly once.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Trackly SMS\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/trackly/c-1xunGpYsfIbfFy/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/trackly/c-1xunGpYsfIbfFy/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/trackly/c-1xunGpYsfIbfFy/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/trackly/c-1xunGpYsfIbfFy/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/trackly/c-1xunGpYsfIbfFy/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/trackly/c-1xunGpYsfIbfFy/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/trackly/c-1xunGpYsfIbfFy/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/trackly/c-1xunGpYsfIbfFy/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/trackly/c-1xunGpYsfIbfFy/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create API Key - Trackly SMS\">\u003cmeta data-mint-head property=\"og:description\" content=\"Mint a scoped API key for a child account. The plaintext key is returned exactly once.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Trackly SMS\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.tracklysms.com/api-reference/v2/accounts/create-api-key\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://trackly.mintlify.site/_mintlify/api/og/v2?division=Partner+Accounts+%28v2%29\u0026amp;title=Create+API+Key\u0026amp;description=Mint+a+scoped+API+key+for+a+child+account.+The+plaintext+key+is+returned+exactly+once.\u0026amp;theme=bb44b2f671ef6b99ad7abecb\u0026amp;signature=c7c0af75cf8ed1d4f7b8d068a1027951aeedc570fcd2ada14126a652b22ee530\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create API Key - Trackly SMS\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Mint a scoped API key for a child account. The plaintext key is returned exactly once.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://trackly.mintlify.site/_mintlify/api/og/v2?division=Partner+Accounts+%28v2%29\u0026amp;title=Create+API+Key\u0026amp;description=Mint+a+scoped+API+key+for+a+child+account.+The+plaintext+key+is+returned+exactly+once.\u0026amp;theme=bb44b2f671ef6b99ad7abecb\u0026amp;signature=c7c0af75cf8ed1d4f7b8d068a1027951aeedc570fcd2ada14126a652b22ee530\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/trackly/c-1xunGpYsfIbfFy/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Trackly SMS\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#84DE4D\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.tracklysms.com/api-reference/v2/accounts/create-api-key\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/v2/accounts/create-api-key.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.tracklysms.com/#organization\",\"name\":\"Trackly SMS\",\"url\":\"https://docs.tracklysms.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/trackly/m198FBazwIseN-2r/images/logo-light.svg?fit=max\u0026auto=format\u0026n=m198FBazwIseN-2r\u0026q=85\u0026s=675b2c397e9309f5fea1d36c1f87c412\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.tracklysms.com#website\",\"name\":\"Trackly SMS\",\"url\":\"https://docs.tracklysms.com\",\"publisher\":{\"@id\":\"https://docs.tracklysms.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.tracklysms.com/api-reference/v2/accounts/create-api-key#webpage\",\"url\":\"https://docs.tracklysms.com/api-reference/v2/accounts/create-api-key\",\"name\":\"Create API Key\",\"description\":\"Mint a scoped API key for a child account. The plaintext key is returned exactly once.\",\"dateModified\":\"2026-11-15T23:46:07.983Z\",\"isPartOf\":{\"@id\":\"https://docs.tracklysms.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.tracklysms.com/api-reference/v2/accounts/create-api-key#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.tracklysms.com/api-reference/v2/accounts/create-api-key#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Partner Accounts (v2)\",\"item\":\"https://docs.tracklysms.com/api-reference/v2/accounts/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create API Key\",\"item\":\"https://docs.tracklysms.com/api-reference/v2/accounts/create-api-key\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.tracklysms.com/api-reference/v2/accounts/create-api-key#apireference\",\"headline\":\"Create API Key\",\"name\":\"Create API Key\",\"description\":\"Mint a scoped API key for a child account. The plaintext key is returned exactly once.\",\"url\":\"https://docs.tracklysms.com/api-reference/v2/accounts/create-api-key\",\"mainEntityOfPage\":{\"@id\":\"https://docs.tracklysms.com/api-reference/v2/accounts/create-api-key#webpage\"},\"dateModified\":\"2026-11-15T23:46:07.983Z\",\"publisher\":{\"@id\":\"https://docs.tracklysms.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.tracklysms.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Trackly SMS\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Trackly SMS\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/v2/accounts/create-api-key.md","siteName":"Trackly SMS","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"title":"API Overview","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"}]},{"group":"V2 API Reference","pages":[{"title":"V2 API Overview","href":"/api-reference/v2/overview"},{"title":"Partner API Overview","href":"/api-reference/v2/partner-api-overview"},{"title":"Error Codes","href":"/api-reference/v2/error-codes"},{"title":"API Limits \u0026 Best Practices","href":"/api-reference/v2/rate-limiting"},{"title":"Idempotency","href":"/api-reference/v2/idempotency"},{"title":"Sandbox \u0026 Testing","href":"/api-reference/v2/sandbox"},{"title":"Who Am I","api":"GET /v2/auth/whoami","href":"/api-reference/v2/auth/whoami"},{"title":"Agent Setup Status","api":"GET /v2/agent/setup","href":"/api-reference/v2/auth/agent-setup"},{"title":"Delegated OAuth for REST Agents","href":"/api-reference/v2/auth/delegated-oauth"},{"title":"Pause Own Key","api":"POST /v2/auth/api-keys/self/pause","href":"/api-reference/v2/auth/pause"},{"title":"V1 to V2 Migration Guide","href":"/api-reference/v2/migration-guide"}]},{"group":"Agent Account Setup (v2)","pages":[{"title":"Start Agent Account Setup","api":"POST /v2/agent-onboarding","href":"/api-reference/v2/agent-onboarding/create"},{"title":"Get Agent Setup Status","api":"GET /v2/agent-onboarding/{intent_id}","href":"/api-reference/v2/agent-onboarding/get"}]},{"group":"Agent Number Registration (v2)","pages":[{"title":"Prepare SMS Number Registration","api":"POST /v2/agent/number-requests","href":"/api-reference/v2/agent-number-requests/create"},{"title":"Read SMS Number Registration","api":"GET /v2/agent/number-requests/{request_id}","href":"/api-reference/v2/agent-number-requests/get"},{"title":"Update SMS Number Registration","api":"PATCH /v2/agent/number-requests/{request_id}","href":"/api-reference/v2/agent-number-requests/update"},{"title":"Generate Private SMS Registration Preview","api":"POST /v2/agent/number-requests/{request_id}/preview","href":"/api-reference/v2/agent-number-requests/preview"}]},{"group":"Pending Sends (v2)","pages":[{"title":"Hold a Send for Approval","api":"POST /v2/pending-sends","href":"/api-reference/v2/pending-sends/create"},{"title":"List Pending Sends","api":"GET /v2/pending-sends","href":"/api-reference/v2/pending-sends/list"},{"title":"Get a Pending Send","api":"GET /v2/pending-sends/{id}","href":"/api-reference/v2/pending-sends/get"},{"title":"Cancel a Pending Send","api":"DELETE /v2/pending-sends/{id}","href":"/api-reference/v2/pending-sends/cancel"},{"title":"Send an Approved Send","api":"POST /v2/pending-sends/{id}/send","href":"/api-reference/v2/pending-sends/send"}]},{"group":"Partner Accounts (v2)","pages":[{"title":"Accounts \u0026 Hierarchy","href":"/api-reference/v2/accounts/overview"},{"title":"Create Child Account","api":"POST /v2/accounts/children","href":"/api-reference/v2/accounts/create-child"},{"title":"List Child Accounts","api":"GET /v2/accounts/children","href":"/api-reference/v2/accounts/list-children"},{"title":"Get Child Account","api":"GET /v2/accounts/children/{child_id}","href":"/api-reference/v2/accounts/get-child"},{"title":"Update Child Account","api":"PATCH /v2/accounts/children/{child_id}","href":"/api-reference/v2/accounts/update-child"},{"title":"Suspend Child Account","api":"POST /v2/accounts/children/{child_id}/suspend","href":"/api-reference/v2/accounts/suspend-child"},{"title":"Reactivate Child Account","api":"POST /v2/accounts/children/{child_id}/reactivate","description":"Resume a suspended child account — its API keys authenticate again.","href":"/api-reference/v2/accounts/reactivate-child"},{"title":"Create API Key","api":"POST /v2/accounts/children/{child_id}/api-keys","href":"/api-reference/v2/accounts/create-api-key"},{"title":"List API Keys","api":"GET /v2/accounts/children/{child_id}/api-keys","description":"List a child's API keys. Key values are masked.","href":"/api-reference/v2/accounts/list-api-keys"},{"title":"Rotate API Key","api":"POST /v2/accounts/children/{child_id}/api-keys/{key_id}/rotate","href":"/api-reference/v2/accounts/rotate-api-key"},{"title":"Revoke API Key","api":"POST /v2/accounts/children/{child_id}/api-keys/{key_id}/revoke","href":"/api-reference/v2/accounts/revoke-api-key"}]},{"group":"Trial SMS (v2)","pages":[{"title":"Trial Status","api":"GET /v2/trial","href":"/api-reference/v2/trial/status"},{"title":"Trial Testing Groups","href":"/api-reference/v2/trial/groups"}]},{"group":"Messages (v2)","pages":[{"title":"Send Single Message","api":"POST /v2/send","href":"/api-reference/v2/messages/send-single"},{"title":"Send Bulk Messages","api":"POST /v2/send/bulk","href":"/api-reference/v2/messages/send-bulk"},{"title":"Send Raw Single Message","api":"POST /v2/send-raw","href":"/api-reference/v2/messages/send-raw-single"},{"title":"Send Raw Bulk Messages","api":"POST /v2/send-raw/bulk","href":"/api-reference/v2/messages/send-raw-bulk"},{"title":"Preflight a Send","api":"POST /v2/messages/preflight","href":"/api-reference/v2/messages/preflight"},{"title":"List Messages","api":"GET /v2/messages","href":"/api-reference/v2/messages/list-messages"},{"title":"Get Message","api":"GET /v2/messages/{messageId}","href":"/api-reference/v2/messages/get-message"},{"title":"Reconciliation","href":"/api-reference/v2/messages/reconciliation"}]},{"group":"Contacts (v2)","pages":[{"title":"List Contacts","api":"GET /v2/contacts","href":"/api-reference/v2/contacts/list-contacts"},{"title":"Create Contact","api":"POST /v2/contacts","href":"/api-reference/v2/contacts/create-contact"},{"title":"Update Contact","api":"PUT /v2/contacts","href":"/api-reference/v2/contacts/update-contact"},{"title":"Bulk Create Contacts","api":"POST /v2/contacts/bulk","href":"/api-reference/v2/contacts/bulk-create"},{"title":"Get Contact","api":"GET /v2/contacts/{phone_number}","href":"/api-reference/v2/contacts/get-contact"},{"title":"Delete Contact","api":"DELETE /v2/contacts","href":"/api-reference/v2/contacts/delete-contact"},{"title":"Resubscribe Contact","api":"POST /v2/contacts/resubscribe","href":"/api-reference/v2/contacts/resubscribe"}]},{"group":"Lists (v2)","pages":[{"title":"List All Sending Lists","api":"GET /v2/lists","href":"/api-reference/v2/lists/list-all"},{"title":"Get a Sending List","api":"GET /v2/lists/{list_id}","href":"/api-reference/v2/lists/get-list"},{"title":"Check RCS Reachability","api":"POST /v2/lists/{list_id}/rcs-capability-check","href":"/api-reference/v2/lists/rcs-capability-check"}]},{"group":"Number Requests (v2)","pages":[{"title":"List Number Requests","api":"GET /v2/number-requests","href":"/api-reference/v2/number-requests/list-all"},{"title":"Create Number Draft","api":"POST /v2/number-requests/drafts","href":"/api-reference/v2/number-requests/create-draft"},{"title":"Confirm Business for Number Request","api":"PUT /v2/number-requests/{request_id}/business","href":"/api-reference/v2/number-requests/confirm-business"},{"title":"Submit Number Draft","api":"POST /v2/number-requests/{request_id}/submit","href":"/api-reference/v2/number-requests/submit-draft"},{"title":"Create Number Request","api":"POST /v2/number-requests","href":"/api-reference/v2/number-requests/create-request"},{"title":"Get Number Request","api":"GET /v2/number-requests/{request_id}","href":"/api-reference/v2/number-requests/get-request"},{"title":"Get Registration Readiness","api":"GET /v2/number-requests/{request_id}/readiness","href":"/api-reference/v2/number-requests/get-readiness"},{"title":"Recheck Registration Readiness","api":"POST /v2/number-requests/{request_id}/readiness","href":"/api-reference/v2/number-requests/recheck-readiness"},{"title":"Get Registration Attempt History","api":"GET /v2/number-requests/{request_id}/readiness/history","href":"/api-reference/v2/number-requests/readiness-history"},{"title":"Update Number Request","api":"PATCH /v2/number-requests/{request_id}","href":"/api-reference/v2/number-requests/update-request"},{"title":"Look Up International Requirements","api":"GET /v2/number-requests/international-requirements","href":"/api-reference/v2/number-requests/lookup-requirements"},{"title":"Get International Requirements","api":"GET /v2/number-requests/{request_id}/international-requirements","href":"/api-reference/v2/number-requests/get-requirements"},{"title":"Update International Requirements","api":"PATCH /v2/number-requests/{request_id}/international-requirements","href":"/api-reference/v2/number-requests/update-requirements"},{"title":"Correct Resource Request","api":"POST /v2/number-requests/{request_id}/correction","href":"/api-reference/v2/number-requests/correct-request"}]},{"group":"Business Verification (v2)","pages":[{"title":"Business Verification in Number Requests","href":"/api-reference/v2/business-profiles/lifecycle"},{"title":"List Business Profiles","api":"GET /v2/business-profiles","href":"/api-reference/v2/business-profiles/list-all"},{"title":"Get Business Profile","api":"GET /v2/business-profiles/{profile_id}","href":"/api-reference/v2/business-profiles/get-profile"},{"title":"Create Business Profile","api":"POST /v2/business-profiles","href":"/api-reference/v2/business-profiles/create-profile"},{"title":"Validate Business Profile","api":"POST /v2/business-profiles/validate","href":"/api-reference/v2/business-profiles/validate-profile"},{"title":"Update Business Profile","api":"PATCH /v2/business-profiles/{profile_id}","href":"/api-reference/v2/business-profiles/update-profile"},{"title":"Dispute Suggested Business Name","api":"POST /v2/business-profiles/{profile_id}/dispute","href":"/api-reference/v2/business-profiles/dispute-profile"},{"title":"Renew Business Verification","api":"POST /v2/business-profiles/{profile_id}/verification","href":"/api-reference/v2/business-profiles/renew-verification"},{"title":"List Verification Submissions","api":"GET /v2/business-profiles/{profile_id}/submissions","href":"/api-reference/v2/business-profiles/list-submissions"},{"title":"Upload Supporting Document","api":"POST /v2/business-profiles/{profile_id}/documents","href":"/api-reference/v2/business-profiles/upload-document"},{"title":"List Supporting Documents","api":"GET /v2/business-profiles/{profile_id}/documents","href":"/api-reference/v2/business-profiles/list-documents"},{"title":"Download Supporting Document","api":"GET /v2/business-profiles/{profile_id}/documents/{doc_id}","href":"/api-reference/v2/business-profiles/download-document"},{"title":"Delete Supporting Document","api":"DELETE /v2/business-profiles/{profile_id}/documents/{doc_id}","href":"/api-reference/v2/business-profiles/delete-document"}]},{"group":"Creatives (v2)","pages":[{"title":"List All Creatives","api":"GET /v2/creatives","href":"/api-reference/v2/creatives/list-creatives"},{"title":"Create a Creative","api":"POST /v2/creatives","href":"/api-reference/v2/creatives/create-creative"},{"title":"Get a Creative","api":"GET /v2/creatives/{id}","href":"/api-reference/v2/creatives/get-creative"},{"title":"Update a Creative","api":"PUT /v2/creatives/{id}","href":"/api-reference/v2/creatives/update-creative"},{"title":"Delete a Creative","api":"DELETE /v2/creatives/{id}","href":"/api-reference/v2/creatives/delete-creative"}]},{"group":"Audiences (v2)","pages":[{"title":"List Audiences","api":"GET /v2/audiences","href":"/api-reference/v2/audiences/list-audiences"},{"title":"Create Audience","api":"POST /v2/audiences","href":"/api-reference/v2/audiences/create-audience"},{"title":"Get Audience","api":"GET /v2/audiences/{id}","href":"/api-reference/v2/audiences/get-audience"},{"title":"Update Audience","api":"PUT /v2/audiences/{id}","href":"/api-reference/v2/audiences/update-audience"},{"title":"Delete Audience","api":"DELETE /v2/audiences/{id}","href":"/api-reference/v2/audiences/delete-audience"},{"title":"Get Audience Size","api":"GET /v2/audiences/{id}/size","href":"/api-reference/v2/audiences/get-audience-size"},{"title":"Audience Filter DSL","href":"/api-reference/v2/audience-filter-dsl"}]},{"group":"Offers (v2)","pages":[{"title":"List Offers","api":"GET /v2/offers","href":"/api-reference/v2/offers/list-offers"},{"title":"Create Offer","api":"POST /v2/offers","href":"/api-reference/v2/offers/create-offer"},{"title":"Get Offer","api":"GET /v2/offers/{id}","href":"/api-reference/v2/offers/get-offer"},{"title":"Update Offer","api":"PUT /v2/offers/{id}","href":"/api-reference/v2/offers/update-offer"},{"title":"Delete Offer","api":"DELETE /v2/offers/{id}","href":"/api-reference/v2/offers/delete-offer"}]},{"group":"Schedules (v2)","pages":[{"title":"List Schedules","api":"GET /v2/schedules","href":"/api-reference/v2/schedules/list-schedules"},{"title":"Create Schedule or Blast","api":"POST /v2/schedules","href":"/api-reference/v2/schedules/create-schedule"},{"title":"Get Schedule","api":"GET /v2/schedules/{id}","href":"/api-reference/v2/schedules/get-schedule"},{"title":"Update Schedule","api":"PUT /v2/schedules/{id}","href":"/api-reference/v2/schedules/update-schedule"},{"title":"Delete Schedule","api":"DELETE /v2/schedules/{id}","href":"/api-reference/v2/schedules/delete-schedule"}]},{"group":"Journeys (v2)","pages":[{"title":"List Journeys","api":"GET /v2/journeys","href":"/api-reference/v2/journeys/list-journeys"},{"title":"Create Journey","api":"POST /v2/journeys","href":"/api-reference/v2/journeys/create-journey"},{"title":"Get Journey","api":"GET /v2/journeys/{journey_id}","href":"/api-reference/v2/journeys/get-journey"},{"title":"Update Journey","api":"PUT /v2/journeys/{journey_id}","href":"/api-reference/v2/journeys/update-journey"},{"title":"Archive Journey","api":"DELETE /v2/journeys/{journey_id}","href":"/api-reference/v2/journeys/delete-journey"},{"title":"Update Journey Status","api":"PUT /v2/journeys/{journey_id}/status","href":"/api-reference/v2/journeys/update-journey-status"},{"title":"Duplicate Journey","api":"POST /v2/journeys/{journey_id}/duplicate","href":"/api-reference/v2/journeys/duplicate-journey"},{"title":"Get Journey Options","api":"GET /v2/journeys/options","href":"/api-reference/v2/journeys/get-journey-options"},{"title":"Refresh Custom Fields","api":"POST /v2/journeys/refresh-custom-fields","href":"/api-reference/v2/journeys/refresh-custom-fields"},{"title":"Get Journey Statistics","api":"GET /v2/journeys/{journey_id}/stats","href":"/api-reference/v2/journeys/get-journey-stats"}]},{"group":"Revenue (v2)","pages":[{"title":"Record Revenue","api":"POST /v2/revenue","href":"/api-reference/v2/revenue/record-revenue"},{"title":"Bulk Record Revenue","api":"POST /v2/revenue/bulk","href":"/api-reference/v2/revenue/bulk-revenue"}]},{"group":"Usage \u0026 Billing (v2)","pages":[{"title":"Get Current Balance","api":"GET /v2/billing/balance","href":"/api-reference/v2/usage/billing-balance"},{"title":"Usage Summary","api":"GET /v2/usage/summary","href":"/api-reference/v2/usage/usage-summary"},{"title":"List Billing Records","api":"GET /v2/billing/records","href":"/api-reference/v2/usage/billing-records"},{"title":"Get Billing Statement","api":"GET /v2/billing/statements/{period}","href":"/api-reference/v2/usage/billing-statements"}]},{"group":"Data Import (v2)","pages":[{"title":"Import Send History","api":"POST /v2/history/sends","href":"/api-reference/v2/history/import-sends"},{"title":"Import Click History","api":"POST /v2/history/clicks","href":"/api-reference/v2/history/import-clicks"},{"title":"Import Revenue History","api":"POST /v2/history/revenue","href":"/api-reference/v2/history/import-revenue"},{"title":"Clear History","api":"DELETE /v2/history/clear","href":"/api-reference/v2/history/clear-history"}]},{"group":"Links (v2)","pages":[{"title":"Create Link","api":"POST /v2/links","href":"/api-reference/v2/links/create-link"},{"title":"Shorten Link","api":"POST /v2/links/shorten","href":"/api-reference/v2/links/shorten-link"}]},{"group":"Clicks (v2)","pages":[{"title":"List Click Evidence","api":"GET /v2/clicks","href":"/api-reference/v2/clicks/list-clicks"}]},{"group":"Webhooks (v2)","pages":[{"title":"Webhook Events","href":"/api-reference/v2/webhooks/events"},{"title":"Webhook Signing \u0026 Verification","href":"/api-reference/v2/webhooks/signing"},{"title":"Create Webhook Endpoint","api":"POST /v2/webhooks","href":"/api-reference/v2/webhooks/create-endpoint"},{"title":"List Webhook Endpoints","api":"GET /v2/webhooks","href":"/api-reference/v2/webhooks/list-endpoints"},{"title":"Get Webhook Endpoint","api":"GET /v2/webhooks/{endpoint_id}","href":"/api-reference/v2/webhooks/get-endpoint"},{"title":"Update Webhook Endpoint","api":"PATCH /v2/webhooks/{endpoint_id}","href":"/api-reference/v2/webhooks/update-endpoint"},{"title":"Delete Webhook Endpoint","api":"DELETE /v2/webhooks/{endpoint_id}","href":"/api-reference/v2/webhooks/delete-endpoint"},{"title":"Rotate Signing Secret","api":"POST /v2/webhooks/{endpoint_id}/rotate-secret","href":"/api-reference/v2/webhooks/rotate-secret"},{"title":"List Deliveries","api":"GET /v2/webhooks/{endpoint_id}/deliveries","href":"/api-reference/v2/webhooks/list-deliveries"},{"title":"Replay a Delivery","api":"POST /v2/webhooks/deliveries/{delivery_id}/replay","href":"/api-reference/v2/webhooks/replay-delivery"},{"title":"Bulk Replay Deliveries","api":"POST /v2/webhooks/deliveries/replay","href":"/api-reference/v2/webhooks/bulk-replay"}]},{"group":"Phone Validation (v1)","pages":[{"title":"Validate Phone Number","api":"POST /v1/phone/validate","href":"/api-reference/phone/validate"},{"title":"Validate Phone Numbers (Batch)","api":"POST /v1/phone/validate/batch","href":"/api-reference/phone/batch-validate"}]},{"group":"Voice Calls (v1)","pages":[{"title":"Start calling with Trackly","href":"/api-reference/voice/get-started"},{"title":"Connect Your Salesforce Dialer","href":"/api-reference/voice/salesforce"},{"title":"Salesforce Integration Reference","href":"/api-reference/voice/salesforce-configuration"},{"title":"Voice Calls API Overview","href":"/api-reference/voice/overview"},{"title":"Queue Webhooks","href":"/api-reference/voice/webhooks"},{"title":"List Calling Numbers","api":"GET /v1/voice/calling-numbers","href":"/api-reference/voice/numbers/list-calling-numbers"},{"title":"Search Calling Numbers","api":"POST /v1/voice/calling-numbers/search","href":"/api-reference/voice/numbers/search-calling-numbers"},{"title":"Quote a Calling Number","api":"POST /v1/voice/calling-numbers/quote","href":"/api-reference/voice/numbers/quote-calling-number"},{"title":"Acquire a Calling Number","api":"POST /v1/voice/number-acquisitions","href":"/api-reference/voice/numbers/acquire-calling-number"},{"title":"Get a Number Acquisition","api":"GET /v1/voice/number-acquisitions/{operationId}","href":"/api-reference/voice/numbers/get-number-acquisition"},{"title":"Record a Voice Opt-Out","api":"POST /v1/voice/opt-outs","href":"/api-reference/voice/record-opt-out"},{"title":"Screen a Calling Recipient","api":"POST /v1/voice/recipient-screenings","href":"/api-reference/voice/recipient-screening"},{"title":"Place a Call","api":"POST /v1/voice/calls","href":"/api-reference/voice/calls/place-call"},{"title":"List Calls","api":"GET /v1/voice/calls","href":"/api-reference/voice/calls/list-calls"},{"title":"Get a Call","api":"GET /v1/voice/calls/{callId}","href":"/api-reference/voice/calls/get-call"},{"title":"Answer a Call","api":"POST /v1/voice/calls/{callId}/answer","href":"/api-reference/voice/calls/answer-call"},{"title":"Hang Up a Call","api":"POST /v1/voice/calls/{callId}/hangup","href":"/api-reference/voice/calls/hangup-call"},{"title":"Monitor a Call","api":"POST /v1/voice/calls/{callId}/monitor","href":"/api-reference/voice/calls/monitor-call"},{"title":"Browser Sessions","href":"/api-reference/voice/calls/browser-sessions"},{"title":"Browser Calls","href":"/api-reference/voice/calls/browser-calls"},{"title":"Listen to a Call in the Browser","href":"/api-reference/voice/calls/browser-monitor"},{"title":"Hold, Resume, and Transfer a Browser Call","href":"/api-reference/voice/calls/browser-call-controls"},{"title":"Choose Call Listeners","href":"/api-reference/voice/monitor-grants"},{"title":"Start Recording","api":"POST /v1/voice/calls/{callId}/recording/start","href":"/api-reference/voice/calls/start-recording"},{"title":"Stop Recording","api":"POST /v1/voice/calls/{callId}/recording/stop","href":"/api-reference/voice/calls/stop-recording"},{"title":"List Recordings","api":"GET /v1/voice/calls/{callId}/recording","href":"/api-reference/voice/calls/list-recordings"},{"title":"Download a Recording File","api":"GET /v1/voice/calls/{callId}/recording/files/{fileId}","href":"/api-reference/voice/calls/download-recording"},{"title":"Create a Queue","api":"POST /v1/voice/queues","href":"/api-reference/voice/queues/create-queue"},{"title":"List Queues","api":"GET /v1/voice/queues","href":"/api-reference/voice/queues/list-queues"},{"title":"Get a Queue","api":"GET /v1/voice/queues/{queueId}","href":"/api-reference/voice/queues/get-queue"},{"title":"Dequeue a Call","api":"POST /v1/voice/queues/{queueId}/dequeue","href":"/api-reference/voice/queues/dequeue"},{"title":"Create an Agent","api":"POST /v1/voice/agents","href":"/api-reference/voice/agents/create-agent"},{"title":"List Agents","api":"GET /v1/voice/agents","href":"/api-reference/voice/agents/list-agents"}]},{"group":"API Reference (v1 - Deprecated)","pages":[{"title":"Send Single Message","api":"POST /v1/messages","href":"/api-reference/messages/send-single"},{"title":"Send Bulk Messages","api":"POST /v1/messages/bulk","href":"/api-reference/messages/send-bulk"},{"title":"List Contacts","api":"GET /v1/contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create Contact","api":"POST /v1/contacts","href":"/api-reference/contacts/create-contact"},{"title":"Get Contact","api":"GET /v1/contacts/{msisdn}","href":"/api-reference/contacts/get-contact"},{"title":"Delete Contact","api":"DELETE /v1/contacts/{msisdn}","href":"/api-reference/contacts/delete-contact"},{"title":"Error Codes","href":"/api-reference/errors"}]}]}]},{"anchor":"API Status","href":"https://status.tracklysms.com","icon":"signal"},{"anchor":"Discord","href":"https://discord.gg/trackly","icon":"discord"},{"anchor":"Changelog","icon":"list","pages":[{"title":"Changelog","href":"/resources/changelog"}]}]},"basePath":"","title":"Create API Key - Trackly SMS","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js"]}