Forms

Create Form

Create a hosted form without sending it. <br>

Returns the form object including its public URL — https://forms.pinnacle.sh/{form_id}. <br>

To also deliver the URL to a recipient over SMS or RCS in a single call, use POST /forms/send.

post/forms

Request

  • Base URL: https://api.pinnacle.sh
  • URL: https://api.pinnacle.sh/forms
  • Auth: API key in header PINNACLE-API-KEY

Request body

namestring

Human-readable name for the form. Rendered as the form's title.

descriptionstring

Longer description rendered below the title.

can_updateboolean

If true, the recipient can reopen the submission URL and edit their answers. When false (default), the submission URL becomes read-only (Already submitted) after the first submit.

expires_atstring date-time

After this timestamp the form stops accepting submissions. Omit for no expiration.

Response

Form created.

idstring required

Form id (starts with form_).

urlstring required

Public shareable URL of the form (https://forms.pinnacle.sh/{form_id}).

namestring nullable required

Human-readable name for the form. Rendered as the form's title.

descriptionstring nullable required

Longer description rendered below the title.

can_updateboolean required

When true, the recipient can reopen the submission URL and edit their answers. When false, the URL becomes read-only after the first submit.

expires_atstring date-time nullable required

After this timestamp the form stops accepting submissions. Null means no expiration.

submission_countinteger required

Count of distinct completed submissions for this form. Does not increment on edits to an existing can_update=true submission.

last_submitted_atstring date-time nullable required

Timestamp of the most recent submission event. Updated on each new submit and on each edit of a can_update=true submission.

archived_atstring date-time nullable required

When set, the form is archived (soft-deleted) and cannot accept new submissions or be updated. Restore by PATCHing archived_at back to null.

created_atstring date-time required

ISO 8601 timestamp of when the form was created.

updated_atstring date-time required

ISO 8601 timestamp of the most recent form mutation.

Changes

No recorded changes to this operation across all 1 revision of this API.