Conceder ou modificar uma seção personalizada de usuário

POST/api/crm/v2/team.update_permission_section_customv2

operationId: team.updatePermissionSectionCustom

Autorização

api-token + language + role

Corpo da solicitação `application/json`

object

user_idintegerobrigatório

ID do usuário

Exemplo: 1

permission_section_idintegerobrigatório

Exemplo: 112

readonly_enabledboolean

Atualizado somente se o campo for enviado na solicitação, portanto, definir o prazo de validade não altera o modo de acesso. Para uma nova concessão, o padrão é false — acesso total, mas o valor se torna true se a seção estiver disponível para o editor apenas para leitura.

Exemplo: false

date_expirationoneOfpode ser nulo

Data de expiração do acesso à seção no fuso horário do usuário; valor vazio — sem restrição. Atualizado somente se o campo for enviado na solicitação, portanto, a alteração do modo não o redefine. Concessões expiradas são removidas automaticamente.

Uma das opções

string (DataTimeFormat)

Exemplo: 17:45 06/05/2024

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject

curl -X POST 'https://foodsoul.pro/api/crm/v2/team.update_permission_section_custom' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: pt' \
  -H 'role: affiliate' \
  -H 'Content-Type: application/json' \
  -d '{"user_id":1,"permission_section_id":112,"readonly_enabled":false,"date_expiration":"17:45 06/05/2024"}'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.pro/api/crm/v2/team.update_permission_section_custom', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'pt',
        'role' => 'affiliate',
    ],
    'json' => [
        'user_id' => 1,
        'permission_section_id' => 112,
        'readonly_enabled' => false,
        'date_expiration' => '17:45 06/05/2024',
    ],
]);

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

const response = await fetch("https://foodsoul.pro/api/crm/v2/team.update_permission_section_custom", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "pt",
        "role": "affiliate",
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        "user_id": 1,
        "permission_section_id": 112,
        "readonly_enabled": false,
        "date_expiration": "17:45 06/05/2024"
    }),
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.pro/api/crm/v2/team.update_permission_section_custom",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "pt",
        "role": "affiliate",
    },
    json={
        "user_id": 1,
        "permission_section_id": 112,
        "readonly_enabled": False,
        "date_expiration": "17:45 06/05/2024",
    },
)
data = response.json()

Resposta 200

{
  "status": "success",
  "data": {}
}

As solicitações são enviadas para foodsoul.pro — o host deste portal, não é possível escolher outro.

Conceder ou modificar uma seção personalizada de usuário

Autorização

Corpo da solicitação application/json

Respostas

Corpo da solicitação `application/json`