Update event subscription | Payroc

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.

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](https://docs.payroc.com/api/schema/notifications/event-subscriptions/create) method. **Note:** If you don’t have the subscriptionId, use our [List Event Subscriptions](https://docs.payroc.com/api/schema/notifications/event-subscriptions/list) 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](https://docs.payroc.com/knowledge/events/events-list). - Information about how we contact you when an event occurs.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

subscriptionIdstringRequired

Request

This endpoint expects an object.

enabledbooleanRequired

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.

eventTypeslist of stringsRequired

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

notificationslist of objectsRequired

Array of polymorphic notification objects that contain information about how we contact you when an event occurs.

metadataobjectOptional

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

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

406

Not Acceptable Error

500

Internal Server Error

1	using Payroc;
2	using System.Threading.Tasks;
3	using Payroc.Notifications.EventSubscriptions;
4	using System.Collections.Generic;
5
6	namespace Usage;
7
8	public class Example
9	{
10	public async Task Do() {
11	var client = new PayrocClient();
12
13	await client.Notifications.EventSubscriptions.UpdateAsync(
14	new UpdateEventSubscriptionsRequest {
15	SubscriptionId = 1478790936,
16	Body = new EventSubscription {
17	Enabled = true,
18	EventTypes = new List<string>(){
19	"processingAccount.status.changed",
20	}
21	,
22	Notifications = new List<Notification>(){
23	new Notification(
24	new Webhook {
25	Secret = "aBcD1234eFgH5678iJkL9012mNoP3456",
26	SupportEmailAddress = "[email protected]",
27	Uri = "https://my-server/notification/endpoint"
28	}
29	),
30	}
31	,
32	Metadata = new Dictionary<string, object?>(){
33	["yourCustomField"] = "abc123",
34	}
35
36	}
37	}
38	);
39	}
40
41	}