POST
PaymentForms.Update
Update a payment form template (payment_forms). Mirrors dashboard Setting2::add_payment_form update. Also updates unpaid customer rows (payment_forms_paid where paid=0) linked to this template.
Permissions
- User must be logged in with a valid bearer token.
- Returned or changed records are limited by the user permissions, team access, folder access, and account settings.
Action
- Updates the requested PaymentForms record after validating permissions and input fields.
Push Service
No push is sent because this function only reads data or returns helper information.
Automation
No automation is run for this function.
Special Instructions
- Send the bearer token on protected calls with Authorization: Bearer YOUR TOKEN.
- Send parameters as POST body fields exactly as documented.
- Send date/time values in UTC Y-m-d H:i:s format when a date or datetime field is used.
Required Parameters
| Name | Type | Sample | Explanation |
|---|---|---|---|
payment_form_idpost | int | 342 | Template id. Aliases: id, data_id. |
Optional Parameters
| Name | Type | Sample | What it gives |
|---|---|---|---|
form_namepost | string | Updated name | Form name. |
amountpost | string | 70 | Amount. |
invoice_setting_idpost | int | 3 | Invoice company id. |
payment_gatwaypost | int | 7 | Payment gateway id. |
iteam_typepost | string | product | Item type. |
iteam_idpost | int | 120 | Linked item id. |
regular_installments_document_typepost | string | receipt,purchase_orders | Document type for product/order flows (stored in payment_type_data JSON). Preferred over document_type. |
document_typepost | string | receipt | Alias for regular_installments_document_type on product/order. For subscription/legacy flows stored in payment_forms.document_type column. |
Authentication
Send the bearer token returned by Login in the request header.
Authorization: Bearer YOUR TOKEN
Sample Request
{
"url": "\/app\/PaymentForms.Update",
"method": "POST",
"headers": {
"Authorization": "Bearer YOUR TOKEN"
},
"body": {
"payment_form_id": "342",
"amount": "70"
},
"url_user": "https:\/\/{user}.bull36.com\/app\/PaymentForms.Update",
"url_domain": "https:\/\/{domain}\/app\/PaymentForms.Update"
}Endpoint
POST /app/PaymentForms.Update
POST https://{user}.bull36.com/app/PaymentForms.Update
POST https://{domain}/app/PaymentForms.UpdateSample Output
{
"success": 1,
"payment_form_id": 342,
"message": "Payment form updated successfully."
}JavaScript Example
const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('payment_form_id', '342');
body.set('amount', '70');
const res = await fetch('/app/PaymentForms.Update', {
method: 'POST',
headers: { Authorization: `Bearer ${token}` },
body
});
const data = await res.json();
console.log(data);Error Example
{
"success": 0,
"message": "Payment form not found."
}