Monitors

Update a monitor

Update a monitor's schedule, destination, or status.

patch/v1/monitors/{id}

Request

  • Base URL: https://api.socialfetch.dev
  • URL: https://api.socialfetch.dev/v1/monitors/{id}
  • Auth: one of:
    • API key in header x-api-key
    • none

Path parameters

idstring required

Monitor identifier.

Request body

namestring

New display name for the monitor.

webhookEndpointIdstring nullable

Webhook endpoint id (owned by this account) to deliver events to. Pass null to detach the current webhook endpoint.

spendCapCreditsinteger nullable

Monthly credit spend cap for this monitor. Pass null to remove the cap.

status'active' | 'paused'

Set to paused to pause the monitor, or active to resume it.

Response

The updated monitor.

Changes

No recorded changes to this operation across all 1 revision of this API.