Update Engagement - AuditDashboard Developer Portal

Updates the details of a specific engagement.

A non-empty ProfessionalUsers or ClientUsers replaces that whole side of the team; omitted or empty leaves it untouched.
RoleID 0 keeps an existing role, otherwise assigns the default (Request Administrator for firm, General for client).

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params

application/json

Required

Example

{
    "engagementID": 0,
    "divisionID": null,
    "title": "string",
    "code": "string",
    "type": "string",
    "period": "string",
    "year": null,
    "fieldworkStartDate": null,
    "fieldworkEndDate": null,
    "deliverableDueDate": null,
    "clearDeliverableDueDate": true,
    "ownerID": null,
    "status": null,
    "addToSchedule": null,
    "professionalUsers": [
        {
            "userID": 0,
            "roleID": 0
        }
    ],
    "clientUsers": [
        {
            "userID": 0,
            "roleID": 0
        }
    ],
    "automations": {
        "inProgress": null,
        "inProgressDate": null,
        "complete": null,
        "completeDate": null
    }
}

Responses

🟢200

application/json

OK: Returns the updated engagement.

Body

Example

{
    "engagementID": 0,
    "importKey": "string",
    "divisionID": null,
    "companyID": 0,
    "title": "string",
    "code": "string",
    "type": "string",
    "period": "string",
    "year": null,
    "fieldworkStartDate": null,
    "fieldworkEndDate": null,
    "deliverableDueDate": null,
    "ownerID": null,
    "onSchedule": true,
    "globalModification": "2019-08-24T14:15:22.123Z",
    "status": {
        "value": 0,
        "name": "string"
    },
    "created": {
        "by": 0,
        "on": "2019-08-24T14:15:22.123Z"
    },
    "modified": {
        "by": 0,
        "on": "2019-08-24T14:15:22.123Z"
    },
    "professionalUsers": [
        {
            "userID": 0,
            "roleID": 0
        }
    ],
    "clientUsers": [
        {
            "userID": 0,
            "roleID": 0
        }
    ],
    "requests": [
        0
    ]
}

🟠400

🟠403

🟠404