Update Sync

Update Sync

curl --request PATCH \
  --url https://api.hightouch.com/api/v1/syncs/{syncId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "configuration": {
    "mode": "upsert",
    "object": "contacts",
    "mappings": [
      {
        "to": "email",
        "from": "email",
        "type": "standard"
      }
    ],
    "objectId": "0-1",
    "externalIdMapping": {
      "to": "firstname",
      "from": "test_id",
      "type": "standard"
    },
    "associationMappings": []
  },
  "schedule": null,
  "disabled": true
}
'

import requests

url = "https://api.hightouch.com/api/v1/syncs/{syncId}"

payload = {
    "configuration": {
        "mode": "upsert",
        "object": "contacts",
        "mappings": [
            {
                "to": "email",
                "from": "email",
                "type": "standard"
            }
        ],
        "objectId": "0-1",
        "externalIdMapping": {
            "to": "firstname",
            "from": "test_id",
            "type": "standard"
        },
        "associationMappings": []
    },
    "schedule": None,
    "disabled": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    configuration: {
      mode: 'upsert',
      object: 'contacts',
      mappings: [{to: 'email', from: 'email', type: 'standard'}],
      objectId: '0-1',
      externalIdMapping: {to: 'firstname', from: 'test_id', type: 'standard'},
      associationMappings: []
    },
    schedule: null,
    disabled: true
  })
};

fetch('https://api.hightouch.com/api/v1/syncs/{syncId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hightouch.com/api/v1/syncs/{syncId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'configuration' => [
        'mode' => 'upsert',
        'object' => 'contacts',
        'mappings' => [
                [
                                'to' => 'email',
                                'from' => 'email',
                                'type' => 'standard'
                ]
        ],
        'objectId' => '0-1',
        'externalIdMapping' => [
                'to' => 'firstname',
                'from' => 'test_id',
                'type' => 'standard'
        ],
        'associationMappings' => [
                
        ]
    ],
    'schedule' => null,
    'disabled' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hightouch.com/api/v1/syncs/{syncId}"

	payload := strings.NewReader("{\n  \"configuration\": {\n    \"mode\": \"upsert\",\n    \"object\": \"contacts\",\n    \"mappings\": [\n      {\n        \"to\": \"email\",\n        \"from\": \"email\",\n        \"type\": \"standard\"\n      }\n    ],\n    \"objectId\": \"0-1\",\n    \"externalIdMapping\": {\n      \"to\": \"firstname\",\n      \"from\": \"test_id\",\n      \"type\": \"standard\"\n    },\n    \"associationMappings\": []\n  },\n  \"schedule\": null,\n  \"disabled\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.hightouch.com/api/v1/syncs/{syncId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"configuration\": {\n    \"mode\": \"upsert\",\n    \"object\": \"contacts\",\n    \"mappings\": [\n      {\n        \"to\": \"email\",\n        \"from\": \"email\",\n        \"type\": \"standard\"\n      }\n    ],\n    \"objectId\": \"0-1\",\n    \"externalIdMapping\": {\n      \"to\": \"firstname\",\n      \"from\": \"test_id\",\n      \"type\": \"standard\"\n    },\n    \"associationMappings\": []\n  },\n  \"schedule\": null,\n  \"disabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hightouch.com/api/v1/syncs/{syncId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"configuration\": {\n    \"mode\": \"upsert\",\n    \"object\": \"contacts\",\n    \"mappings\": [\n      {\n        \"to\": \"email\",\n        \"from\": \"email\",\n        \"type\": \"standard\"\n      }\n    ],\n    \"objectId\": \"0-1\",\n    \"externalIdMapping\": {\n      \"to\": \"firstname\",\n      \"from\": \"test_id\",\n      \"type\": \"standard\"\n    },\n    \"associationMappings\": []\n  },\n  \"schedule\": null,\n  \"disabled\": true\n}"

response = http.request(request)
puts response.read_body

{
  "id": 1,
  "slug": "testsync3",
  "workspaceId": 1,
  "createdAt": "2022-02-16T21:37:58.510Z",
  "updatedAt": "2022-03-19T19:24:34.320Z",
  "createdBy": {
    "id": 1,
    "name": "Jane Doe",
    "email": "jane.doe@example.com"
  },
  "updatedBy": {
    "id": 1,
    "name": "Jane Doe",
    "email": "jane.doe@example.com"
  },
  "destinationId": 1,
  "modelId": 4,
  "configuration": {
    "mode": "upsert",
    "object": "contacts",
    "mappings": [
      {
        "to": "email",
        "from": "email",
        "type": "standard"
      }
    ],
    "objectId": "0-1",
    "externalIdMapping": {
      "to": "firstname",
      "from": "test_id",
      "type": "standard"
    },
    "associationMappings": []
  },
  "schedule": {
    "type": "interval",
    "schedule": {
      "interval": {
        "unit": "day",
        "quantity": 1
      }
    }
  },
  "status": "success",
  "disabled": true,
  "lastRunAt": "2022-02-16T21:37:58.510Z",
  "referencedColumns": [
    "email",
    "name"
  ],
  "primaryKey": "id",
  "externalSegment": {},
  "tags": {
    "foo": "bar"
  },
  "syncTemplateId": null,
  "syncTemplateOverrides": null
}

{
  "message": "Validation failed",
  "details": {}
}

"Internal Server Error"

PATCH

syncs

{syncId}

Update Sync

curl --request PATCH \
  --url https://api.hightouch.com/api/v1/syncs/{syncId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "configuration": {
    "mode": "upsert",
    "object": "contacts",
    "mappings": [
      {
        "to": "email",
        "from": "email",
        "type": "standard"
      }
    ],
    "objectId": "0-1",
    "externalIdMapping": {
      "to": "firstname",
      "from": "test_id",
      "type": "standard"
    },
    "associationMappings": []
  },
  "schedule": null,
  "disabled": true
}
'

import requests

url = "https://api.hightouch.com/api/v1/syncs/{syncId}"

payload = {
    "configuration": {
        "mode": "upsert",
        "object": "contacts",
        "mappings": [
            {
                "to": "email",
                "from": "email",
                "type": "standard"
            }
        ],
        "objectId": "0-1",
        "externalIdMapping": {
            "to": "firstname",
            "from": "test_id",
            "type": "standard"
        },
        "associationMappings": []
    },
    "schedule": None,
    "disabled": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    configuration: {
      mode: 'upsert',
      object: 'contacts',
      mappings: [{to: 'email', from: 'email', type: 'standard'}],
      objectId: '0-1',
      externalIdMapping: {to: 'firstname', from: 'test_id', type: 'standard'},
      associationMappings: []
    },
    schedule: null,
    disabled: true
  })
};

fetch('https://api.hightouch.com/api/v1/syncs/{syncId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hightouch.com/api/v1/syncs/{syncId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'configuration' => [
        'mode' => 'upsert',
        'object' => 'contacts',
        'mappings' => [
                [
                                'to' => 'email',
                                'from' => 'email',
                                'type' => 'standard'
                ]
        ],
        'objectId' => '0-1',
        'externalIdMapping' => [
                'to' => 'firstname',
                'from' => 'test_id',
                'type' => 'standard'
        ],
        'associationMappings' => [
                
        ]
    ],
    'schedule' => null,
    'disabled' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hightouch.com/api/v1/syncs/{syncId}"

	payload := strings.NewReader("{\n  \"configuration\": {\n    \"mode\": \"upsert\",\n    \"object\": \"contacts\",\n    \"mappings\": [\n      {\n        \"to\": \"email\",\n        \"from\": \"email\",\n        \"type\": \"standard\"\n      }\n    ],\n    \"objectId\": \"0-1\",\n    \"externalIdMapping\": {\n      \"to\": \"firstname\",\n      \"from\": \"test_id\",\n      \"type\": \"standard\"\n    },\n    \"associationMappings\": []\n  },\n  \"schedule\": null,\n  \"disabled\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.hightouch.com/api/v1/syncs/{syncId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"configuration\": {\n    \"mode\": \"upsert\",\n    \"object\": \"contacts\",\n    \"mappings\": [\n      {\n        \"to\": \"email\",\n        \"from\": \"email\",\n        \"type\": \"standard\"\n      }\n    ],\n    \"objectId\": \"0-1\",\n    \"externalIdMapping\": {\n      \"to\": \"firstname\",\n      \"from\": \"test_id\",\n      \"type\": \"standard\"\n    },\n    \"associationMappings\": []\n  },\n  \"schedule\": null,\n  \"disabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hightouch.com/api/v1/syncs/{syncId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"configuration\": {\n    \"mode\": \"upsert\",\n    \"object\": \"contacts\",\n    \"mappings\": [\n      {\n        \"to\": \"email\",\n        \"from\": \"email\",\n        \"type\": \"standard\"\n      }\n    ],\n    \"objectId\": \"0-1\",\n    \"externalIdMapping\": {\n      \"to\": \"firstname\",\n      \"from\": \"test_id\",\n      \"type\": \"standard\"\n    },\n    \"associationMappings\": []\n  },\n  \"schedule\": null,\n  \"disabled\": true\n}"

response = http.request(request)
puts response.read_body

{
  "id": 1,
  "slug": "testsync3",
  "workspaceId": 1,
  "createdAt": "2022-02-16T21:37:58.510Z",
  "updatedAt": "2022-03-19T19:24:34.320Z",
  "createdBy": {
    "id": 1,
    "name": "Jane Doe",
    "email": "jane.doe@example.com"
  },
  "updatedBy": {
    "id": 1,
    "name": "Jane Doe",
    "email": "jane.doe@example.com"
  },
  "destinationId": 1,
  "modelId": 4,
  "configuration": {
    "mode": "upsert",
    "object": "contacts",
    "mappings": [
      {
        "to": "email",
        "from": "email",
        "type": "standard"
      }
    ],
    "objectId": "0-1",
    "externalIdMapping": {
      "to": "firstname",
      "from": "test_id",
      "type": "standard"
    },
    "associationMappings": []
  },
  "schedule": {
    "type": "interval",
    "schedule": {
      "interval": {
        "unit": "day",
        "quantity": 1
      }
    }
  },
  "status": "success",
  "disabled": true,
  "lastRunAt": "2022-02-16T21:37:58.510Z",
  "referencedColumns": [
    "email",
    "name"
  ],
  "primaryKey": "id",
  "externalSegment": {},
  "tags": {
    "foo": "bar"
  },
  "syncTemplateId": null,
  "syncTemplateOverrides": null
}

{
  "message": "Validation failed",
  "details": {}
}

"Internal Server Error"

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

syncId

number<double>

required

The sync's ID

Body

application/json

The input for updating a Sync

configuration

object

The sync's configuration. This specifies how data is mapped, among other configuration.

The schema depends on the destination type.

For a sync bound to a sync template this is the effective configuration: the template's configuration with this sync's syncTemplateOverrides applied.

Consumers should NOT make assumptions on the contents of the configuration. It may change as Hightouch updates its internal code.

Show child attributes

schedule

object | null

The scheduling configuration. It can be triggered based on several ways:

Interval: the sync will be triggered based on certain interval(minutes/hours/days/weeks)

Cron: the sync will be triggered based on cron expression https://en.wikipedia.org/wiki/Cron.

Visual: the sync will be triggered based a visual cron configuration on UI

DBT-cloud: the sync will be triggered based on a dbt cloud job

Match Booster (type "match_booster"): the sync will be triggered after each Match Booster enrichment run of its model completes. Requires the model to have Match Booster enabled, and takes no inner schedule payload.

Show child attributes

disabled

boolean

Whether the sync has been disabled by the user.

syncTemplateId

number<double> | null

The id of a Sync Template to bind the sync to, or null to detach the sync from its template. Binding requires the template's destination to match the sync's destination; while bound, the sync follows the template's configuration and configuration cannot be set directly. Detaching copies the sync's effective configuration, schedule and other inherited settings onto the sync so it keeps running unchanged.

syncTemplateOverrides

object | null

Replaces the sync's template overrides, keyed by configuration field path. Only fields the template's overrideConfig marks as overridable are accepted; null clears every override. Requires the sync to be, or to become, bound to a sync template.

Show child attributes

Response

Syncs define how data from models are mapped to destinations. Each time a sync runs, Hightouch calculates the rows that have changed since the last run, and syncs them to Sync's destination.

number<double>

required

The sync's id

slug

string

required

The sync's slug

workspaceId

number<double>

required

The id of the workspace that the sync belongs to

createdAt

string<date-time>

required

The timestamp when the sync was created

updatedAt

string<date-time>

required

The timestamp when the sync was last updated

createdBy

object | null

required

The user who created the sync, or null if no user was recorded

Show child attributes

updatedBy

object | null

required

The user who last updated the sync, or null if no user was recorded

Show child attributes

destinationId

number<double>

required

The id of the Destination that sync is connected to

modelId

number<double>

required

The id of the Model that sync is connected to

configuration

object

required

The sync's configuration. This specifies how data is mapped, among other configuration.

The schema depends on the destination type.

For a sync bound to a sync template this is the effective configuration: the template's configuration with this sync's syncTemplateOverrides applied.

Consumers should NOT make assumptions on the contents of the configuration. It may change as Hightouch updates its internal code.

Show child attributes

schedule

object | null

required

The scheduling configuration. It can be triggered based on several ways:

Interval: the sync will be triggered based on certain interval(minutes/hours/days/weeks)

Cron: the sync will be triggered based on cron expression https://en.wikipedia.org/wiki/Cron.

Visual: the sync will be triggered based a visual cron configuration on UI

DBT-cloud: the sync will be triggered based on a dbt cloud job

Show child attributes

status

enum<string>

required

The overall status of the sync

Available options:

disabled,

pending,

cancelled,

failed,

queued,

success,

warning,

querying,

processing,

reporting,

interrupted

disabled

boolean

required

Whether the sync has been disabled by the user.

lastRunAt

string<date-time> | null

required

The timestamp of the last sync run

referencedColumns

string[]

required

The reference column that sync depends on to sync data from source

primaryKey

string

required

The primary key that sync uses to identify data from source

externalSegment

object

required

The user facing ID for any created lists or audiences in the sync destination

Show child attributes

Get started

Audiences

AI Decisioning

Destinations

Events

Lineage

Match Booster

Sources

Models

Sync templates

Sync drafts

Syncs

Sync sequences

Authorizations

Path Parameters

Body

Response