Alterar contratante

POST/api/crm/v2/contractors.update_contractorv2

operationId: contractors.updateContractor

Altera o contratante. O conjunto de campos de dados depende de contractor_type_id. O campo entity_tax_number é verificado em uma lista negra.

Autorização

api-token + language + role

Parâmetros de consulta

chain_idintegerobrigatório

Exemplo: 1

Corpo da solicitação `application/json`

Campos dinâmicos por contractor_type_id. Pegue os campos da requisição fields e associe-os ao contractor_type_id selecionado.

object

idintegerobrigatório

Exemplo: 1

contractor_type_idintegerobrigatório

Exemplo: 1

branch_idintegerobrigatório

Exemplo: 1

taxation_idintegerobrigatório

Exemplo: 1

cao_emailstringobrigatório

Exemplo: example@example.com

cao_phone_format_idinteger (PhoneFormatId) obrigatório

Código do país: 1-🇷🇺(+7|8), 2-🇦🇿(+994|0), 3-🇧🇾(+375|80), 4-🇰🇿(+7|8), 6-🇷🇸(+381|0), 7-🇹🇷(+90|0), 8-🇺🇦(+380|0), 9-🇵🇹(+351|0), 10-🇰🇬(+996|0), 11-🇺🇸(+1), 12-🇫🇷(+33|0), 13-🇲🇩(+373|0), 15-🇪🇪(+372), 18-🇬🇪(+995), 19-🇺🇿(+998), 22-🇵🇱(+48|0), 23-🇹🇯(+992|8), 25-🇷🇴(+40|0), 44-🇨🇭(+41|0)

Exemplo: 1

cao_phone_numberstringobrigatório

Exemplo: 999-999-99-99

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject

curl -X POST 'https://foodsoul.pro/api/crm/v2/contractors.update_contractor?chain_id=1' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: pt' \
  -H 'role: partner' \
  -H 'Content-Type: application/json' \
  -d '{"id":1,"contractor_type_id":1,"branch_id":1,"taxation_id":1,"cao_email":"example@example.com","cao_phone_format_id":1,"cao_phone_number":"999-999-99-99"}'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.pro/api/crm/v2/contractors.update_contractor?chain_id=1', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'pt',
        'role' => 'partner',
    ],
    'json' => [
        'id' => 1,
        'contractor_type_id' => 1,
        'branch_id' => 1,
        'taxation_id' => 1,
        'cao_email' => 'example@example.com',
        'cao_phone_format_id' => 1,
        'cao_phone_number' => '999-999-99-99',
    ],
]);

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

const response = await fetch("https://foodsoul.pro/api/crm/v2/contractors.update_contractor?chain_id=1", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "pt",
        "role": "partner",
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        "id": 1,
        "contractor_type_id": 1,
        "branch_id": 1,
        "taxation_id": 1,
        "cao_email": "example@example.com",
        "cao_phone_format_id": 1,
        "cao_phone_number": "999-999-99-99"
    }),
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.pro/api/crm/v2/contractors.update_contractor?chain_id=1",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "pt",
        "role": "partner",
    },
    json={
        "id": 1,
        "contractor_type_id": 1,
        "branch_id": 1,
        "taxation_id": 1,
        "cao_email": "example@example.com",
        "cao_phone_format_id": 1,
        "cao_phone_number": "999-999-99-99",
    },
)
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.

Alterar contratante

Autorização

Parâmetros de consulta

Corpo da solicitação application/json

Respostas

Corpo da solicitação `application/json`