Block or unblock a user

POST/api/crm/v2/team.toggle_block_statusv2

operationId: team.toggleBlockStatus

Blocks or unblocks a user. active=true blocks the user: blocked = true, login is disabled, and all active user sessions are terminated as if the password was changed. active=false unblocks the user without affecting sessions. You cannot toggle your own record in any mode—blocking would terminate your current session. The account owner's record cannot be toggled. Any other record can be toggled by a user with write access to the section.

Authorization

api-token + language + role

Request body `application/json`

object

idintegerrequired

Example: 7159

activebooleanrequired

Example: true

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/team.toggle_block_status' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: en' \
  -H 'role: affiliate' \
  -H 'Content-Type: application/json' \
  -d '{"id":7159,"active":true}'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.pro/api/crm/v2/team.toggle_block_status', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'en',
        'role' => 'affiliate',
    ],
    'json' => [
        'id' => 7159,
        'active' => true,
    ],
]);

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

const response = await fetch("https://foodsoul.pro/api/crm/v2/team.toggle_block_status", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "affiliate",
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        "id": 7159,
        "active": true
    }),
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.pro/api/crm/v2/team.toggle_block_status",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "affiliate",
    },
    json={
        "id": 7159,
        "active": True,
    },
)
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.

Block or unblock a user

Authorization

Request body application/json

Responses

Request body `application/json`