Forms

Attach a document template to a form

POST/forms/{id}/templates
forms:writeadd_form_templatesIdempotent

Attaches one document template to the form by its guid and returns the set. One already attached changes nothing. An id that is no live template returns 422 exists. dry_run shows the set without saving it. Emits form.updated with templates as the changed field, only when the set changes, and sends no email. DELETE /forms/{id}/templates/{member_id} undoes it.

Path parameters

  • idstring (uuid)Required#

    The form's id, a uuid. An unknown id, or a hidden form, returns 404.

Query parameters

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Headers

  • Idempotency-Keystring#

    Makes a retry safe. Send a new UUID for each new request and reuse it only to retry that request; the first response is replayed for 24 hours.

Request body

application/json, required · FormTemplateAdd

  • idstring (uuid)Required#

    The guid of the document template to attach.

{
  "id": "4d1f1c64-6b7d-4a8e-9f10-2a3b4c5d6e7f"
}

Responses

200

Every template attached to the form.

FormTemplate[]
{
  "data": [
    {
      "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "name": "string"
    }
  ]
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X POST https://your-org-domain/kong/core/api/v2/forms/{id}/templates\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "id": "4d1f1c64-6b7d-4a8e-9f10-2a3b4c5d6e7f"
}'