Surge
GET
/campaigns/{id}

Retrieves a Campaign object.

Authorization

authorization
AuthorizationBearer <token>

In: header

Path Parameters

id*string

The ID of the campaign to retrieve.

Response Body

application/json

application/json

curl -X GET "https://api.surge.app/campaigns/cpn_01k0qczvhbet4azgn5xm2ccfst"
{
  "consent_flow": "When customers bring in their car for service, they will fill out this web form for intake: https://fastauto.shop/bp108c In it they can choose to opt in to text message notifications. If they choose to opt in, we will send them notifications to let them know if our mechanics find issues and once the car is ready to go, as well as links to invoices and to leave us feedback.",
  "description": "This phone number will send auto maintenance notifications to end users that have opted in. It will also be used for responding to customer inquiries and sending some marketing offers.",
  "id": "cpn_01k0qczvhbet4azgn5xm2ccfst",
  "includes": [
    "links",
    "phone_numbers"
  ],
  "link_sample": "https://l.fastauto.shop/s034ij",
  "message_samples": [
    "You are now opted in to receive repair notifications from DT Precision Auto. Frequency varies. Msg&data rates apply. Reply STOP to opt out.",
    "You're lucky that hundred shot of NOS didn't blow the welds on the intake!",
    "Your car is ready to go. See your invoice here: https://l.fastauto.shop/s034ij"
  ],
  "privacy_policy_url": "https://fastauto.shop/sms-privacy",
  "status": "pending",
  "terms_and_conditions_url": "https://fastauto.shop/terms-and-conditions",
  "use_cases": [
    "account_notification",
    "customer_care",
    "marketing"
  ],
  "volume": "high"
}
{
  "error": {
    "message": "The requested resource could not be found.",
    "type": "not_found"
  }
}