Import clients from file

POST/api/crm/v2/clients_import.importv2

operationId: clientsImport.import

Imports network clients from a CSV file: delimiter ;, three columns — name, phone, bonuses. For each row, the phone number is normalized and validated; if the client does not exist, a new one is created. A client profile is created in the first branch of the network and bonuses are credited. Invalid phone numbers and zero bonus amounts are skipped. If the file is not provided, error 106 is returned; if the CSV is invalid, error 108 is returned.

Authorization

api-token + language + role

Query parameters

chain_idintegerrequired

Example: 1

Request body `multipart/form-data`

object

filestring · binaryrequired

File *.csv

Responses

object

statusstringrequired

Values:successerror

Example: success

One of the options

object

Error description

errorobjectrequired

codeintegerrequired

object

Data

dataobject

curl -X POST 'https://foodsoul.ru/api/crm/v2/clients_import.import?chain_id=1' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: en' \
  -H 'role: partner' \
  -F 'file=@file.jpg'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.ru/api/crm/v2/clients_import.import?chain_id=1', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'en',
        'role' => 'partner',
    ],
    'multipart' => [
        [
            'name' => 'file',
            'contents' => '<file>',
        ],
    ],
]);

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

const body = new FormData()
body.append("file", "<file>")

const response = await fetch("https://foodsoul.ru/api/crm/v2/clients_import.import?chain_id=1", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner"
    },
    body,
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.ru/api/crm/v2/clients_import.import?chain_id=1",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner",
    },
    files={
        "file": [
            None,
            "<file>",
        ],
    },
)
data = response.json()

Response 200

{
  "error": {
    "code": 0
  }
}

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

Import clients from file

Authorization

Query parameters

Request body multipart/form-data

Responses

Request body `multipart/form-data`