UPDATE SUBSCRIPTION

Updates an existing subscription by id

Use this operation to enable or disable notification events, change the notification endpoint URI, or change the filtering to receive only notifications for a subset of events.

The UpdateSubscription service call returns no response.

Request Parameters

Parameter Data Type Demo Value Description
UpdateSubscription object Update Subscription using attached info
RequestId anyURI 1 Unique ID of web request needed for de-duping
Subscription object Subscribe to a CallFire postback notification event, such as 'textnotification', by registering a callback URI endpoint where events will get published to.
Id long 123 Unique ID of Subscription
Enabled boolean true Enable publishing of postback notifications for subscribed events.
Endpoint anyURI http://www.yourwebsite.com/somephpfile.php Email or URI endpoint to publish notification event to.
NotificationFormat NotificationFormat XML [XML, JSON, SOAP, EMAIL]
TriggerEvent SubscriptionTriggerEvent CAMPAIGN_FINISHED Event to trigger on[UNDEFINED_EVENT, INBOUND_CALL_FINISHED, INBOUND_TEXT_FINISHED, OUTBOUND_CALL_FINISHED, OUTBOUND_TEXT_FINISHED, CAMPAIGN_STARTED, CAMPAIGN_STOPPED, CAMPAIGN_FINISHED]
SubscriptionFilter object Filter the type of notification events published to postback URI endpoint.
BroadcastId long 123 Broadcast ID to filter on
BatchId long 123 Batch ID to filter on
FromNumber PhoneNumber 123 From number (11 digit) or shortcode to filter on
ToNumber List[PhoneNumber] 13105551212 E.164 11 digit phone number
Inbound boolean Deprecated, use TriggerEvent

Example

using RestSharp;

namespace [your-namespace]
{
    public class [your-class]
    {
        public string UpdateSubscription()
        {
            long subscriptionId = 222046003; // Your Subscription Id here

            var client = new RestClient("https://www.callfire.com/api/1.1/rest/");
            client.Authenticator = new HttpBasicAuthenticator("YourLoginId", "password");

            var request = new RestRequest(string.Format("subscription/{0}", subscriptionId), Method.PUT);
            request.AddParameter("Endpoint", "update_example@test.com");
            request.AddParameter("NotificationFormat", "XML");
            request.AddParameter("TriggerEvent", "INBOUND_TEXT_FINISHED");

            var response = client.Execute(request);
            string content = response.Content;
            return content;
        }
    }
}

The response code returned is:

204

Which means that the subscription has been updated successfully.