Update payment rules

POST/api/crm/v2/integration_payments.update_payment_rulesv2

operationId: integrationPayments.updatePaymentRules

Updates payment rules. rules accepts HTML up to 65,536 characters. If nothing remains after removing HTML tags, the field is set to null. excludes lists fields for which tag removal is not performed.

Authorization

api-token + language + role

Query parameters

branch_idintegerrequired

Example: 1

Request body `application/json`

object

rulesstringrequired

Payment rules in HTML

Example: <h2>Payment rules<h2>

excludesarray of stringrequired

Array of field keys for which HTML tags should not be removed

Responses

object

statusstringrequired

Values:successerror

Example: 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: en' \
  -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' => 'en',
        '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": "en",
        "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": "en",
        "role": "partner",
    },
    json={
        "rules": "<h2>Payment rules<h2>",
        "excludes": [
            "rules",
        ],
    },
)
data = response.json()

Response 200

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

Requests are sent to foodsoul.pro — the host of this portal; you cannot choose another one.

Update payment rules

Authorization

Query parameters

Request body application/json

Responses

Request body `application/json`