get
https://production-api.shoutaboutus.com/api/v1/campaign/by-unique-code/
Get one campaign, including its channels, follow-up template, email and SMS requests, and file-header mapping — all in a single response, so you do not need follow-up calls to assemble the full picture.
Despite the path name, this endpoint takes the campaign's numeric id, not a code. A separate public endpoint accepts the alphanumeric campaign code.
Auth
- The campaign must belong to a location inside your own account. If it does not, the call returns
400rather than revealing anything about the campaign.
Rate limit
- No rate limit.
Path params
| Parameter | Type | Required | Notes |
|---|---|---|---|
campaignId | integer | Required | The campaign's numeric id. Digits only — a non-numeric value does not match this route. |
Behaviour
- 200 returns the campaign under
data, withchannels,email_requests,sms_requestsandfile_headerincluded. Each channel carries the id of the campaign it belongs to. - 400 when the campaign belongs to a location outside your account.
- 404 when no campaign exists with that id.
- If the campaign resolves but has since disappeared,
datacomes back as an empty array rather than an error.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
