Update subscriptions
Update the customer-managed parts of a subscription. Use name and description to make the purpose clear to operators, and set is_active to false to pause future deliveries without deleting the subscription. Set it back to true to reactivate it.
The practice, trigger, subscription type, destination, and encryption key are fixed after creation. To change any of those values, create a replacement subscription and then delete the old one.
curl --request PATCH \
--url https://api.prod.peerlogic.com/api/subscriptions/{id}/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"is_active": false
}
'{
"id": "<SUBSCRIPTION_ID>",
"created_at": "2026-09-15T19:18:09Z",
"modified_at": "2026-09-16T00:12:42Z",
"name": "Missed-call events",
"description": "Notify our integration when a call is missed",
"destination": "https://partner.example.com/webhooks/peerlogic",
"extra": null,
"practice_id": "<PRACTICE_ID>",
"subscription_type": "webhook",
"is_active": false,
"system_message": null,
"trigger": {
"trigger_type": "missed_call"
}
}{
"name": [
"Ensure this field has no more than 128 characters."
]
}{
"detail": "'Authorization' header is required"
}{
"message": "No permissions assigned to permit access to this endpoint."
}{
"detail": "The requested resource was not found."
}Authorizations
Bearer access token issued by Peerlogic.
Path Parameters
A unique value identifying this subscription.
Body
Customer-defined explanation of the workflow this subscription supports.
255Optional customer-defined value available for webhook subscriptions.
255Whether the subscription is enabled to produce deliveries.
Customer-defined name used to identify the subscription.
1 - 128Response
The updated subscription.
Customer-defined name used to identify the subscription.
1 - 128Time when the subscription was created.
Customer-defined explanation of the workflow this subscription supports.
255Delivery destination. Webhook destinations must be HTTPS URLs.
1Optional customer-defined value available for webhook subscriptions.
255Unique subscription ID. Webhook deliveries include this value in X-Subscription-ID.
1Whether the subscription is enabled to produce deliveries.
Time when the subscription was last changed.
Practice whose activity is evaluated for this subscription.
Delivery channel used by the subscription. Customer webhook integrations use webhook.
webhook, email, sms, noop Current verification or delivery status requiring attention, or null when no status is present.
email_verification_required, phone_verification_required, disabled_for_consecutive_error_responses, disabled_for_404_response, unexpected_response_received Condition that produces a delivery for this subscription.
Show child attributes
Show child attributes
Was this page helpful?
curl --request PATCH \
--url https://api.prod.peerlogic.com/api/subscriptions/{id}/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"is_active": false
}
'{
"id": "<SUBSCRIPTION_ID>",
"created_at": "2026-09-15T19:18:09Z",
"modified_at": "2026-09-16T00:12:42Z",
"name": "Missed-call events",
"description": "Notify our integration when a call is missed",
"destination": "https://partner.example.com/webhooks/peerlogic",
"extra": null,
"practice_id": "<PRACTICE_ID>",
"subscription_type": "webhook",
"is_active": false,
"system_message": null,
"trigger": {
"trigger_type": "missed_call"
}
}{
"name": [
"Ensure this field has no more than 128 characters."
]
}{
"detail": "'Authorization' header is required"
}{
"message": "No permissions assigned to permit access to this endpoint."
}{
"detail": "The requested resource was not found."
}