---
title: "Pause or resume a webhook destination endpoint"
method: POST
path: "/webhooks/endpoints/{endpointId}/paused"
tags: ["Webhooks"]
---

# Pause or resume a webhook destination endpoint

`POST /webhooks/endpoints/{endpointId}/paused`

## Request

- Base URL: `https://api.sprucehealth.com/v1`
- URL: `https://api.sprucehealth.com/v1/webhooks/endpoints/{endpointId}/paused`
- Auth: HTTP bearer

This operation sets the 'paused' state of a webhook destination endpoint.

## Path parameters

- `endpointId` string, required: The id of a webhook destination endpoint

## Query parameters

- `paused` boolean, required

## Headers

- `s-idempotency-key` string

## Response `200`

ok

- object
  - `paused` boolean, required: A value representing if the webhook destination endpoint is paused

## Other responses

- `400`: bad request
- `404`: not found
- `422`: duplicate request
- `500`: unexpected error

---

[API](https://skmtc.dev/sprucehealth/apis/spruce-health-api.md) - [All operations](https://skmtc.dev/sprucehealth/apis/spruce-health-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sprucehealth/apis/spruce-health-api/revisions/06e7a37de1ce?raw)
