Sign in

v1

latestOpenAPI 3.0.02026-08-06151101754.7 KB
Assignments

Updates a specific assignment

put/assignments/{assignmentId}

Path parameters

assignmentIdinteger required

Assignment ID

Request body

customer_address_idinteger

The assignment customer addressid id

titlestring

The assignment title

descriptionstring

The assignment description

to_be_documentedstring

The assignment 'to be documented info'

internal_infostring

The assignment 'internal planner note'

site_notesstring

The assignment 'important hint'

state'UNPLANNED' | 'SCHEDULED' | 'IN_PROGRESS' | 'PAUSED' | 'DELAYED' | 'DONE'

Assignment state

all_dayboolean

The assignment all_day

startstring date-time

The assignment start

endstring date-time

The assignment end

sourcestring

The assignment source

source_external_idstring

The assignment source_external_id

employeesinteger[]

List of employee ids attached to this appointment

vehiclesinteger[]

List of vehicle ids attached to this appointment

toolsinteger[]

List of tool ids attached to this appointment

documentsinteger[]

List of document ids attached to this appointment

tagsinteger[]

List of label (assignment_tags) ids attached to this appointment

Example request

{
  "employees": [
    1,
    2,
    3
  ],
  "vehicles": [
    1,
    2,
    3
  ],
  "tools": [
    1,
    2,
    3
  ],
  "documents": [
    1,
    2,
    3
  ],
  "tags": [
    1,
    2,
    3
  ]
}

Response

The request was successful.