Create a kit

post

https://example.com/v1/kit/{kitType}

Use this to create a kit. The response contains the generated kit ID. To update an existing kit, use PATCH /kit/{kitType}/{kitId}.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

kitType

string

required

Name of the kit type

Query Params

locale

string

Language locale of the user creating the kit

slimResponse

boolean

Only return the generated kit ID instead of the answers.

updateChangeDateForInterface

boolean

Set to false to cause the profile change to not update interface change dates. This will prevent the change from causing the connection to show up on the change list.

transformation

string

Name of transformation template to apply to kit.

strictValidation

boolean

Opt into canonical answer-format and eligibility preflight with true. False skips this preflight only; permissions, kit access and row-deletion authorization always apply. Omission currently preserves legacy behavior; the server may later default to strict validation, with false remaining an explicit opt-out. This is not a dry run: accepted requests still write data.

Body Params

JSON document of answer key/values

Map of exact answer keys to write values. Values may be scalars, arrays, objects, or null where the question supports clearing. Question-specific types, permissions, and constraints still apply. GET representations are not necessarily valid write values. For a file upload use {fileName, fileContentsBase64} with raw padded base64. For an existing repeating-group row include its id; omitting id creates a new row.

Responses

403

Kit mutations require current VIEW and WRITE permission for the active entity and kit type; denial rejects before transformations, uploads or persistence. Effective row-deletion permission is checked before uploads and persistence, independently of observe mode. Enforce-mode preflight may reject unsupported deletion syntax earlier.

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201JSON document of created kit data. Document properties are answer keys.