Ajouter un opérateur

POST/api/crm/v2/operators.addv2

operationId: operators.add

Crée un opérateur dans la succursale (branch_id) : téléphone, e-mail pour les notifications, indicateur SMS, téléphone public, niveau d'accès et liaison facultative à un utilisateur du compte (firm_user_id). Le jeton est généré automatiquement.

Autorisation

api-token + language + role

Paramètres de requête

branch_idintegerobligatoire

Exemple: 8791

Corps de la requête `application/json`

object

firm_user_idinteger

Exemple: 825

email_for_notificationsarray of stringobligatoire

E-mail pour les notifications, jusqu'à 255 caractères

permissionstringobligatoire

Accès aux commandes : all — toutes les commandes, only — commandes attribuées à cet opérateur

Valeurs:allonly

Exemple: all

phone_format_idinteger (PhoneFormatId) obligatoire

Code du pays : 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)

Exemple: 1

phone_numberintegerobligatoire

Exemple: 9939697322

phone_sms_enabledboolean

Exemple: true

public_phonestring

Exemple: 9939697323

Réponses

object (Response)

statusstringobligatoire

Valeurs:successerror

Exemple: success

L'une des options

object

Informations sur l’erreur

errorobjectobligatoire

codeintegerobligatoire

Code d’erreur

variablesobject

descriptionstringobligatoire

Description de l’erreur

object

Tableau de données (la structure dépend de l'action, voir les exemples)

dataobjectobligatoire

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

Réponse 200

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

Les requêtes sont envoyées à foodsoul.ru — l’hôte de ce portail, il n’est pas possible d’en choisir un autre.

Ajouter un opérateur

Autorisation

Paramètres de requête

Corps de la requête application/json

Réponses

Corps de la requête `application/json`