Sign in
latestOpenAPI 3.0.02026-08-216686147.9 KB

6f6009a58cdd

engagements

Create a new Engagement from a template

Creates a new Engagement based on an existing template Engagement. The request is accepted for asynchronous processing; the response returns the new Engagement's UUID and the Job UUID used to poll its provisioning status.

post/v1/engagements/from-template

Request body

template_uuidstring uuid required
client_company_uuidstring uuid required
namestring required
start_datestring
end_datestring
report_issue_datestring
identifierstring nullable

An external identifier that can be used by integrated systems

Example request

{
  "template_uuid": "821e8d9e-d2a8-480f-9187-5a685d3d0d71",
  "client_company_uuid": "022723f4-1d6a-4c6c-9387-f63c7d66f0fc",
  "name": "SOC 2 - Type 1",
  "start_date": "2023-07-30",
  "end_date": "2023-07-30",
  "report_issue_date": "2023-07-30",
  "identifier": "E0001-A"
}

Response

The Engagement creation has been accepted for processing

Example response

{
  "data": {
    "uuid": "821e8d9e-d2a8-480f-9187-5a685d3d0d71",
    "job_uuid": "2d2e102e-f4af-4534-9749-4d9249eca6cc",
    "_links": {
      "status": {
        "href": "https://example.com/resource/or/path",
        "title": "A description for the link",
        "type": "text/html"
      }
    }
  }
}