5 endpoints.
| Method | Path | Summary |
|---|---|---|
GET | /api/communities/{communityId}/join-settings | Read Settings › Join — the draft, what is published, and the pending counts |
POST | /api/communities/{communityId}/join-settings/discard | Throw the draft away and return to the published version |
PUT | /api/communities/{communityId}/join-settings/draft/form | Save the questions and documents of the draft (Professional and Enterprise) |
PUT | /api/communities/{communityId}/join-settings/draft/general | Save the General tab of the draft (description, post-submit message, cooldown, retention, form switch) |
POST | /api/communities/{communityId}/join-settings/publish | Publish the draft; bumps the version applicants answer against |
GET /api/communities/{communityId}/join-settingsAuth: Bearer JWT required.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
communityId | path | yes | string | — |
Responses
| Status | Description | Body |
|---|---|---|
200 | Draft and published documents, version, questionsAvailable (plan), pending counts | — |
403 | Missing join_form:manage, or not a member | — |
POST /api/communities/{communityId}/join-settings/discardAuth: Bearer JWT required.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
communityId | path | yes | string | — |
Responses
| Status | Description | Body |
|---|---|---|
200 | The updated admin view | — |
PUT /api/communities/{communityId}/join-settings/draft/formAuth: Bearer JWT required.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
communityId | path | yes | string | — |
Responses
| Status | Description | Body |
|---|---|---|
200 | The updated admin view | — |
400 | JOIN_FORM_* with the offending path (e.g. sections.0.questions.2.label) | — |
403 | FEATURE_NOT_AVAILABLE when the plan lacks join_questions | — |
PUT /api/communities/{communityId}/join-settings/draft/generalAuth: Bearer JWT required.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
communityId | path | yes | string | — |
Responses
| Status | Description | Body |
|---|---|---|
200 | The updated admin view | — |
400 | JOIN_FORM_INVALID / JOIN_FORM_INVALID_SETTING / JOIN_FORM_TEXT_TOO_LONG / JOIN_FORM_INCOMPLETE, with the offending path | — |
POST /api/communities/{communityId}/join-settings/publishAuth: Bearer JWT required.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
communityId | path | yes | string | — |
Responses
| Status | Description | Body |
|---|---|---|
200 | The updated admin view | — |
400 | JOIN_FORM_INCOMPLETE with the path of the first unanswerable question | — |