Submit a program with specified parameters

Submits a program in Zuora Revenue and returns the job ID.

Request
path Parameters
programId
required
integer

The ID of the program that is to be submitted in Zuora Revenue. You can get the program ID by using the "Get list of available programs and program parameters" operation.

orgId
required
integer

The ID of the organization for which the program is to be submitted. You can get the organization ID by using the "Get list of available organizations" operation.

Request Body schema: application/json; charset=utf-8
required

An array that contains the parameter values to be used for the program. For each parameter, you need to specify the parameter ID, sequence, and desired value. You can get the parameter name, ID, and sequence by using the "Get list of available programs and program parameters" operation.

Array of objects (ParameterList)
Responses
200

The job status is returned with the job ID.

400

The specified program is not supported.

403

The specified organization ID does not match the organization assigned to the current user role.

post/api/integration/v1/{orgId}/programs/{programId}/submit
Request samples
application/json; charset=utf-8
{
  • "parameters": [
    ]
}
Response samples
application/json
{
  • "data": {
    },
  • "success": true
}