Alterar regras de pagamento

POST/api/crm/v2/integration_payments.update_payment_rulesv2

operationId: integrationPayments.updatePaymentRules

Altera as regras de pagamento. rules aceita HTML com até 65536 caracteres. Se após a remoção das tags HTML não restar conteúdo, o campo recebe o valor null. excludes lista os campos para os quais a remoção de tags não é aplicada.

Autorização

api-token + language + role

Parâmetros de consulta

branch_idintegerobrigatório

Exemplo: 1

Corpo da solicitação `application/json`

object

rulesstringobrigatório

Regras de pagamento em HTML

Exemplo: <h2>Payment rules<h2>

excludesarray of stringobrigatório

Matriz de chaves de campos dos quais as tags HTML não devem ser removidas

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject

curl -X POST 'https://foodsoul.pro/api/crm/v2/integration_payments.update_payment_rules?branch_id=1' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: pt' \
  -H 'role: partner' \
  -H 'Content-Type: application/json' \
  -d '{"rules":"<h2>Payment rules<h2>","excludes":["rules"]}'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.pro/api/crm/v2/integration_payments.update_payment_rules?branch_id=1', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'pt',
        'role' => 'partner',
    ],
    'json' => [
        'rules' => '<h2>Payment rules<h2>',
        'excludes' => [
            'rules',
        ],
    ],
]);

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

const response = await fetch("https://foodsoul.pro/api/crm/v2/integration_payments.update_payment_rules?branch_id=1", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "pt",
        "role": "partner",
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        "rules": "<h2>Payment rules<h2>",
        "excludes": [
            "rules"
        ]
    }),
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.pro/api/crm/v2/integration_payments.update_payment_rules?branch_id=1",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "pt",
        "role": "partner",
    },
    json={
        "rules": "<h2>Payment rules<h2>",
        "excludes": [
            "rules",
        ],
    },
)
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 regras de pagamento

Autorização

Parâmetros de consulta

Corpo da solicitação application/json

Respostas

Corpo da solicitação `application/json`