Remove a campaign's follow-up

Overview

Take the follow-up message off a campaign channel.

Use this when you want a single message with no reminder.

You'll need the channel's unique code: channels[].unique_code in Get one campaign.

The follow-up is cleared; the first message is unchanged.

Prerequisites

• A bearer token. See Authentication.
• The channel's unique code (uniqueCode), from data.channels[].unique_code in Get one campaign.

Base URL

Endpoint

DELETE /api/v1/campaign/channel/{uniqueCode}/remove/followup

Authentication

Partner or Account token

• The channel's campaign must belong to a location inside your own account tree. If it doesn't, the call returns 403.
• An unknown unique code returns 400 Channel not found.

Rate limit

This endpoint has no rate limit.

Request parameters

Request body

None.

Request payload

None.

Response body

The payload is inside data.

Response payload

{
  "data": {
    "message": "Follow up template removed successfully"
  }
}

Examples

Success payload

See Response payload.

Error payload

400 Channel not found

{
  "message": "Channel not found",
  "status": "error",
  "errors": []
}

403 Channel outside your account

{
  "message": "You are not authorized to remove the follow up template",
  "status": "error",
  "errors": []
}

Example request

curl --request DELETE \
  --url "https://production-api.shoutaboutus.com/api/v1/campaign/channel/5289ho/remove/followup" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'