Update a subscription | Prolific API

This allows you to update a subscription. For example you can temporarily disable or enable a subscription if you wish.

AuthorizationToken

Header authentication of the form Token <token>

subscription_idstringRequired

Subscription id

This endpoint expects an object.

event_typestringOptional

The name of the event type associated to the subscription.

target_urlstringOptional

The URL that the subscription will notify when your event type is triggered.

is_enabledbooleanOptional

Whether the subscription is enabled or not.

Updated

event_typestring

The name of the event type associated to the subscription.

target_urlstring

The URL that the subscription will notify when your event type is triggered.

workspace_idstring

The ID of the workspace we will create the subscription in.

idstring or nullRead-only

The ID of the subscription.

is_enabledboolean or null

Whether the subscription is enabled or not.

1	curl -X PATCH https://api.prolific.com/api/v1/hooks/subscriptions/subscription_id/ \
2	-H "Authorization: Token <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"event_type": "study.status.change",
6	"target_url": "https://hooks.example.com/api/v1/notifications",
7	"is_enabled": false
8	}'

1	{
2	"event_type": "study.status.change",
3	"target_url": "https://hooks.example.com/api/v1/notifications",
4	"workspace_id": "workspace-1234abcd",
5	"id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
6	"is_enabled": true
7	}