Adicionar rótulo

POST/api/crm/v2/labels.addv2

operationId: labels.add

Cria um rótulo. text_color e background_color — valores HEX sem o # inicial.

Autorização

api-token + language + role

Parâmetros de consulta

chain_idinteger

Exemplo: 7124

Corpo da solicitação `application/json`

object

nameobject (TranslationField) obrigatório

Campo traduzível do catálogo; mesma estrutura na resposta e na solicitação.
Ao criar, cada idioma da rede que não estiver em translations permanece vazio e é colocado na fila para tradução por IA.
Ao atualizar, apenas os idiomas presentes em translations são gravados: um idioma ausente no objeto mantém o valor anterior, se o original não foi alterado; um valor vazio limpa a tradução e a coloca na fila para tradução por IA.
Alterar o original limpa as traduções que não foram modificadas — elas não correspondem mais ao original; uma tradução enviada com outro valor é salva como edição manual. Essa limpeza ocorre apenas enquanto a tradução automática estiver ativada na rede.
Um valor em um idioma não publicado é rejeitado; um valor em um idioma fora do conjunto de idiomas da rede é ignorado.

defaultstring

Код исходного языка сети; в запросе должен совпадать с настройкой сети

Exemplo: ru

translationsobjectobrigatório

Valor pelo código do idioma; sem tradução — sem chave

Valores do dicionário

string

text_colorstringobrigatório

Exemplo: B77C7C

background_colorstringobrigatório

Exemplo: 777777

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject

curl -X POST 'https://foodsoul.ru/api/crm/v2/labels.add' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: pt' \
  -H 'role: partner' \
  -H 'Content-Type: application/json' \
  -d '{"name":{"default":"ru","translations":{"ru":"Пицца","en":"Pizza"}},"text_color":"B77C7C","background_color":"777777"}'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.ru/api/crm/v2/labels.add', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'pt',
        'role' => 'partner',
    ],
    'json' => [
        'name' => [
            'default' => 'ru',
            'translations' => [
                'ru' => 'Пицца',
                'en' => 'Pizza',
            ],
        ],
        'text_color' => 'B77C7C',
        'background_color' => '777777',
    ],
]);

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

const response = await fetch("https://foodsoul.ru/api/crm/v2/labels.add", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "pt",
        "role": "partner",
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        "name": {
            "default": "ru",
            "translations": {
                "ru": "Пицца",
                "en": "Pizza"
            }
        },
        "text_color": "B77C7C",
        "background_color": "777777"
    }),
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.ru/api/crm/v2/labels.add",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "pt",
        "role": "partner",
    },
    json={
        "name": {
            "default": "ru",
            "translations": {
                "ru": "Пицца",
                "en": "Pizza",
            },
        },
        "text_color": "B77C7C",
        "background_color": "777777",
    },
)
data = response.json()

Resposta 200

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

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

Adicionar rótulo

Autorização

Parâmetros de consulta

Corpo da solicitação application/json

Respostas

Corpo da solicitação `application/json`