Merge Docs

GET

/selective-sync/configurations

This feature is only available to customers on our Enterprise plan. See our pricing page for more information.

Get a linked account's selective syncs.

Header Parameters

AuthorizationString

Required

Token-based authentication with required prefix "Bearer"

X-Account-TokenString

Required

Token identifying the end user.

Response

JSON


[
  {
    "linked_account_conditions": [
      {
        "condition_schema_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "common_model": "string",
        "native_name": "string",
        "operator": "string",
        "field_name": "string"
      }
    ]
  }
]

PUT

/selective-sync/configurations

This feature is only available to customers on our Enterprise plan. See our pricing page for more information.

Replace a linked account's selective syncs.

Header Parameters

AuthorizationString

Required

Token-based authentication with required prefix "Bearer"

X-Account-TokenString

Required

Token identifying the end user.

Body Parameters

sync_configurationsArray

Required

The selective syncs associated with a linked account.

PUT v1/selective-sync/configurations

JSON


{
  "sync_configurations": [
    {
      "linked_account_conditions": [
        {
          "condition_schema_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "operator": "string"
        }
      ]
    }
  ]
}

Response

JSON


[
  {
    "linked_account_conditions": [
      {
        "condition_schema_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "common_model": "string",
        "native_name": "string",
        "operator": "string",
        "field_name": "string"
      }
    ]
  }
]

GET

/selective-sync/meta

This feature is only available to customers on our Enterprise plan. See our pricing page for more information.

Get metadata for the conditions available to a linked account.

Header Parameters

AuthorizationString

Required

Token-based authentication with required prefix "Bearer"

X-Account-TokenString

Required

Token identifying the end user.

Query & Path Parameters

common_modelString

Optional

cursorString

Optional

The pagination cursor value.

page_sizeInteger

Optional

Number of results to return per page.

Response

JSON


{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "common_model": "string",
      "native_name": "string",
      "field_name": "string",
      "is_unique": true,
      "operators": [
        {
          "operator": "string",
          "is_unique": true
        }
      ]
    }
  ]
}