Update Engagement

Updates the details of a specific engagement.

Request

Path Params

engagementID

integer <int32>

required

The unique identifier of the engagement to update.

Body Params application/json

EngagementID

integer <int32>

optional

Gets the unique identifier for the engagement.

DivisionID

integer <int32> | null

optional

Sets the identifier for the division associated with the engagement.

Title

string | null

optional

Sets the title of the engagement.

Code

string | null

optional

Sets the code of the engagement.

Type

string | null

optional

Sets the type of the engagement.

Period

string | null

optional

Sets the period of the engagement.

Year

integer <int32> | null

optional

Sets the year of the engagement.

StartDate

string <date-time> | null

optional

Sets the start date of the engagement.

DueDate

string <date-time> | null

optional

Sets the due date of the engagement.

OwnerID

integer <int32> | null

optional

Sets the identifier for the owner of the engagement.

Status

enum<integer> <int32>

optional

Allowed values:

0110-100-5

ProfessionalUsers

array[object (APIEngagementUser) {2}] | null

optional

Sets the dictionary of professional users associated with the engagement.
The key is the user ID and the value is an optional role identifier.

UserID

integer <int32>

optional

RoleID

integer <int32>

optional

ClientUsers

array[object (APIEngagementUser) {2}] | null

optional

Sets the dictionary of client users associated with the engagement.
The key is the user ID and the value is an optional role identifier.

UserID

integer <int32>

optional

RoleID

integer <int32>

optional

Example

{
  "EngagementID": 0,
  "DivisionID": 0,
  "Title": "string",
  "Code": "string",
  "Type": "string",
  "Period": "string",
  "Year": 0,
  "StartDate": "2019-08-24T14:15:22Z",
  "DueDate": "2019-08-24T14:15:22Z",
  "OwnerID": 0,
  "Status": 0,
  "ProfessionalUsers": [
    {
      "UserID": 0,
      "RoleID": 0
    }
  ],
  "ClientUsers": [
    {
      "UserID": 0,
      "RoleID": 0
    }
  ]
}

Request

Responses