Enable a flow for a specific consumer

curl --request POST \
  --url https://api.chift.eu/consumers/{consumer_id}/syncs/{syncid}/flows/{flowid}/enable \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "integrationids": [],
  "triggerid": "trigger-1",
  "cronschedule": "<string>",
  "data": {}
}
'

import requests

url = "https://api.chift.eu/consumers/{consumer_id}/syncs/{syncid}/flows/{flowid}/enable"

payload = {
    "integrationids": [],
    "triggerid": "trigger-1",
    "cronschedule": "<string>",
    "data": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({integrationids: [], triggerid: 'trigger-1', cronschedule: '<string>', data: {}})
};

fetch('https://api.chift.eu/consumers/{consumer_id}/syncs/{syncid}/flows/{flowid}/enable', 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.chift.eu/consumers/{consumer_id}/syncs/{syncid}/flows/{flowid}/enable",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'integrationids' => [
        
    ],
    'triggerid' => 'trigger-1',
    'cronschedule' => '<string>',
    'data' => [
        
    ]
  ]),
  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.chift.eu/consumers/{consumer_id}/syncs/{syncid}/flows/{flowid}/enable"

	payload := strings.NewReader("{\n  \"integrationids\": [],\n  \"triggerid\": \"trigger-1\",\n  \"cronschedule\": \"<string>\",\n  \"data\": {}\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.chift.eu/consumers/{consumer_id}/syncs/{syncid}/flows/{flowid}/enable")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"integrationids\": [],\n  \"triggerid\": \"trigger-1\",\n  \"cronschedule\": \"<string>\",\n  \"data\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.chift.eu/consumers/{consumer_id}/syncs/{syncid}/flows/{flowid}/enable")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"integrationids\": [],\n  \"triggerid\": \"trigger-1\",\n  \"cronschedule\": \"<string>\",\n  \"data\": {}\n}"

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

{
  "message": "Impossible to enable the flow as the flow requires configuration fields",
  "status": "error"
}

{
  "message": "The consumer does not exist",
  "status": "error"
}

{
  "message": "Error while validating context data; the field {field_name} does not seem to be of type {field_type}",
  "status": "error"
}

POST

consumers

{consumer_id}

syncs

{syncid}

flows

{flowid}

enable

Enable a flow for a specific consumer

curl --request POST \
  --url https://api.chift.eu/consumers/{consumer_id}/syncs/{syncid}/flows/{flowid}/enable \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "integrationids": [],
  "triggerid": "trigger-1",
  "cronschedule": "<string>",
  "data": {}
}
'

import requests

url = "https://api.chift.eu/consumers/{consumer_id}/syncs/{syncid}/flows/{flowid}/enable"

payload = {
    "integrationids": [],
    "triggerid": "trigger-1",
    "cronschedule": "<string>",
    "data": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({integrationids: [], triggerid: 'trigger-1', cronschedule: '<string>', data: {}})
};

fetch('https://api.chift.eu/consumers/{consumer_id}/syncs/{syncid}/flows/{flowid}/enable', 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.chift.eu/consumers/{consumer_id}/syncs/{syncid}/flows/{flowid}/enable",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'integrationids' => [
        
    ],
    'triggerid' => 'trigger-1',
    'cronschedule' => '<string>',
    'data' => [
        
    ]
  ]),
  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.chift.eu/consumers/{consumer_id}/syncs/{syncid}/flows/{flowid}/enable"

	payload := strings.NewReader("{\n  \"integrationids\": [],\n  \"triggerid\": \"trigger-1\",\n  \"cronschedule\": \"<string>\",\n  \"data\": {}\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.chift.eu/consumers/{consumer_id}/syncs/{syncid}/flows/{flowid}/enable")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"integrationids\": [],\n  \"triggerid\": \"trigger-1\",\n  \"cronschedule\": \"<string>\",\n  \"data\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.chift.eu/consumers/{consumer_id}/syncs/{syncid}/flows/{flowid}/enable")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"integrationids\": [],\n  \"triggerid\": \"trigger-1\",\n  \"cronschedule\": \"<string>\",\n  \"data\": {}\n}"

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

{
  "message": "Impossible to enable the flow as the flow requires configuration fields",
  "status": "error"
}

{
  "message": "The consumer does not exist",
  "status": "error"
}

{
  "message": "Error while validating context data; the field {field_name} does not seem to be of type {field_type}",
  "status": "error"
}

Learn more:

What are Syncs? ↗
How do Syncs work? ↗
How to activate a Sync? ↗

Authorizations

Authorization

string

header

required

This access token needs to be included in each of your request to the Chift API.

Path Parameters

syncid

string<uuid>

required

flowid

string<uuid>

required

consumer_id

string<uuid>

required

Body

application/json

integrationids

string[]

List of integrationids of the connections that will be used to enable the flow

triggerid

string | null

default:trigger-1

cronschedule

string | null

data

Data · object | null

Object containing the configuration of the flow for the consumer

Response

Successful Response

API Reference Overview

Access & Connections

Accounting

Invoicing

POS

eCommerce

PMS

Payment

Banking

Other

Enable a flow for a specific consumer

Authorizations

Path Parameters

Body

Response