eventSubscriptions

Update event subscription

Changed on

Use this method to update the details of an event subscription.

To update an event subscription, you need its subscriptionId. Our gateway returned the subscriptionId in the response of the Create Event Subscription method.

Note: If you don’t have the subscriptionId, use our List Event Subscriptions method to search for the event subscription.

You can update the following details about an event subscription:

  • Status of the event subscription.
  • Events that you have subscribed to. For a list of events that you can subscribe to, go to Events list.
  • Information about how we contact you when an event occurs.
put/event-subscriptions/{subscriptionId}

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/event-subscriptions/{subscriptionId}
  • Auth
    HTTP bearer

Path parameters

subscriptionIdinteger required

Unique identifier that we assigned to the event subscription.
Note: Our gateway returned the subscriptionId in the id field in the response of the Create Event Subscription method.

Request body

idinteger

Unique identifier that we assigned to the event subscription.

enabledboolean required

Indicates if we should notify you when the event occurs. The value is one of the following:

  • true - We notify you when the event occurs.
  • false - We don't notify you when the event occurs.
status'registered' | 'suspended' | 'failed'

Status of the subscription. We return one of the following values:

  • registered - You have set up the subscription, and we will notify you when an event occurs.
  • suspended - We have deactivated the event subscription, and we won't notify you when an event occurs.
  • failed - We couldn't contact your URI endpoint. We email the supportEmailAddress.
eventTypesstring[] required

Array of events that you want to subscribe to. For a list of events, go to Events List.

metadataEventSubscriptionMetadata

Object that you can send to include custom data in the request. For more information about how to use metadata, go to Metadata.

Response

Successful request. We updated the event subscription.

object required

Changes