Update integration settings with the automation system

POST/api/crm/v2/integration_automations.updatev2

operationId: integrationAutomations.update

Updates settings. Sensitive fields are encrypted before saving; IP and URL fields are validated. An uploaded catalog file triggers a forced import; in case of errors 385 (branch import already in progress) and 397 (too many forced imports running), settings are saved but the file is not imported.

Authorization

api-token + language + role

Query parameters

branch_idintegerrequired

Example: 1

Request body `multipart/form-data`

Connection fields are dynamic, see list[].fields: key template ${field}.
Pickup point field key — pickup_data_${pickup_id}_terminal; district field keys — district_data_${district_id}_terminal, district_data_${district_id}_delivery; id 0 — default settings.
Maximum string length is 250 characters.

object

One of the options

object

automation_idintegerrequired

Example: 1

automation_error_notifications_enabledboolean

Example: true

phone_clean_enabledboolean

Example: true

phone_plus_delete_enabledboolean

Example: true

phone_space_delete_enabledboolean

Example: true

qr_bar_code_enabledboolean

Example: true

callback_api_enabledboolean

Example: true

import_once_catalog_enabledboolean

Example: true

import_once_description_enabledboolean

Example: true

import_once_image_enabledboolean

Example: true

import_once_labels_enabledboolean

Example: true

Responses

object

statusstringrequired

Values:successerror

Example: success

dataobject

curl -X POST 'https://foodsoul.pro/api/crm/v2/integration_automations.update?branch_id=1' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: en' \
  -H 'role: partner' \
  -F 'automation_id=1' \
  -F 'automation_error_notifications_enabled=true' \
  -F 'phone_clean_enabled=true' \
  -F 'phone_plus_delete_enabled=true' \
  -F 'phone_space_delete_enabled=true' \
  -F 'qr_bar_code_enabled=true' \
  -F 'callback_api_enabled=true' \
  -F 'import_once_catalog_enabled=true' \
  -F 'import_once_description_enabled=true' \
  -F 'import_once_image_enabled=true' \
  -F 'import_once_labels_enabled=true'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.pro/api/crm/v2/integration_automations.update?branch_id=1', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'en',
        'role' => 'partner',
    ],
    'multipart' => [
        [
            'name' => 'automation_id',
            'contents' => '1',
        ],
        [
            'name' => 'automation_error_notifications_enabled',
            'contents' => 'true',
        ],
        [
            'name' => 'phone_clean_enabled',
            'contents' => 'true',
        ],
        [
            'name' => 'phone_plus_delete_enabled',
            'contents' => 'true',
        ],
        [
            'name' => 'phone_space_delete_enabled',
            'contents' => 'true',
        ],
        [
            'name' => 'qr_bar_code_enabled',
            'contents' => 'true',
        ],
        [
            'name' => 'callback_api_enabled',
            'contents' => 'true',
        ],
        [
            'name' => 'import_once_catalog_enabled',
            'contents' => 'true',
        ],
        [
            'name' => 'import_once_description_enabled',
            'contents' => 'true',
        ],
        [
            'name' => 'import_once_image_enabled',
            'contents' => 'true',
        ],
        [
            'name' => 'import_once_labels_enabled',
            'contents' => 'true',
        ],
    ],
]);

$data = json_decode((string) $response->getBody(), true);

const body = new FormData()
body.append("automation_id", "1")
body.append("automation_error_notifications_enabled", "true")
body.append("phone_clean_enabled", "true")
body.append("phone_plus_delete_enabled", "true")
body.append("phone_space_delete_enabled", "true")
body.append("qr_bar_code_enabled", "true")
body.append("callback_api_enabled", "true")
body.append("import_once_catalog_enabled", "true")
body.append("import_once_description_enabled", "true")
body.append("import_once_image_enabled", "true")
body.append("import_once_labels_enabled", "true")

const response = await fetch("https://foodsoul.pro/api/crm/v2/integration_automations.update?branch_id=1", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner"
    },
    body,
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.pro/api/crm/v2/integration_automations.update?branch_id=1",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner",
    },
    files={
        "automation_id": [
            None,
            "1",
        ],
        "automation_error_notifications_enabled": [
            None,
            "true",
        ],
        "phone_clean_enabled": [
            None,
            "true",
        ],
        "phone_plus_delete_enabled": [
            None,
            "true",
        ],
        "phone_space_delete_enabled": [
            None,
            "true",
        ],
        "qr_bar_code_enabled": [
            None,
            "true",
        ],
        "callback_api_enabled": [
            None,
            "true",
        ],
        "import_once_catalog_enabled": [
            None,
            "true",
        ],
        "import_once_description_enabled": [
            None,
            "true",
        ],
        "import_once_image_enabled": [
            None,
            "true",
        ],
        "import_once_labels_enabled": [
            None,
            "true",
        ],
    },
)
data = response.json()

Response 200

{
  "status": "success",
  "data": {}
}

Requests are sent to foodsoul.pro — the host of this portal; you cannot choose another one.

Update integration settings with the automation system

Authorization

Query parameters

Request body multipart/form-data

Responses

Request body `multipart/form-data`