Modifier les règles de paiement

POST/api/crm/v2/integration_payments.update_payment_rulesv2

operationId: integrationPayments.updatePaymentRules

Modifie les règles de paiement. rules accepte du HTML d'une longueur maximale de 65536 caractères. Si, après suppression des balises HTML, il ne reste plus rien, le champ prend la valeur null. excludes liste les champs pour lesquels la suppression des balises n'est pas effectuée.

Autorisation

api-token + language + role

Paramètres de requête

branch_idintegerobligatoire

Exemple: 1

Corps de la requête `application/json`

object

rulesstringobligatoire

Règles de paiement en HTML

Exemple: <h2>Payment rules<h2>

excludesarray of stringobligatoire

Tableau des clés de champs pour lesquels les balises HTML ne doivent pas être supprimées

Réponses

object

statusstringobligatoire

Valeurs:successerror

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

Réponse 200

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

Les requêtes sont envoyées à foodsoul.pro — l’hôte de ce portail, il n’est pas possible d’en choisir un autre.

Modifier les règles de paiement

Autorisation

Paramètres de requête

Corps de la requête application/json

Réponses

Corps de la requête `application/json`