You can use the Run Partner API only for flows with the scheduling option

Manually or by an external trigger

.

When you run an outbound flow with the Run Partner REST API, if the process-from-backend mapping contains parameters, you can pass the parameter values in the API request. When you run the partner with the API, the values that you define in the API override those that you define in the partner flow.

For example, one of the mapping parameters is the shipment number, and you define the value in the outbound partner flow. If you need to send a one-time message with a different shipment number, run the flow with the API and assign the shipment number parameter a different value.

If you later reprocess the file event,

B2B Gateway

doesn't run the flow with the API. Therefore, it passes the parameter values that you define in the partner flow, not those that you define in the API.

The Run Partner API returns the response code of the action that you perform. If the partner flow triggers successfully, the API returns the event ID of the task event that

B2B Gateway

generates. You can run the

B2B Gateway

Event Status API to query the status of the event based on the event ID.