TSG GLOBAL/Developers
Campaign Manager Sandbox

Campaigns & review

Prepare content, submit it for review, and track the outcome. Internal review and carrier activation are separate steps.

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.

Generate an editable draft

AI draft workflow: call the generation endpoint, wait for content, show it to the customer, allow edits, then submit.

HTTP request
POST /brands/<brand-ref>/campaigns/generate
{
  "volume": "0-1000",
  "optin_method": "web_form",
  "optin_proof_url": "https://your-business.example/signup",
  "interview_responses": {
    "purpose": "Appointment reminders for customers who opt in"
  }
}

Save data.campaign.ref. Poll GET /campaigns/{ref} until generation_in_progress is false. Read the generated content, recommendations and compliance results. The API exposes both compliance_results_user from the generation workflow and compliance_summary shown on the full campaign page, with compliance_reviewed_at when recorded. Missing review values remain null. Use PATCH /campaigns/{ref} to change allowed copy fields. The draft workflow sets Low Volume Mixed, with customer care, marketing and account notifications. It is not a selectable high-volume registration product.

Submit using POST /campaigns/{ref}/submit with {}. Inspect the JSON result even when HTTP status is 200:

  • data.status = warnings_pending: show data.warnings. Only after the customer acknowledges them, repeat with {"acknowledge_warnings": true}.
  • data.status = submitted: the campaign is in pending_review. TSG review and carrier processing still follow.

Submit supplied content

Direct-content workflow: use POST /brands/{ref}/campaigns when your application supplies the campaign content. Required fields are campaign_description (at least 40 characters), use_case, expected_volume and sample1. Supply the complete consent flow and messages as well. Sole proprietors must already be verified. This call creates a pending_review campaign, queues compliance review and may register it with TNID when eligible; it does not create an editable draft.

The two endpoints use different volume values. Direct creation accepts 0-1000, 1000-10000, 10000-50000, 50000-100000, 100000+. Generation accepts 0-1000, 1001-10000, 10001-100000, 100001+. See the reference for full use-case and opt-in allowlists.

Track the outcome

Keep polling the campaign record with backoff. A typical sequence is draft → pending_review → approved/submitted, followed by separately observed provider progress. The legacy storage status active alone is not proof of deployment; use deployment and its confirmed phase in the response. A campaign may instead wait in pending_brand_verification or return as needs_revision. When revision is requested, display review_notes_summary, edit the copy and resubmit. Some carrier statuses require TSG reconciliation; a successful API call alone does not establish carrier approval.

Company admin keys or explicitly scoped staff superadmin keys can call /campaigns/{ref}/approve, /resubmit, /reconcile, /deactivate or /revise. Approval selects the Syniverse route. Check submitted_to_tcr and tnid_error in the approval result. Reconciliation records a carrier outcome confirmed outside this API.

Prepared customer review

Use GET /campaigns/{ref}/review-feedback (MCP get_campaign_review_feedback) for the exact prepared replacements, current packet ID/hash and factual question. The focused customer page is /campaigns/{ref}/review-feedback; registration editing is not required to view it. POST /campaigns/{ref}/review-feedback (MCP respond_campaign_review_feedback) accepts an authorized customer’s explicit confirmation or change request. Staff-issued keys whose actor is TSG staff cannot confirm as the customer. A confirmation applies only the exact current proposed values and returns the campaign to TSG review. If TSG has explicitly preauthorized that unchanged packet, matching customer confirmation can also queue the guarded release workflow. Read get_prepared_review_progress for the actual outcome; confirmation alone is not provider approval. A conflicting or stale response returns 409; identical replies are safe to retry. Staff prepare packets separately; preparing a packet does not send a notification.

Number pools

number_pool on campaign creation is the registry campaign attribute. Campaign responses return the saved flag through REST and MCP. Setting it to true does not allocate a pool, assign a provider pool ID/SubId, attach numbers or establish deployment. Those are separate provider operations; this API currently has no pool allocation/assignment/status endpoint. The managed Mary Kay sole proprietor template keeps this flag false. Do not reuse the setting from an unrelated pooled campaign.