We use cookies to give you the best possible experience while you browse through our site. By continuing to use our website you implicitly agree to the usage of cookies on this site.

Read More

Complete reference

Atlas API & Provisioning Reference

Every customer-facing Atlas API — messaging, telecom data, ordering and provisioning, webhooks, CDR delivery, and account management — generated from the Atlas OpenAPI spec and split into 35 chapters. Updated 2026-08-12. Every section heading below is a stable deep link.

  1. 01Introduction
  2. 02Your Resources

    Account · DID · Switch · Messaging Auto Responses · Role · User · API Key · Bulk Dip Tasks · CSP · Shared Resource Groups

  3. 03API

    Pagination Parameters · Common Parameters · Paths

  4. 04Number Inventory
  5. 05Ordering System Reference

    Ordering Overview · Carts

  6. 06Cart Requests

    Schema · API · Request Types

  7. 07Cart Request Documents

    Schema · API

  8. 08Orders

    Schema · API

  9. 09Requests

    Schema · API · Request Types

  10. 10Request Documents

    Schema · API

  11. 11Request Provision Records

    Schema · API

  12. 12Roles

    Schema · Summary · API

  13. 13Users

    Schema · Summary · API

  14. 14API Keys

    Schema · Summary · Where are my secrets? · API

  15. 15Bulk Dip Tasks

    Schema · Summary · API · Webhook Integration

  16. 16Call Data Webhooks

    Schema · Summary · API · Webhook

  17. 17Secret Keys

    Schema · Summary · Where are my secrets? · API

  18. 18Switches

    Schema · Summary · API · Components

  19. 19Messaging Auto Responses

    Schema · Summary · API

  20. 20DIDs

    Schema · Summary · API

  21. 21Number Management

    Toggling MMS on an existing number

  22. 22DID Destinations

    Schema · Summary · Types · API

  23. 23DID - Optout Items

    Schema · Summary · API

  24. 24OSR Overwrite Requests

    Schema · Summary · API

  25. 25CSP Enums

    Schemas · API

  26. 26CSP Brands

    Schema · API

  27. 27CSP Campaigns

    Schema · API

  28. 28CSP - Campaign - Optout Items

    Schema · Summary · API

  29. 29Shared Resource Groups

    Schema · Summary · API · Shared Resource Groups - Notes

  30. 30Event Subscriptions

    Schema · Summary · API

  31. 31Events

    Schema · Request · Types

  32. 32SMPP

    Supported TLVs

  33. 33Schemas

    Schema / AddonsData · Schema / ApiKey · Schema / ApiKeyResponse · Schema / ApiKeysResponse · Schema / AttachSwitchMmsEncryptionKeyData · Schema / AttachSwitchMmsEncryptionKeyRequest · Schema / AttachSwitchMmsSigningKeyData · Schema / AttachSwitchMmsSigningKeyRequest · Schema / AttachSwitchSmsEncryptionKeyData · Schema / AttachSwitchSmsEncryptionKeyRequest · Schema / AttachSwitchSmsSigningKeyData · Schema / AttachSwitchSmsSigningKeyRequest · Schema / BulkDipTask · Schema / BulkDipTaskResponse · Schema / BulkDipTasksResponse · Schema / CDR · Schema / CDRFee · Schema / CDRLookupResultResponse · Schema / CDRResponse · Schema / CDRSurcharge · Schema / CDRsResponse · Schema / CSPCampaignOptoutItem · Schema / CSPCampaignOptoutItemResponse · Schema / CSPCampaignOptoutItemsResponse · Schema / CallDataWebhook · Schema / CallDataWebhookResponse · Schema / CallDataWebhooksResponse · Schema / Cart · Schema / CartRequest · Schema / CartRequestAddCampaignNumbersData · Schema / CartRequestAddMessagingNumbersData · Schema / CartRequestAddVoiceNumbersData · Schema / CartRequestNewNumbersData · Schema / CartRequestRegisterBrandData · Schema / CartRequestRegisterCampaignData · Schema / CartRequestRemoveCampaignNumbersData · Schema / CartRequestRemoveMessagingNumbersData · Schema / CartRequestRemoveNumbersData · Schema / CartRequestRemoveVoiceNumbersData · Schema / CartRequestResponse · Schema / CartRequestUnregisterBrandData · Schema / CartRequestUnregisterCampaignData · Schema / CartRequestVetBrandData · Schema / CartRequestsResponse · Schema / CartResponse · Schema / CartsResponse · Schema / CreateApiKeyData · Schema / CreateApiKeyRequest · Schema / CreateApiKeyResponse · Schema / CreateBulkDipTaskData · Schema / CreateBulkDipTaskRequest · Schema / CreateCallDataWebhookData · Schema / CreateCallDataWebhookRequest · Schema / CreateCartData · Schema / CreateCartRequest · Schema / CreateCartRequestData · Schema / CreateCartRequestRequest · Schema / CreateDestinationRequest · Schema / CreateExportTaskData · Schema / CreateExportTaskRequest · Schema / CreateMessageRequest · Schema / CreateMessageSetRequest · Schema / CreateOnDoneAction · Schema / CreateOnDoneActions · Schema / CreateOptoutItemData · Schema / CreateOptoutItemRequest · Schema / CreateRequestDocumentRequest · Schema / CreateRoleData · Schema / CreateRoleRequest · Schema / CreateSecretKeyData · Schema / CreateSecretKeyRequest · Schema / CreateSecretKeyResponse · Schema / CreateSwitchRequest · Schema / CreateUserData · Schema / CreateUserRequest · Schema / CreatedApiKey · Schema / CreatedSecretKey · Schema / CspAltBusinessIdTypeResponse · Schema / CspBrand · Schema / CspBrandRelationshipsResponse · Schema / CspBrandResponse · Schema / CspBrandsResponse · Schema / CspCampaign · Schema / CspCampaignResponse · Schema / CspCampaignSharingConflictErrorsObject · Schema / CspCampaignSharingConflictErrorsResponse · Schema / CspCampaignStatusesResponse · Schema / CspCampaignUnsharingConflictErrorsObject · Schema / CspCampaignUnsharingConflictErrorsResponse · Schema / CspCampaignsResponse · Schema / CspCnpsResponse · Schema / CspDcasResponse · Schema / CspEntityTypesResponse · Schema / CspErrorCodesResponse · Schema / CspEventCategoriesResponse · Schema / CspMnoOperationStatusesResponse · Schema / CspMnosResponse · Schema / CspStockExchangesResponse · Schema / CspUsecase · Schema / CspUsecasesResponse · Schema / CspVertical · Schema / CspVerticalsResponse · Schema / CspVettingClass · Schema / CspVettingClassesResponse · Schema / CspVettingFeedbackCode · Schema / CspVettingFeedbackCodesResponse · Schema / CspVettingProvider · Schema / CspVettingProvidersResponse · Schema / Destination · Schema / DestinationResponse · Schema / DestinationsResponse · Schema / ErrorObject · Schema / ErrorsResponse · Schema / EventSubscription · Schema / EventSubscriptionResponse · Schema / EventSubscriptionsResponse · Schema / ExportTask · Schema / ExportTaskResponse · Schema / ExportTasksResponse · Schema / FileResponse · Schema / Message · Schema / MessageResponse · Schema / MessageSet · Schema / MessageSetResponse · Schema / MessageSetsResponse · Schema / MessagesResponse · Schema / MessagingAutoResponse · Schema / MessagingAutoResponseResponse · Schema / MessagingAutoResponsesResponse · Schema / Number · Schema / NumberClientSuspension · Schema / NumberClientSuspensionResponse · Schema / NumberClientSuspensionsResponse · Schema / NumberInventoryCoverage · Schema / NumberInventoryCoverageResponse · Schema / NumberResponse · Schema / NumbersResponse · Schema / OnDoneAction · Schema / OnDoneActions · Schema / OptoutItem · Schema / OptoutItemResponse · Schema / OptoutItemsResponse · Schema / Order · Schema / OrderErrorCode · Schema / OrderResponse · Schema / OrderStatus · Schema / OrdersResponse · Schema / OverwriteRequest · Schema / OverwriteRequestResponse · Schema / OverwriteRequestsResponse · Schema / PageInfo · Schema / PermissionErrorObject · Schema / PermissionErrorsResponse · Schema / Request · Schema / RequestAddCampaignNumbersData · Schema / RequestAddMessagingNumbersData · Schema / RequestAddVoiceNumbersData · Schema / RequestDocument · Schema / RequestDocumentResponse · Schema / RequestDocumentsResponse · Schema / RequestNewNumbersData · Schema / RequestProvisionRecord · Schema / RequestProvisionRecordErrorCode · Upstream Errors · System Errors · Manual Errors or Flags · Schema / RequestProvisionRecordResponse · Schema / RequestProvisionRecordStatus · Schema / RequestProvisionRecordsResponse · Schema / RequestRegisterBrandData · Schema / RequestRegisterCampaignData · Schema / RequestRemoveCampaignNumbersData · Schema / RequestRemoveMessagingNumbersData · Schema / RequestRemoveNumbersData · Schema / RequestRemoveVoiceNumbersData · Schema / RequestResponse · Schema / RequestType · Schema / RequestUnregisterBrandData · Schema / RequestUnregisterCampaignData · Schema / RequestVetBrandData · Schema / RequestsResponse · Schema / ResourceNotFoundErrorObject · Schema / ResourceNotFoundErrorsResponse · Schema / ReviewOverwriteRequestData · Schema / ReviewOverwriteRequestRequest · Schema / Role · Schema / RolePoliciesResponse · Schema / RolePolicy · Schema / RolePolicyResponse · Schema / RoleResponse · Schema / RolesResponse · Schema / SearchNumberInventory · Schema / SearchNumberInventoryResponse · Schema / SecretKey · Schema / SecretKeyResponse · Schema / SecretKeysResponse · Schema / SharedResourceGroup · Schema / SharedResourceGroupResponse · Schema / SharedResourceGroupsResponse · Schema / Switch · Schema / SwitchEncryptionMethod · Schema / SwitchResponse · Schema / SwitchSigningHash · SMS Signature Versions · MMS Signature Versions · Schema / SwitchSigningScheme · Schema / SwitchesResponse · Schema / SystemEvent · Schema / SystemEventAssociationProvisionRecord · Schema / SystemEventAssociationRequest · Schema / SystemEventDataCspCampaignOptoutItemCreated · Schema / SystemEventDataCspCampaignOptoutItemDeleted · Schema / SystemEventDataCspCampaignRegistered · Schema / SystemEventDataDidComponent · Schema / SystemEventDataDidComponentCreated · Schema / SystemEventDataDidComponentDeleted · Schema / SystemEventDataDidCreated · Schema / SystemEventDataDidCreatedReason · Schema / SystemEventDataDidDeleted · Schema / SystemEventDataDidDeletedReason · Schema / SystemEventDataDidOptoutItemCreated · Schema / SystemEventDataDidOptoutItemDeleted · Schema / SystemEventDataOrderCompleted · Schema / SystemEventDataOsrOverwriteRequestCompleted · Schema / SystemEventDataOsrOverwriteRequestPending · Schema / SystemEventDataRequestCompleted · Schema / SystemEventDataRequestCompletedDataRegisterBrand · Schema / SystemEventDataRequestCompletedDataRegisterCampaign · Schema / SystemEventTopic · Schema / SystemEventType · Schema / UpdateApiKeyData · Schema / UpdateApiKeyRequest · Schema / UpdateCallDataWebhookData · Schema / UpdateCallDataWebhookRequest · Schema / UpdateCartData · Schema / UpdateCartRequest · Schema / UpdateCartRequestData · Schema / UpdateCartRequestRequest · Schema / UpdateDestinationRequest · Schema / UpdateMessageRequest · Schema / UpdateMessageSetRequest · Schema / UpdateNumberData · Schema / UpdateNumberRequest · Schema / UpdateOrderData · Schema / UpdateOrderRequest · Schema / UpdateRoleData · Schema / UpdateRoleRequest · Schema / UpdateSecretKeyData · Schema / UpdateSecretKeyRequest · Schema / UpdateSwitchRequest · Schema / UpdateUserData · Schema / UpdateUserRequest · Schema / UpsertDestinationData · Schema / UpsertEventSubscriptionData · Schema / UpsertEventSubscriptionRequest · Schema / UpsertMessageData · Schema / UpsertMessageSetData · Schema / UpsertMessagingAutoResponseData · Schema / UpsertMessagingAutoResponseRequest · Schema / UpsertNumberClientSuspensionData · Schema / UpsertNumberClientSuspensionRequest · Schema / UpsertSwitchData · Schema / User · Schema / UserResponse · Schema / UsersResponse · Schema / Voice · Schema / VoiceResponse · Schema / VoicesResponse

  34. 34End notes
  35. 35Changelog

    2026-07-29 · 2026-07-06 · 2026-05-20 · 2025-09-21 · 2025-04-15 · 2024-10-22 · 2024-10-04 · 2023-05-23 · 2023-05-08 · 2023-01-26 · 2023-01-02 · 2022-12-16 · 2022-10-18 · 2022-02-24 · 2022-02-18 · 2021-12-31 · 2021-08-24 · 2021-08-18 · Pre 2021-08-18