Admin > Sync destinations

Update a sync destination

Update an existing sync destination. Use this to rotate the API key, change which stories are synced, or toggle manual-only sync. The source team, destination team, and destination tenant URL cannot be changed after creation.

patch/api/v1/admin/sync_destinations/{id}

Request

  • Base URL: https://your-tenant.tines.com
  • URL: https://your-tenant.tines.com/api/v1/admin/sync_destinations/{id}
  • Auth: one of:
    • API key in header X-User-Token
    • HTTP bearer

Path parameters

idinteger required

The sync destination ID

Request body

destination_tenant_api_keystring

Tines API key used to publish to the destination tenant. When omitted, the existing key is preserved

story_idsinteger[]

Story IDs from the current tenant to sync. Pass an empty array to remove all subscriptions. When omitted, existing subscriptions are preserved

manual_sync_onlyboolean

When true, stories are only synced on manual trigger. When omitted, the existing value is preserved

Response

Successful response

idinteger

Sync destination ID

destination_tenant_urlstring

Base URL of the destination tenant

destination_team_idinteger

ID of the destination team receiving the synced stories

manual_sync_onlyboolean

Whether the sync destination only syncs on manual trigger

sync_mode'live_readonly' | 'draft_editable'

Whether source updates replace the live destination story (live_readonly) or create an editable draft (draft_editable)

origin_team_idinteger

ID of the team on the current tenant where the sync destination was created

subscriptionsobject[]

Subscription objects (one per story), each with story, status, and error_message

Changes

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