> ## Documentation Index > Fetch the complete documentation index at: https://docs.peerlogic.com/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml /openapi/peerlogic-api.json patch /api/subscriptions/{id}/ openapi: 3.1.0 info: title: Peerlogic API version: 1.0.0 description: >- Customer-facing API reference for accessing Peerlogic calls, insights, conversations, tasks, opportunities, subscriptions, and events. servers: - url: https://api.prod.peerlogic.com description: Production security: [] tags: - name: Authentication description: Obtain an access token for authenticated API requests. - name: Call insights description: Call records and aggregate performance insights. - name: Transcripts description: Transcripts, summaries, sentiment, pauses, and call-purpose details. - name: Aimee description: Aimee activity, configuration, and performance insights. - name: Conversations description: Conversation records, messages, and conversation actions. - name: Tasks description: Customer tasks and task workflow actions. - name: Opportunities description: Opportunities and follow-up reporting. - name: Subscriptions and events description: >- Create and manage event subscriptions, then inspect event records and analytics. For the complete webhook delivery flow, see the Webhooks and subscriptions guide. - name: Organizations and practices description: >- Discover the organizations and practices available to the authenticated account. - name: Contacts and patients description: Find contacts and patients for caller recognition and related workflows. - name: Appointments description: Retrieve appointment history and upcoming appointments for a patient. - name: Messaging description: Send practice messages, including missed-call recovery outreach. - name: Call recordings description: Retrieve recording metadata and secure audio URLs for calls. paths: /api/subscriptions/{id}/: parameters: - name: id in: path description: A unique value identifying this subscription. required: true schema: type: string patch: tags: - Subscriptions and events summary: Update subscriptions description: >- 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. operationId: subscriptions_partial_update requestBody: content: application/json: schema: type: object properties: created_at: title: Created at type: string format: date-time readOnly: true description: Time when the subscription was created. description: title: Description type: string maxLength: 255 nullable: true description: >- Customer-defined explanation of the workflow this subscription supports. destination: title: Destination type: string readOnly: true minLength: 1 nullable: true description: >- Delivery destination. Webhook destinations must be HTTPS URLs. extra: title: Extra type: string maxLength: 255 nullable: true description: >- Optional customer-defined value available for webhook subscriptions. id: title: Id type: string readOnly: true minLength: 1 description: >- Unique subscription ID. Webhook deliveries include this value in `X-Subscription-ID`. is_active: title: Is active type: boolean description: Whether the subscription is enabled to produce deliveries. modified_at: title: Modified at type: string format: date-time readOnly: true description: Time when the subscription was last changed. name: title: Name type: string maxLength: 128 minLength: 1 description: Customer-defined name used to identify the subscription. practice_id: title: Practice id type: string readOnly: true description: Practice whose activity is evaluated for this subscription. subscription_type: title: Subscription type type: string enum: - webhook - email - sms - noop readOnly: true description: >- Delivery channel used by the subscription. Customer webhook integrations use `webhook`. system_message: title: System message type: string enum: - email_verification_required - phone_verification_required - disabled_for_consecutive_error_responses - disabled_for_404_response - unexpected_response_received readOnly: true nullable: true description: >- Current verification or delivery status requiring attention, or `null` when no status is present. trigger: required: - trigger_type type: object properties: trigger_type: title: Trigger type type: string enum: - missed_call - missed_call_existing_patient - missed_call_cancellation_reschedule - missed_call_current_appointment - missed_call_non_business - missed_call_business - high_value_missed_call - connected_call - connected_call_existing_patient - connected_call_new_patient - connected_call_high_value - lost_opportunity - lost_opportunity_new_patient - lost_opportunity_existing_patient - lost_opportunity_high_value - aimee_escalation - aimee_booked - aimee_reschedule - aimee_cancellation - aimee_inbound_message - extracted_opportunity - care_task_handed_off - voip_integration_disconnect - ehr_integration_disconnect - fax_inbound_received - fax_outbound_failed description: Supported Peerlogic activity that produces a delivery. readOnly: true description: Condition that produces a delivery for this subscription. examples: pauseDeliveries: summary: Pause deliveries without deleting the subscription value: is_active: false clarifyPurpose: summary: Update the customer-managed label and description value: name: Missed-call recovery workflow description: Feeds missed calls into our booking-recovery queue required: true responses: '200': description: The updated subscription. content: application/json: schema: required: - name type: object properties: created_at: title: Created at type: string format: date-time readOnly: true description: Time when the subscription was created. description: title: Description type: string maxLength: 255 nullable: true description: >- Customer-defined explanation of the workflow this subscription supports. destination: title: Destination type: string readOnly: true minLength: 1 nullable: true description: >- Delivery destination. Webhook destinations must be HTTPS URLs. extra: title: Extra type: string maxLength: 255 nullable: true description: >- Optional customer-defined value available for webhook subscriptions. id: title: Id type: string readOnly: true minLength: 1 description: >- Unique subscription ID. Webhook deliveries include this value in `X-Subscription-ID`. is_active: title: Is active type: boolean description: Whether the subscription is enabled to produce deliveries. modified_at: title: Modified at type: string format: date-time readOnly: true description: Time when the subscription was last changed. name: title: Name type: string maxLength: 128 minLength: 1 description: Customer-defined name used to identify the subscription. practice_id: title: Practice id type: string readOnly: true description: >- Practice whose activity is evaluated for this subscription. subscription_type: title: Subscription type type: string enum: - webhook - email - sms - noop readOnly: true description: >- Delivery channel used by the subscription. Customer webhook integrations use `webhook`. system_message: title: System message type: string enum: - email_verification_required - phone_verification_required - disabled_for_consecutive_error_responses - disabled_for_404_response - unexpected_response_received readOnly: true nullable: true description: >- Current verification or delivery status requiring attention, or `null` when no status is present. trigger: required: - trigger_type type: object properties: trigger_type: title: Trigger type type: string enum: - missed_call - missed_call_existing_patient - missed_call_cancellation_reschedule - missed_call_current_appointment - missed_call_non_business - missed_call_business - high_value_missed_call - connected_call - connected_call_existing_patient - connected_call_new_patient - connected_call_high_value - lost_opportunity - lost_opportunity_new_patient - lost_opportunity_existing_patient - lost_opportunity_high_value - aimee_escalation - aimee_booked - aimee_reschedule - aimee_cancellation - aimee_inbound_message - extracted_opportunity - care_task_handed_off - voip_integration_disconnect - ehr_integration_disconnect - fax_inbound_received - fax_outbound_failed description: Supported Peerlogic activity that produces a delivery. readOnly: true description: Condition that produces a delivery for this subscription. examples: paused: summary: Subscription paused value: 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: subscription_type: webhook is_active: false system_message: null trigger: trigger_type: missed_call '400': description: The request parameters or body are invalid. content: application/json: schema: $ref: '#/components/schemas/ValidationError' example: name: - Ensure this field has no more than 128 characters. '401': description: Authentication is required. content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' example: detail: '''Authorization'' header is required' '403': description: >- The authenticated account does not have permission to perform this operation. content: application/json: schema: $ref: '#/components/schemas/PermissionError' example: message: No permissions assigned to permit access to this endpoint. '404': description: >- The requested resource was not found or is not accessible to the authenticated account. content: application/json: schema: $ref: '#/components/schemas/NotFoundError' example: detail: The requested resource was not found. security: - bearerAuth: [] components: schemas: ValidationError: title: Validation error type: object additionalProperties: true description: Validation details keyed by the invalid field or grouped under `errors`. AuthenticationError: title: Authentication error type: object additionalProperties: true required: - detail properties: detail: type: string description: Why authentication failed. PermissionError: title: Permission error type: object additionalProperties: false required: - message properties: message: type: string description: Why access was denied. NotFoundError: title: Not found error type: object additionalProperties: false required: - detail properties: detail: type: string description: Why the requested resource could not be returned. securitySchemes: bearerAuth: type: http scheme: bearer description: Bearer access token issued by Peerlogic. ```` ## Related topics - [Receive webhook events](/guides/webhooks-and-subscriptions.md) - [List subscriptions](/peerlogic-api-reference/subscriptions-and-events/list-subscriptions.md) - [Create subscriptions](/peerlogic-api-reference/subscriptions-and-events/create-subscriptions.md) - [Get subscription](/peerlogic-api-reference/subscriptions-and-events/get-subscription.md) - [Delete subscriptions](/peerlogic-api-reference/subscriptions-and-events/delete-subscriptions.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.