HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Installer Jobs / Update

Update an installer job. The update applies only description, installerAdminId and pin.

The following request fields are accepted but never saved:

  • status, outcomeDetails - use POST /public-api/actions/installer-job/v1.0/{installerJob}/change-status with status and outcomeDetails.
  • chargePoints, locationId - use POST /public-api/actions/installer-job/v1.0/{installerJob}/assign-charge-points with chargePointIds, locationId or chargingZoneId. These are the action's own fields; the resource payload cannot be reused as is.
  • customFields - use POST /public-api/actions/installer-job/v1.0/{installerJob}/set-custom-fields.
  • installationAndMaintenanceCompanyId - send the job's current company or leave the field out. A different value is still validated and can return 422. There is no supported way to change the company: delete the job and create a new one with the new company. The new job gets a new ID, and deleting a job sends no webhook.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Body Params
integer

The ID of the installer admin assigned to the installer job. When passed, pin is ignored and the job's PIN is cleared. An installer cannot be removed once assigned; null returns 422.

string
length between 4 and 12

The PIN used to verify access rights to execute the installer job. It is applied only when the job has no installer and no installerAdminId is passed; otherwise it is ignored and the request still succeeds.

string
Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json