RocketCOMS

Update a Campaign

Update details for a registered campaign. Only the fields listed below can be updated.

Endpoint

PUT /v1/campaigns/{id}

Authorization Header

Authorization: Bearer <access_token>
or
Authorization: Basic <encodedString>
where <encodedString> is your <api-key>:<api-secret> string encoded using Base64 encoding

Path Parameters

id  REQUIRED

string (UUID)

Unique ID assigned to the campaign in RocketCOMS.

Request Body

campaignName

string, max length: 255, min length: 0

Campaign name.

description

string, max length: 4096, min length: 0

Detailed description of the campaign.

messageFlow

string, max length: 2048, min length: 0

Message flow description.

helpMessage

string, max length: 255, min length: 0

Help message for the campaign.

optinMessage

string, max length: 320, min length: 20

Opt-in message shown to subscribers.

optoutMessage

string, max length: 320, min length: 20

Opt-out message shown to subscribers.

autoRenewal

boolean, default: true

Whether the campaign subscription will automatically renew at the end of the billing cycle.

sample1

string, max length: 1024, min length: 0

Message sample. Some campaign tiers require up to 5 message samples.

sample2

string, max length: 1024, min length: 0

Message sample. Some campaign tiers require up to 5 message samples.

sample3

string, max length: 1024, min length: 0

Message sample. Some campaign tiers require up to 5 message samples.

sample4

string, max length: 1024, min length: 0

Message sample. Some campaign tiers require up to 5 message samples.

sample5

string, max length: 1024, min length: 0

Message sample. Some campaign tiers require up to 5 message samples.

Returns

Returns the campaign details and status. For details, see the Campaign object.

SAMPLE REQUEST

				
					{
  "campaignName": "Spring Campaign",
  "description": "Spring Campaign",
  "messageFlow": "string",
  "helpMessage": "Contact us at 1-800-123-1234 for assistance. To unsubscribe, reply STOP.",
  "optinMessage": "Do you want to receive messages about upcoming events? To consent, please reply YES.",
  "optoutMessage": "To stop receiving messages, please reply END.",
  "autoRenewal": true,
  "sample1": "Sample message",
  "sample2": "Sample message",
  "sample3": "Sample message",
  "sample4": "Sample message",
  "sample5": "Sample message"
}
				
			

SAMPLE RESPONSE

				
					{
  "status": "0000",
  "result": {
    "campaignName": "Spring Campaign",
    "description": "string",
    "sender": "12345678912",
    "usecase": "MARKETING",
    "subUsecases": [
      ""
    ],
    "embeddedLink": false,
    "embeddedPhone": false,
    "numberPool": false,
    "ageGated": false,
    "directLending": false,
    "subscriberOptin": true,
    "subscriberOptout": true,
    "subscriberHelp": true,
    "affiliateMarketing": "false",
    "mnoIds": [
      "10017"
    ],
    "messageFlow": "string",
    "helpMessage": "Contact us at 1-800-123-1234 for assistance. To unsubscribe, reply STOP.",
    "optinMessage": "To receive messages about upcoming events, reply YES.",
    "optoutMessage": "To unsubscribe, reply STOP.",
    "autoRenewal": true,
    "sample1": "string",
    "sample2": "string",
    "sample3": "string",
    "sample4": "string",
    "sample5": "string",
    "id": "d7b0e25f-30c9-456b-b287-6b3dcaa4b8f7",
    "businessAccountId": "67b25a5e-f90a-4491-9ee4-291ff290c1fe",
    "cspId": "4e0c15a5-d798-46ff-8c50-2b30bd597abf",
    "brandId": "d7b0e25f-30c9-456b-b287-6b3dcaa4b8f7",
    "status": "ACTIVE",
    "lastStatusAt": "2022-04-23T22:52:52.590Z",
    "createdAt": "2022-04-23T22:52:52.590Z",
    "billedDate": "2022-04-23T22:52:52.590Z",
    "endDateTime": "2022-04-23T22:52:52.590Z",
    "rejectionReason": "string",
    "batchMessageCount": 1000,
    "singleMessageCount": 200
  }
}