skip to content

API - Update Jobcard Custom Fields

URL: JobcardUpdateCustomFields.php

JSON Option (recommended):

to use as JSON, append ?apiformat=json to the URL, then send through all variables as a JSON encoded string.

Required Fields:

username
password
JobcardNR (int) - matching the jobcard number you want to update

 

Optional Fields:

AdditionalValue1 (32 characters max) //These are custom fields as specified under Settings -> Documents -> Jobcard -> Custom Fields. Note that the amount you can use is limited by your account type.
AdditionalValue2 (32 characters max)
AdditionalValue3 (32 characters max)
AdditionalValue4 (32 characters max)
AdditionalValue5 (32 characters max)
AdditionalValue6 (32 characters max)
AdditionalValue7 (32 characters max)
AdditionalValue8 (32 characters max)
AdditionalValue9 (32 characters max)
AdditionalValue10 (32 characters max)
EmailToClient (bool)
SMSToClient (bool)
WhatsApp (bool)
WhatsAppToUser (bool)

Returns:

JSON array containing:

$array[url] - the url where the document can be downloaded
$array[jobcard_nr] - the jobcard number
$array[document_nr] - the jobcard number
$array[document_id] - the global document id
$array[email_url] - url to open to have the document emailed to the client

Example PHP code

$param['username'] = '';
$param['password'] = '';
$param['JobcardNR'] = '';
$param['status'] = '';
	
$url = 'https://www.jobcardsonline.co.za/api/JobcardUpdateCustomFields.php?apiformat=json';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url); //set the url
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); //return as a variable
curl_setopt($ch, CURLOPT_POST, 1); //set POST method
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param)); //set the POST variables
$response = curl_exec($ch); //run the whole process and return the response

 

Updated: Sat, 7 November 2026

Print this page | Back to top