Create an audit.

Authorization

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

slug*string

Match^[a-z0-9-]+$

Length1 <= length

name*string

Length2 <= length <= 255

type?|null

started?string|null

ended?string|null

auditor?string|null

notes?string|null

archivedAt?string|null

organizationId*string

frameworkId?string|null

Response Body

`application/json`

curl -X POST "https://example.com/audits/" \  -H "Content-Type: application/json" \  -d '{    "slug": "string",    "name": "string",    "organizationId": "string"  }'

{
  "id": "string",
  "slug": "string",
  "name": "string",
  "type": "CERTIFICATION",
  "started": "string",
  "ended": "string",
  "auditor": "string",
  "notes": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "archivedAt": "string",
  "organizationId": "string",
  "frameworkId": "string"
}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

How is this guide?

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`