Create Engagement

post

https://{hostname}/api/vendor/v1/vendor-engagements

Use this API to create a new engagement.

🗒
Things to Know

For date and time attributes, the formatting should follow the YYYY-MM-DDTHH:MM:SSZ format.

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.

Body Params

name

string

required

length between 1 and 500

The name for new engagement creation.

vendor

object

required

The vendor for new engagement creation.

orgGroupId

uuid

The organization identifier for new engagement.

type

string

enum

The type for new engagement creation.

Allowed:

internalOwnerEmail

string

length ≤ 255

The internal owner email for new engagement.

externalContact

string

length ≤ 500

The external contact for new engagement.

notes

string

length ≤ 4000

The notes for new engagement creation.

startDate

date

The start date for new engagement.

endDate

date

The end date for new engagement.

scope

string

length ≤ 2000

The scope for new engagement creation.

attributeValues

object

The custom attributes for new engagement.

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

201Created

429Too Many Requests. For more information, see API Rate Limits.