InformdAPIForms
Close a form
Moves an open form to `closed`, stopping submissions. The actor must be an admin or owner of the form.
POST
/forms/{form_id}/closeMoves an open form to closed, stopping submissions. The actor
must be an admin or owner of the form.
Authorization
bearerAuth AuthorizationBearer <token>
JWT issued by IdentityX, signed with Ed25519
In: header
Path Parameters
form_id*string
Form ID.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/forms/497f6eca-6276-4993-bfeb-53cbbbba6f08/close"{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"namespace_id": "be493771-41ca-4fe5-8001-a41a148c3359",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"title": "string",
"status": "draft",
"opened_at": "2019-08-24T14:15:22Z",
"closed_at": "2019-08-24T14:15:22Z",
"archived_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}{
"detail": "string",
"instance": "../dictionary",
"errors": [
{
"field": "string",
"message": "string"
}
],
"type": "http://example.com",
"status": 401,
"title": "Unauthenticated"
}{
"detail": "string",
"instance": "../dictionary",
"errors": [
{
"field": "string",
"message": "string"
}
],
"type": "http://example.com",
"status": 403,
"title": "Insufficient Role"
}{
"detail": "string",
"instance": "../dictionary",
"errors": [
{
"field": "string",
"message": "string"
}
],
"type": "http://example.com",
"status": 404,
"title": "Not Found"
}{
"detail": "string",
"instance": "../dictionary",
"errors": [
{
"field": "string",
"message": "string"
}
],
"type": "http://example.com",
"status": 409,
"title": "Form Name Taken"
}{
"detail": "string",
"instance": "../dictionary",
"errors": [
{
"field": "string",
"message": "string"
}
],
"type": "http://example.com",
"status": 500,
"title": "Internal Server Error"
}