Update Engagement

Use this API to update an existing engagement.

πŸ—’

Things to Know

  • For date and time attributes, the formatting should follow the YYYY-MM-DDTHH:MM:SSZ format.
  • An engagement's workflow or stage cannot be updated using this API.
  • If the orgGroupId parameter is not passed in the request, the engagement will be created with the same organization assigned to the engagement's vendor. If the orgGroupId parameter value is invalid, then an invalid organization error will be sent.
  • The name of the engagement must be 500 characters or less.
Path Params
uuid
required

The unique identifier of an engagement. The value can be obtained using the Get Engagements API.

Body Params
string
required
length between 1 and 500

The updated name of the engagement.

uuid

The organization identifier for engagement.

string
length ≀ 255

The email of internal owner for engagement.

string
length ≀ 500

The external contact for the engagement.

string
length ≀ 4000

The notes about the engagement.

date

The start date of the engagement.

date

The end date of the engagement.

string
length ≀ 2000

The scope of the engagement.

attributeValues
object

The custom attributes for the engagement.

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language
Credentials
OAuth2
Missing 2 required scopes
URL
Response
Choose an example:
application/json
*/*