Delivery

Rename, pause, resume or disable a destination

Disabling cancels deliveries that have not been made yet.

patch/v1/destinations/{destination_id}

Request

  • Base URL: https://sourcefinch.com
  • URL: https://sourcefinch.com/v1/destinations/{destination_id}
  • Auth: HTTP bearer

Path parameters

destination_idstring uuid required

Headers

X-Request-Idstring

Echoed in the response and logs; generated when absent.

SourceFinch-Projectstring uuid

Project UUID. Required for session tokens; API keys are bound to their project.

Request body

namestring
status'active' | 'paused' | 'disabled'

Response

The destination

idstring uuid required
project_idstring uuid required
kind'webhook' | 'email' | 'slack' | 'google_sheets' | 'postgres' | 's3' | 'warehouse' required
namestring required
configobject required
mode'changes' | 'snapshot' required
source_idsstring[] nullable required
status'active' | 'paused' | 'disabled' required
status_reasonstring nullable required
created_atstring required

ISO-8601 timestamp (UTC)

updated_atstring required

ISO-8601 timestamp (UTC)

Changes

No recorded changes to this operation across all 2 revisions of this API.