Admin > Sync destinations

Create a sync destination

Create a new sync destination and subscribe it to one or more stories.

post/api/v1/admin/sync_destinations

Request

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

Request body

destination_tenant_urlstring required

Base URL of the destination tenant. Use the current tenant's URL for same-tenant sync

destination_tenant_api_keystring

Tines API key used to publish to the destination tenant. Required only when syncing to a remote tenant

destination_team_idinteger required

ID of the team on the destination tenant that will own the synced stories

team_idinteger required

ID of the team on the current tenant creating the sync

story_idsinteger[] required

Story IDs from the current tenant to sync

manual_sync_onlyboolean

When true, stories are only synced on manual trigger

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.