Adicionar operador

POST/api/crm/v2/operators.addv2

operationId: operators.add

Cria um operador na filial (branch_id): telefone, e-mail para notificações, flag de SMS, telefone público, nível de acesso e vínculo opcional ao usuário da conta (firm_user_id). O token é criado automaticamente.

Autorização

api-token + language + role

Parâmetros de consulta

branch_idintegerobrigatório

Exemplo: 8791

Corpo da solicitação `application/json`

object

firm_user_idinteger

Exemplo: 825

email_for_notificationsarray of stringobrigatório

E-mail para notificações, até 255 caracteres

permissionstringobrigatório

Acesso aos pedidos: all — todos os pedidos, only — pedidos atribuídos a este operador

Valores:allonly

Exemplo: all

phone_format_idinteger (PhoneFormatId) obrigatório

Código do país: 1-🇷🇺(+7|8), 2-🇦🇿(+994|0), 3-🇧🇾(+375|80), 4-🇰🇿(+7|8), 6-🇷🇸(+381|0), 7-🇹🇷(+90|0), 8-🇺🇦(+380|0), 9-🇵🇹(+351|0), 10-🇰🇬(+996|0), 11-🇺🇸(+1), 12-🇫🇷(+33|0), 13-🇲🇩(+373|0), 15-🇪🇪(+372), 18-🇬🇪(+995), 19-🇺🇿(+998), 22-🇵🇱(+48|0), 23-🇹🇯(+992|8), 25-🇷🇴(+40|0), 44-🇨🇭(+41|0)

Exemplo: 1

phone_numberintegerobrigatório

Exemplo: 9939697322

phone_sms_enabledboolean

Exemplo: true

public_phonestring

Exemplo: 9939697323

Respostas

object (Response)

statusstringobrigatório

Valores:successerror

Exemplo: success

Uma das opções

object

Informações sobre o erro

errorobjectobrigatório

codeintegerobrigatório

Código de erro

variablesobject

descriptionstringobrigatório

Descrição do erro

object

Matriz de dados (a estrutura depende da ação, veja exemplos)

dataobjectobrigatório

curl -X POST 'https://foodsoul.ru/api/crm/v2/operators.add?branch_id=8791' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: pt' \
  -H 'role: partner' \
  -H 'Content-Type: application/json' \
  -d '{"firm_user_id":825,"email_for_notifications":["operator@fs.pro"],"permission":"all","phone_format_id":1,"phone_number":9939697322,"phone_sms_enabled":true,"public_phone":"9939697323"}'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.ru/api/crm/v2/operators.add?branch_id=8791', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'pt',
        'role' => 'partner',
    ],
    'json' => [
        'firm_user_id' => 825,
        'email_for_notifications' => [
            'operator@fs.pro',
        ],
        'permission' => 'all',
        'phone_format_id' => 1,
        'phone_number' => 9939697322,
        'phone_sms_enabled' => true,
        'public_phone' => '9939697323',
    ],
]);

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

const response = await fetch("https://foodsoul.ru/api/crm/v2/operators.add?branch_id=8791", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "pt",
        "role": "partner",
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        "firm_user_id": 825,
        "email_for_notifications": [
            "operator@fs.pro"
        ],
        "permission": "all",
        "phone_format_id": 1,
        "phone_number": 9939697322,
        "phone_sms_enabled": true,
        "public_phone": "9939697323"
    }),
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.ru/api/crm/v2/operators.add?branch_id=8791",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "pt",
        "role": "partner",
    },
    json={
        "firm_user_id": 825,
        "email_for_notifications": [
            "operator@fs.pro",
        ],
        "permission": "all",
        "phone_format_id": 1,
        "phone_number": 9939697322,
        "phone_sms_enabled": True,
        "public_phone": "9939697323",
    },
)
data = response.json()

Resposta 200

{
  "error": {
    "code": 0,
    "variables": {},
    "description": "string"
  }
}

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

Adicionar operador

Autorização

Parâmetros de consulta

Corpo da solicitação application/json

Respostas

Corpo da solicitação `application/json`