Let the platform do the work
SugarClubContact+1 (877) 842-7276

job_queue_run

Overview

Runs the specified job.

Available APIs

  • REST

Definition

job_queue_run(session, jobid, clientid)

Parameters

Name Type Description
session String Session ID returned by a previous login call.
jobid String The ID of the job to run.
clientid String The client id calling the application. This parameter is of your choosing for the calling application.

Result

Name Type Description
result Array The call result.
result.results Boolean The result of the job run.
result.message String This is only returned if a failure occurs.

Change Log

Version Change
v4 Added job_queue_run method.

Examples

PHP

$job_queue_run_parameters = array(
    //Session id
    'session' => $session_id,

    //The ID of the job to run.
    'jobid' => 'd141efd3-d2c7-8a9c-9c02-50c11b491f16',

    //The ID of the calling application.
    'clientid' => 'MyAppID',
);

Topics