Add operator

POST/api/crm/v2/operators.addv2

operationId: operators.add

Creates an operator in the branch (branch_id): phone number, notification e-mail, SMS flag, public phone, access level, and optional binding to an account user (firm_user_id). The token is generated automatically.

Authorization

api-token + language + role

Query parameters

branch_idintegerrequired

Example: 8791

Request body `application/json`

object

firm_user_idinteger

Example: 825

email_for_notificationsarray of stringrequired

E-mail for notifications, up to 255 characters

permissionstringrequired

Order access: all — all orders, only — orders assigned to this operator

Values:allonly

Example: all

phone_format_idinteger (PhoneFormatId) required

Country code: 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)

Example: 1

phone_numberintegerrequired

Example: 9939697322

phone_sms_enabledboolean

Example: true

public_phonestring

Example: 9939697323

Responses

object (Response)

statusstringrequired

Values:successerror

Example: success

One of the options

object

Error details

errorobjectrequired

codeintegerrequired

Error code

variablesobject

descriptionstringrequired

Error description

object

Data array (structure depends on the action, see examples)

dataobjectrequired

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

Response 200

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

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

Add operator

Authorization

Query parameters

Request body application/json

Responses

Request body `application/json`