Submit a program with specified parameters

Request

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

Security

bearerAuth

Path

programIdintegerrequired

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.

orgIdintegerrequired

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.

Bodyapplication/json; charset=utf-8required

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.

parametersArray of objects(ParameterList)

{
  "parameters": [
    { … }
  ]
}

Responses

The job status is returned with the job ID.

Bodyapplication/json

dataobject(JobStatus)

successboolean

Response

{
  "data": {
    "actual_start_date": "string",
    "crtd_by": "string",
    "crtd_dt": "string",
    "error_message": "string",
    "id": 0,
    "sec_atr_val": 0,
    "status": "string",
    "updt_dt": "string"
  },
  "success": true
}