Patch assignment

patch

https://example.com/api/v1/assignments/{assignmentId}

Patches supplied properties for an assignment by unique ID

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Updates a specific assignment using a assignment ID supplied as a URL parameter. Accepted attributes are listed in the body parameters section below.

Path Params

assignmentId

int32

required

Assignment Id

Body Params

Model for updating the assignment

number

string | null

Assignment number

name

string | null

Assignment name

startDate

date-time | null

Assignment start date

endDate

date-time | null

Assignment end date. Set to null to remove end date on existing assignment.

jobTitle

string | null

Job Title

poNumber

string | null

Purchase order number

hoursPerDay

double | null

Hours per day

primaryApprover

object | null

Primary approver

secondaryApprover

object | null

Secondary approver

automaticApproval

boolean | null

Automatic approval

rateTemplateId

int32 | null

Rate template Id

rates

object | null

Rates

consultants

array of objects | null

Consultants allocated to the assignment.

consultants

updateEndDate

boolean

Whether to update the Assignment.EndDate.

overrideInvoiceContact

boolean | null

invoicingContactName

string | null

invoicingContactEmail

string | null

invoicingContactEmailCC

string | null

invoicingContactPhone

string | null

invoicingContactRole

string | null

Responses

Language

Credentials

http

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Patch assignment

What’s Next

What’s Next

200Returns a success response

400If invalid inputs have been supplied

404If assignment is not found

What’s Next

What’s Next