Benutzer sperren oder entsperren

POST/api/crm/v2/team.toggle_block_statusv2

operationId: team.toggleBlockStatus

Sperrt oder entsperrt einen Benutzer. active=true sperrt den Benutzer: blocked = true, der Login ist nicht mehr möglich und alle aktiven Sitzungen des Benutzers werden wie bei einer Passwortänderung beendet. active=false entsperrt den Benutzer und beeinflusst die Sitzungen nicht. Die eigene Zeile kann in keinem Modus umgeschaltet werden – eine Sperrung würde die aktuelle Sitzung beenden. Die Zeile des Account-Inhabers kann nicht umgeschaltet werden. Alle anderen Zeilen können von jedem Benutzer mit Schreibzugriff auf den Bereich umgeschaltet werden.

Autorisierung

api-token + language + role

Anfragetext `application/json`

object

idintegererforderlich

Beispiel: 7159

activebooleanerforderlich

Beispiel: true

Antworten

object (Response)

statusstringerforderlich

Werte:successerror

Beispiel: success

Eine der Optionen

object

Fehlerinformationen

errorobjecterforderlich

codeintegererforderlich

Fehlercode

variablesobject

descriptionstringerforderlich

Fehlerbeschreibung

object

Datenarray (Struktur abhängig von der Aktion, siehe Beispiele)

dataobjecterforderlich

curl -X POST 'https://foodsoul.pro/api/crm/v2/team.toggle_block_status' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: de' \
  -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' => 'de',
        '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": "de",
        "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": "de",
        "role": "affiliate",
    },
    json={
        "id": 7159,
        "active": True,
    },
)
data = response.json()

Antwort 200

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

Anfragen werden an foodsoul.pro gesendet – dies ist der Host dieses Portals, ein anderer kann nicht ausgewählt werden.

Benutzer sperren oder entsperren

Autorisierung

Anfragetext application/json

Antworten

Anfragetext `application/json`