marketplace

PATCH `/v1/domain-alerts/searches/{search_id}`

Rename, pause or resume a saved search.

Authentication

Send an API key as a bearer token. The endpoint checks sites.create; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X PATCH https://api.zinndigital.com/v1/domain-alerts/searches/{search_id} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

active: false pauses (kept, not counted). active: true resumes it within the allowance (422 past it) and takes a fresh baseline, so domains added while it was paused are not announced.

Parameters

Name	Type	Required	What it is
`search_id (path)`	`string`	Yes	—

Request body

Name	Type	Required	What it is
`name`	`string`	No	—
`active`	`boolean`	No	—

Response

Name	Type	Required	What it is
`search`	`DomainAlertSearch`	Yes	A saved aged-domain search (Q321).

Errors this endpoint can return

400 · 401 · 403 · 404 · 422

PATCH /v1/domain-alerts/searches/{search_id}