Přidat operátora

POST/api/crm/v2/operators.addv2

operationId: operators.add

Vytvoří operátora ve filiálce (branch_id): telefon, e-mail pro notifikace, příznak SMS, veřejné telefonní číslo, úroveň přístupu a volitelné přiřazení k uživateli účtu (firm_user_id). Token je vytvořen automaticky.

Autorizace

api-token + language + role

Parametry dotazu

branch_idintegerpovinné

Příklad: 8791

Tělo požadavku `application/json`

object

firm_user_idinteger

Příklad: 825

email_for_notificationsarray of stringpovinné

E-mail pro oznámení, maximálně 255 znaků

permissionstringpovinné

Přístup k objednávkám: all — všechny objednávky, only — objednávky přiřazené tomuto operátorovi

Hodnoty:allonly

Příklad: all

phone_format_idinteger (PhoneFormatId) povinné

Kód země: 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)

Příklad: 1

phone_numberintegerpovinné

Příklad: 9939697322

phone_sms_enabledboolean

Příklad: true

public_phonestring

Příklad: 9939697323

Odpovědi

object (Response)

statusstringpovinné

Hodnoty:successerror

Příklad: success

Jedna z možností

object

Informace o chybě

errorobjectpovinné

codeintegerpovinné

Kód chyby

variablesobject

descriptionstringpovinné

Popis chyby

object

Pole dat (struktura závisí na akci, viz příklady)

dataobjectpovinné

curl -X POST 'https://foodsoul.pro/api/crm/v2/operators.add?branch_id=8791' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: cs' \
  -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.pro/api/crm/v2/operators.add?branch_id=8791', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'cs',
        '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.pro/api/crm/v2/operators.add?branch_id=8791", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "cs",
        "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.pro/api/crm/v2/operators.add?branch_id=8791",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "cs",
        "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()

Odpověď 200

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

Žádosti jsou odesílány na foodsoul.pro — to je hostitel tohoto portálu, jiný vybrat nelze.

Přidat operátora

Autorizace

Parametry dotazu

Tělo požadavku application/json

Odpovědi

Tělo požadavku `application/json`