Update a Campaign Subscription

Update a webhook subscription for a campaign.

Endpoint

PATCH /v1/campaigns/{campaignId}/subscriptions/{subscriptionId}

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

campaignId REQUIRED

string (UUID)

Unique ID assigned to the campaign in RocketCOMS.

subscriptionId REQUIRED

string (UUID)

Unique ID assigned to the webhook subscription in RocketCOMS.

Request Body

eventTypes

array

List of events for which the subscription receives notifications. Possible values are:

message.status Status of messages sent as part of a campaign.
message.replies Reply messages for a campaign.
batch.status Status of campaign batches.

url

string

Webhook subscription URL endpoint.

Returns

If successful, returns 200 Subscription created successfully.

SAMPLE REQUEST

				
					{
  "eventTypes": [
    "message.status",
    "message.replies",
    "batch.status"
  ],
  "url": "https://mycompany.com/webhook/listener"
}

SAMPLE RESPONSE

				
					{
  200 Subscription created successfully
}