TSG GLOBAL/Developers
Campaign Manager Sandbox

Registration drafts

Understand the feature-gated API foundation for toll-free, short code, and RCS registration drafts.

Sandbox environment

Brand and campaign submissions are simulated. Nothing reaches The Campaign Registry and no carrier charges are incurred. Use credentials issued for this environment.

Check availability

This is a feature-gated scaffold, not a live registration service. First call GET /registration-capabilities. It reports whether the scaffold is enabled and the current foundation requirements for toll_free, short_code and rcs_agent. Provider-specific fields, contracts, fees and approval routes still need confirmation. No TCR brand verification gate applies to these types.

Draft and review lifecycle

  1. Create a draft with POST /registrations, a unique Idempotency-Key, a type, provider_mode (manual or sandbox), and type-specific details. The example below is intentionally a partial draft.
  2. Save its ref and revision. Edit using PATCH /registrations/{ref} with expected_revision. A stale revision returns 409; read the current record before retrying.
  3. Call POST /registrations/{ref}/validate to see missing foundation requirements. Add HTTPS evidence references; files are not uploaded or fetched by this scaffold.
  4. Request review with /request-review. A reviewer can return it with /request-revision and a reason, or approve the exact revision with /approve. These actions require expected_revision.
  5. In sandbox mode, an authorized submitter can call /submit with expected_revision and an Idempotency-Key. It returns 202 and an operation reference. The result explicitly says simulated=true and external_submitted=false. No provider is contacted.
  6. Manual mode returns 409 manual_handoff_required; it does not claim to have performed a handoff. Internal approval never means provider or carrier readiness. Use /events for revision history and GET /registration-operations/{ref} for the simulation result.
HTTP request
POST /registrations
Idempotency-Key: <unique-request-id>
{
  "type": "toll_free", "provider_mode": "sandbox",
  "details": {
    "country": "US", "business_name": "Example Business",
    "numbers": ["+18005550123"]
  }
}

Registration creation and sandbox submission replay the original result for the same company, key and body; a changed body returns 409. Lists accept limit (1–100), an opaque cursor, and optional registration_type. The response's next cursor drives the next page.