Campaigns
Get a campaign
Returns a single campaign by its AgentMessage id. Unknown ids, or ids
that belong to another organization, return 404 NOT_FOUND.
Requires the campaigns:read scope.
AuthorizationBearer <token>
Authenticate by sending your API key as a bearer token:
Authorization: Bearer am_live_.... Every request is automatically
scoped to the organization that owns the key and to the scopes granted
to that key.
In: header
Path Parameters
id*string
Format
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/campaigns/497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"success": true,
"data": {
"id": "7c1f0a2d-9e8b-4c3a-9d2e-1f0a2b3c4d5e",
"org_id": "0190a1b2-c3d4-e5f6-a7b8-c9d0e1f2a3b4",
"brand_id": "6a1b2c3d-4e5f-6789-abcd-ef0123456789",
"tcr_campaign_id": "CMA1B2C3",
"status": "ACTIVE",
"usecase": "MARKETING",
"sub_usecases": [],
"message_flow": "Subscribers opt in by texting JOIN to 12345",
"embedded_link": false,
"embedded_phone": false,
"terms_and_conditions": true,
"number_pool": false,
"age_gated": false,
"direct_lending": false,
"subscriber_optin": true,
"subscriber_optout": true,
"subscriber_help": true,
"sample1": "Reply STOP to opt out, HELP for help.",
"optout_keywords": "STOP,UNSUBSCRIBE",
"help_keywords": "HELP",
"mno_metadata": {
"10017": {
"mno": "AT&T",
"mnoSupport": true,
"mnoReview": false,
"qualify": true,
"tpm": 90
}
},
"submitted_at": "2026-04-20T10:05:00Z",
"billed_date": "2026-04-21T00:00:00Z",
"expiration_date": null,
"rejection_reasons": [],
"rejected_at": null,
"created_at": "2026-04-20T10:00:00Z",
"updated_at": "2026-04-21T16:30:00Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "validation failed",
"request_id": "01JTBQH2FZ8K1RXC0WJ4Z9P3VM",
"details": {
"to": "must be E.164",
"body": "must be 1..1600 chars"
}
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "authentication failed",
"request_id": "01JTBQH2FZ8K1RXC0WJ4Z9P3VM"
}
}{
"success": false,
"error": {
"code": "FORBIDDEN",
"message": "missing required scope",
"request_id": "01JTBQH2FZ8K1RXC0WJ4Z9P3VM"
}
}{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "not found",
"request_id": "01JTBQH2FZ8K1RXC0WJ4Z9P3VM"
}
}