Create

Description

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

Request

HTTP Method: POST

Body parameter Description
destination_tenant_url Base URL of the destination tenant.
destination_tenant_api_key Tines API key used to publish to the destination tenant.
destination_team_id ID of the team on the destination tenant that will own the synced stories.
team_id ID of the team on the current tenant creating the sync.
story_ids Array of story IDs (from the current tenant) to sync. 

curl -X POST \
  https://<<META.tenant.domain>>/api/v1/admin/sync_destinations \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>' \
  -d '{
    "destination_tenant_url": "https://<<META.tenant.domain>>.tines.com",
    "destination_tenant_api_key": "<<CREDENTIAL.tines_api_key>>",
    "destination_team_id": 42,
    "team_id": 7,
    "story_ids": [9981, 9982]
  }'

Response

Returns the newly‑created sync destination object, with a 201 Created status.

Field description

Parameter Description
id Sync destination ID.
destination_tenant_url Base URL of the destination tenant (e.g. https://<<META.tenant.domain>>.tines.com).
destination_team_id ID of the destination team receiving the synced stories.
origin_team_id ID of the team on the current tenant where the sync destination was created.
subscriptions Array of subscription objects (one per story).
subscriptions[].story.id ID of the story.
subscriptions[].story.name Name of the story.
subscriptions[].status Sync status. One of synced, failed, or requires_sync.
subscriptions[].error_message Error details if status is failed; null otherwise.

Sample response

{
  "sync_destination": {
    "id": 24,
    "destination_tenant_url": "https://<<META.tenant.domain>>.tines.com",
    "destination_team_id": 42,
    "origin_team_id": 7,
    "subscriptions": [
      {
        "story": { "id": 9981, "name": "High‑Priority Alerts" },
        "status": "synced",
        "error_message": null
      },
      {
        "story": { "id": 9982, "name": "Change Control Requests" },
        "status": "synced",
        "error_message": null
      }
    ]
  }
}
Was this helpful?