PRprolific
webhooks

Update a subscription

Changed on

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

patch/api/v1/hooks/subscriptions/{subscription_id}/

Request

  • Base URL
    https://api.prolific.com
  • URL
    https://api.prolific.com/api/v1/hooks/subscriptions/{subscription_id}/
  • Auth
    API key in header Authorization

Path parameters

subscription_idstring required

Subscription id

Request body

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.

is_enabledboolean

Whether the subscription is enabled or not.

Response

Updated

idstring

The ID of the subscription.

event_typestring required

The name of the event type associated to the subscription.

target_urlstring required

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

is_enabledboolean

Whether the subscription is enabled or not.

workspace_idstring required

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

Changes

  • 6c9aa73fa51fRevision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security token was added to the API

  • e9e1e322aacbRevision changes
    • info

      api operation id update-subscription removed and replaced with webhooks_UpdateSubscription