GET
/
v1
/
campaign
/
{id}
curl --request GET \
  --url https://api.sendo.dev/v1/campaign/{id} \
  --header 'Authorization: Bearer <token>'
{
  "campaign": {
    "id": "U7fQ39nX",
    "brandId": "A8wm4k2s",
    "displayName": "Internal Testing",
    "createdAt": "2023-09-21T00:42:01.007Z",
    "updatedAt": "2023-09-21T00:42:01.007Z",
    "status": "ACTIVE",
    "monthlyFee": 1000,
    "usecase": "MIXED",
    "subUsecases": [
      "CUSTOMER_CARE",
      "ACCOUNT_NOTIFICATION"
    ],
    "details": {
      "description": "This campaign will be used for 2FA login codes.",
      "consentFlow": "Users consent to receive SMS when making an account.",
      "screenshotUrl": "https://sendo-images.s3.amazonaws.com/OTPVerification-7bf5878dc5.png",
      "sample1": "Your Sendo login code is 123456.",
      "sample2": "Your Sendo login code is 987654.",
      "sample3": null,
      "sample4": null,
      "sample5": null,
      "optinKeywords": [
        "START",
        "SUBSCRIBE"
      ],
      "optoutKeywords": [
        "STOP"
      ],
      "helpKeywords": [
        "HELP"
      ],
      "optinMessage": "You've subscribed to receive messages from this number. Reply STOP to unsubscribe.",
      "optoutMessage": "You will no longer receive messages from this number. Reply START to subscribe again.",
      "helpMessage": "Text STOP to unsubscribe. Email support@sendo.dev with any questions."
    },
    "limits": {
      "smsTpmAtt": 75,
      "mmsTpmAtt": 50,
      "dailyTmoCap": 2000
    }
  }
}

This endpoint retrieves a campaign. Click here to learn more.

​
Parameters

​
id
string
required

The ID of the campaign to retrieve.

​
Response

​
campaign
object

The contents of the campaign.

​
error
string

Error message if the request fails.

​
Errors

If the request fails, it will return an HTTP error status code and an error field in the body with details. Full list of status codes here.

{
  "campaign": {
    "id": "U7fQ39nX",
    "brandId": "A8wm4k2s",
    "displayName": "Internal Testing",
    "createdAt": "2023-09-21T00:42:01.007Z",
    "updatedAt": "2023-09-21T00:42:01.007Z",
    "status": "ACTIVE",
    "monthlyFee": 1000,
    "usecase": "MIXED",
    "subUsecases": [
      "CUSTOMER_CARE",
      "ACCOUNT_NOTIFICATION"
    ],
    "details": {
      "description": "This campaign will be used for 2FA login codes.",
      "consentFlow": "Users consent to receive SMS when making an account.",
      "screenshotUrl": "https://sendo-images.s3.amazonaws.com/OTPVerification-7bf5878dc5.png",
      "sample1": "Your Sendo login code is 123456.",
      "sample2": "Your Sendo login code is 987654.",
      "sample3": null,
      "sample4": null,
      "sample5": null,
      "optinKeywords": [
        "START",
        "SUBSCRIBE"
      ],
      "optoutKeywords": [
        "STOP"
      ],
      "helpKeywords": [
        "HELP"
      ],
      "optinMessage": "You've subscribed to receive messages from this number. Reply STOP to unsubscribe.",
      "optoutMessage": "You will no longer receive messages from this number. Reply START to subscribe again.",
      "helpMessage": "Text STOP to unsubscribe. Email support@sendo.dev with any questions."
    },
    "limits": {
      "smsTpmAtt": 75,
      "mmsTpmAtt": 50,
      "dailyTmoCap": 2000
    }
  }
}