Induction registrations

Edit a project's induction content

Updates the induction body (markdown) and/or the acknowledgement (intro + numbered points). Edits apply to future visitors only — past registrations keep their snapshot. Admin or the project's Site Manager.

PATCH
/projects/{id}/induction

Updates the induction body (markdown) and/or the acknowledgement (intro + numbered points). Edits apply to future visitors only — past registrations keep their snapshot. Admin or the project's Site Manager.

Authorization

x-api-key<token>

The per-tenant API key, copied from Settings → API & integrations. Sent as the x-api-key request header. The key is tenant-scoped and acts with Admin-equivalent, tenant-wide access.

In: header

Path Parameters

id*string

Resource id.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

All fields optional. content is the markdown body (send "" to clear it); acknowledgement replaces the wording visitors sign against.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/induction" \  -H "Content-Type: application/json" \  -d '{}'
{  "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",  "projectName": "string",  "content": "string",  "acknowledgement": {    "intro": "string",    "points": [      "string"    ]  }}
{  "error": {    "code": "unauthorized",    "message": "Missing or invalid API key."  }}
{  "error": {    "code": "read_only",    "message": "Your subscription is inactive. This action is read-only."  }}
{  "error": {    "code": "not_found",    "message": "Not found."  }}
{  "error": {    "code": "validation",    "message": "One or more inputs are invalid.",    "fields": {      "fieldName": "A message explaining what's wrong with this field."    }  }}