Update Business Process

patch

https://api.authvia.com/v3/accounts/{account-id}/customers/{ref}/business-processes/{business-process-id}

🔑
scope business_processes:update

Update a specific Business Process by its ID. This endpoint allows you to modify business process information including status, metadata, and configuration.

📘
Info
The business process ID must exist within your account. This endpoint allows partial updates - only the fields you specify will be modified.
Use PUT for complete replacement if you need to replace all business process data.

💡
Tip: Use PATCH for efficient updates when you only need to modify specific fields of a business process.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account-id

string

required

The unique identifier (AVID) of the Account.

ref

string

required

The Account's (Merchant's) unique reference identifier for the Customer.

business-process-id

string

required

The unique identifier of the Business Process.

Body Params

Payload for updating a business process status.

status

string

enum

The new status of the business process.

Allowed:

callback

string

length between 10 and 65536

The callback URL on which business process updates will be sent.

schedule

1000000000000 to 9999999999999

It is used to schedule a business process at a specific time in future. The value can be provided as a duration or a point in time but must be within 365 days from the current or creation time.

Epoch format timestamp (13 digits) that should be greater than the current time.

expiration

1000000000000 to 9999999999999

Specifies the expiration of the business process, starting from the creation time or the scheduled time if defined. The default value is 45 days (45d). The expiration can be provided as either a duration or a specific point in time, but it must be within 365 days from the creation or scheduled time if defined.

Epoch format timestamp (13 digits) that should be greater than the current time.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Update Business Process

scope `business_processes:update`

Info

Tip: Use PATCH for efficient updates when you only need to modify specific fields of a business process.

200Successfully updated business process. Returns the complete updated business process details.

400Bad Request - The request cannot be processed due to a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).

401The request is valid, but server authentication failed to verify the identity. The user's access token has either expired or is not valid. Creating a new token might resolve the issue.