Alterar configurações de integração com o sistema de automação

POST/api/crm/v2/integration_automations.updatev2

operationId: integrationAutomations.update

Altera as configurações. Campos sensíveis são criptografados antes de serem salvos, campos de IP e URL são validados. Um arquivo de catálogo enviado aciona uma importação forçada; em caso dos erros 385 (importação de filial já em andamento) e 397 (muitos imports forçados em execução), as configurações são salvas, mas o arquivo não é importado.

Autorização

api-token + language + role

Parâmetros de consulta

branch_idintegerobrigatório

Exemplo: 1

Corpo da solicitação `multipart/form-data`

Os campos de conexão são dinâmicos, veja list[].fields: o template da chave é ${field}.
A chave do campo do ponto de retirada é pickup_data_${pickup_id}_terminal, as chaves dos campos do distrito são district_data_${district_id}_terminal, district_data_${district_id}_delivery; id 0 — configurações padrão.
O comprimento máximo da string é 250 caracteres.

object

Uma das opções

object

automation_idintegerobrigatório

Exemplo: 1

automation_error_notifications_enabledboolean

Exemplo: true

phone_clean_enabledboolean

Exemplo: true

phone_plus_delete_enabledboolean

Exemplo: true

phone_space_delete_enabledboolean

Exemplo: true

qr_bar_code_enabledboolean

Exemplo: true

callback_api_enabledboolean

Exemplo: true

import_once_catalog_enabledboolean

Exemplo: true

import_once_description_enabledboolean

Exemplo: true

import_once_image_enabledboolean

Exemplo: true

import_once_labels_enabledboolean

Exemplo: true

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: 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: pt' \
  -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' => 'pt',
        '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": "pt",
        "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": "pt",
        "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()

Resposta 200

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

As solicitações são enviadas para foodsoul.pro — o host deste portal, não é possível escolher outro.

Alterar configurações de integração com o sistema de automação

Autorização

Parâmetros de consulta

Corpo da solicitação multipart/form-data

Respostas

Corpo da solicitação `multipart/form-data`