For AI agents: a documentation index is available at https://apidocs.zerionsoftware.com/doc/iformbuilder-v81/llms.txt. Markdown versions of each page are available by sending an Accept: text/markdown header, or by appending .md to the page URL.
Show more

Use to navigate results, ENTER to select one, ESC to close

Type in any word to easily find the endpoint, property or group of operations you are looking for.

Zerion APIs hub
  • Dataflow Automation
  • iFormBuilder V60
  • iFormBuilder V80
  • iFormBuilder V81
  • Zerion Identity
Back to hub page
API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
iFormBuilder V81

Topics

  • Introduction
  • Authentication

Endpoints

  • Token Resource
    • Request Access Token POST
    • Inspect Token Attributes GET
  • Public Link Session Resource
    • Start Public Link Session POST
    • Get Public Link Session Form GET
    • Create Public Link Session Record POST
  • Profile Resource
    • Retrieve a Profile GET
    • Update a Profile PUT
    • Retrieve Company Info GET
    • Update Company Info PUT
    • Retrieve a List of Profiles GET
    • Create a New Profile POST
    • Retrieve Folder Icons GET
    • Create Folder Icons POST
    • Delete Folder Icons DELETE
  • API Client Resource
    • Retrieve a List of API Clients GET
    • Create an API Client POST
    • Retrieve an API Client GET
    • Update an API Client PUT
    • Delete an API Client DELETE
    • Reset an API Client Secret POST
  • User Resource
    • Retrieve a User GET
    • Update a User PUT
    • Delete a User DELETE
    • Retrieve a List of Users GET
    • Update a List of Users PUT
    • Create New Users POST
    • Delete a List of Users DELETE
    • Retrieve User Groups for a Specific User GET
    • Retrieve a Page Assignment with Page/User ID GET
    • Update a Page Assignment with Page/User ID PUT
    • Delete a Page Assignment with Page/User ID DELETE
    • Retrieve a List of Page Assignments GET
    • Update a List of Page Assignments PUT
    • Create New Page Assignments POST
    • Delete a List of Page Assignments DELETE
    • Retrieve the Signed-in User's Access to a Page GET
    • Retrieve a Record Assignment GET
    • Delete a Record Assignment DELETE
    • Retrieve a List of Record Assignments GET
    • Create New Record Assignments POST
    • Delete a List of Record Assignments DELETE
    • Retrieve a List of WebForms Browsers GET
    • Register a WebForms Browser POST
    • Delete a List of WebForms Browsers DELETE
    • Delete a WebForms Browser DELETE
  • User Group Resource
    • Retrieve a User Group GET
    • Update a User Group PUT
    • Delete a User Group DELETE
    • Retrieve a List of User Groups GET
    • Create New User Groups POST
    • Retrieve a User Assignment GET
    • Delete a User Assignment DELETE
    • Retrieve a List of User Assignments GET
    • Create New User Assignments POST
    • Delete a List of User Assignments DELETE
    • Retrieve a Page Assignment GET
    • Update a Page Assignment PUT
    • Delete a Page Assignment DELETE
    • Retrieve a List of Page Assignments GET
    • Update a List of Page Assignments PUT
    • Create New Page Assignments POST
    • Delete a List of Page Assignments DELETE
  • Page Resource
    • Retrieve a Page GET
    • Update a Page PUT
    • Copy a Page POST
    • Delete a Page DELETE
    • Retrieve a List of Pages GET
    • Create a New Page POST
    • Retrieve a List of Page Statuses GET
    • Retrieve the page feed GET
    • Retrieve a Page Localization GET
    • Update a Page Localization PUT
    • Delete a Page Localization DELETE
    • Retrieve a List of Page Localizations GET
    • Update a List of Page Localizations PUT
    • Create New Page Localizations POST
    • Delete a List of Page Localizations DELETE
    • Retrieve a Page Assignment GET
    • Update a Page Assignment PUT
    • Delete a Page Assignment DELETE
    • Retrieve a List of Page Assignments GET
    • Update a List of Page Assignments PUT
    • Create New Page Assignments POST
    • Delete a List of Page Assignments DELETE
    • Retrieve Page Record Assignments GET
    • Delete Page Record Assignments DELETE
    • Retrieve a Page HTTP Callback GET
    • Update a Page HTTP Callback PUT
    • Delete a Page HTTP Callback DELETE
    • Retrieve a List of Page HTTP Callbacks GET
    • Create New Page HTTP Callbacks POST
    • Delete a List of Page HTTP Callbacks DELETE
    • Retrieve a List of Page Email Alerts GET
    • Create New Page Email Alerts POST
    • Delete a List of Page Email Alerts DELETE
    • Retrieve Page Email Alert Settings GET
    • Update Page Email Alert Settings PUT
    • Triggers POST Action POST
    • Retrieve a List of a Shared Page Entries GET
    • Update a Shared Page Entry PUT
    • Create New Share Page POST
    • Delete a Shared Page Entry DELETE
    • Retrieve a Page Dynamic Attribute GET
    • Update an Page Dynamic Attribute PUT
    • Delete an Page Attribute DELETE
    • Retrieve a List of Page Dynamic Attributes GET
    • Update a List of Page Dynamic Attributes PUT
    • Create New Page Attribute POST
    • Delete a List of Page Dynamic Attributes DELETE
    • Update Charset PUT
    • Retrieve a Field Index GET
    • Create a New Field Index POST
    • Delete a Field Index DELETE
    • Restore Deleted Media POST
    • Retrieve a List of Public Links GET
    • Update Public Links PUT
    • Create Public Links POST
    • Delete Public Links DELETE
  • Page Group Resource
    • Retrieve a Page Group GET
    • Update a Page Group PUT
    • Delete a Page Group DELETE
    • Retrieve a List of Page Groups GET
    • Create New Page Group POST
    • Retrieve a Page Group Page Assignment GET
    • Assign Page to Page Group POST
    • Delete Page from Page Group DELETE
    • Retrieve a Page Group User Assignment GET
    • Update a Page Group User Assignment PUT
    • Delete a Page Group User Assignment DELETE
    • Retrieve a List of Page Group User Assignments GET
    • Update a List of Page Group User Assignments PUT
    • Delete a List of Page Group's User Assignments DELETE
    • Create New Page Group Assignments POST
  • Element Resource
    • Retrieve an Element GET
    • Update an Element PUT
    • Copy an Element POST
    • Delete an Element DELETE
    • Retrieve a List of Elements GET
    • Update a List of Elements PUT
    • Create New Elements POST
    • Delete a List of Elements DELETE
    • Retrieve an Element Localization GET
    • Update an Element Localization PUT
    • Delete a Element Localization DELETE
    • Retrieve a List of Element Localizations GET
    • Update a List of Element Localizations PUT
    • Create New Element Localizations POST
    • Delete a List of Element Localizations DELETE
    • Retrieve an Element Dynamic Attribute GET
    • Update an Element Dynamic Attribute PUT
    • Delete an Element Attribute DELETE
    • Retrieve a List of Element Dynamic Attributes GET
    • Update a List of Element Dynamic Attributes PUT
    • Create New Element Attribute POST
    • Delete a List of Element Dynamic Attributes DELETE
  • Optionlist Resource
    • Retrieve an Optionlist GET
    • Update an Optionlist PUT
    • Copy an Optionlist POST
    • Delete an Optionlist DELETE
    • Retrieve a List of Optionlists GET
    • Create New a New Optionlist POST
    • Retrieve an Option GET
    • Update an Option PUT
    • Delete an Option DELETE
    • Retrieve a List of Options GET
    • Update a List of Options PUT
    • Create New Options POST
    • Delete a List of Options DELETE
    • Retrieve a Option Localization GET
    • Update a Option Localization PUT
    • Delete a Option Localization DELETE
    • Retrieve a List of Option Localizations GET
    • Update a List of Option Localizations PUT
    • Create New Option Localizations POST
    • Delete a List of Option Localizations DELETE
  • Record Resource
    • Retrieve a Record GET
    • Update a Record PUT
    • Copy a Record POST
    • Delete a Record DELETE
    • Retrieve a List of Records GET
    • Update a List of Records PUT
    • Create New Records POST
    • Delete a List of Records DELETE
    • Retrieve a Record Assignment GET
    • Delete a Record Assignment DELETE
    • Delete Record Media DELETE
    • Retrieve a List of Record Assignments GET
    • Create New Record Assignments POST
    • Delete a List of Record Assignments DELETE
  • Notification Resource
    • Send Notifications POST
  • Private Media Resource
    • Get Media GET
  • Media Storage Resource
    • Initiate Media Storage Connection POST
    • List Media Storage Connections GET
    • Create Media Storage Connection POST
    • List Shared Media Storage Connections GET
    • Delete Media Storage Connection DELETE
    • Set Active Media Storage Location PUT
    • List SharePoint Sites GET
  • Device License Resource
    • Retrieve a Device License GET
    • Retrieve a List of Device Licenses GET
  • Device Transaction Log Resource
    • Retrieve a Device Transaction Log GET
  • Async Transaction Log Resource
    • Retrieve an Async Transaction Log GET
    • Retrieve an Async Transaction Log Daily Summary GET
  • Mapbox Resource
    • Retrieve Mapbox Settings GET
    • Update Mapbox Settings PUT
    • Retrieve Profile Map Views GET
    • List Profiles with Map Views GET
    • Retrieve Profile Map View Settings GET
    • Update Profile Map View Settings PUT
  • Email Settings Resource
    • Retrieve Email Settings GET
    • Update Email Settings PUT
    • Restore Default SMTP DELETE
  • Usage Resource
    • Retrieve Usage GET
  • Branding Resource
    • Retrieve Branding Colors GET
    • Upload Branding Image POST
  • Server Features Resource
    • Retrieve Server Features GET
  • ArcGIS Integration Resource
    • Start ArcGIS Connection POST
    • Get ArcGIS Connection GET
    • Create ArcGIS Connection POST
    • Delete ArcGIS Connection DELETE
    • List ArcGIS Forms GET
    • List ArcGIS Feature Layers GET
    • Import ArcGIS Feature Layer POST
    • Link Form to ArcGIS Feature Layer PUT
    • Unlink Form from ArcGIS Feature Layer DELETE
    • Get ArcGIS Publish Status GET
    • Publish Form as ArcGIS Feature Layer POST
Powered by Bump.sh
Zerion APIs hub
  • Dataflow Automation
  • iFormBuilder V60
  • iFormBuilder V80
  • iFormBuilder V81
  • Zerion Identity
Back to hub page
API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
iFormBuilder V81

Create Public Link Session Record

Ask AI
  • Add to Cursor
  • Add to VSCode
  • Add to other AI tools (MCP)

  • Open in ChatGPT
  • Open in Claude

  • View as Markdown
  • Copy as Markdown

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.zerionsoftware.com/doc/iformbuilder-v81/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "iFormBuilder V81 MCP server": {
    "url": "https://apidocs.zerionsoftware.com/doc/iformbuilder-v81/mcp"
  }
}

Close
POST /public_link_sessions/current/pages/{page_id}/records
Public link session

Creates one record through a public link session. page_id is the link's page, or one of its subform pages for a subform record.

Monthly allowance

A record on the link's page takes one submission from the profile's public_link_monthly_limits for the current month before anything is written, under a lock, so concurrent submissions can never exceed it. At the limit, or when the profile has no limit, the call answers 429 and writes nothing. If the write then fails, the submission is given back. Crossing 75 %, 90 % and 100 % sends the public_link_email_alert e-mail once per threshold per month. Subform records do not count.

Subform records

Send parent_record_id, parent_page_id and parent_element_id. The parent must be a record this same session wrote, and parent_element_id must be the subform element on parent_page_id that points at page_id.

Fields

As POST /profiles/{profile_id}/pages/{page_id}/records, with these refused: encoding other than base64 (the server does not fetch URLs for a public link), is_media_internal, an extension other than jpg, jpeg or png, values for assign-to, sound and third-party file-upload elements, and multi-photo values.

Stored metadata

created_by and modified_by are publiclink:{link id}, created_location and modified_location are PUBLIC_LINK, and created_device_id identifies the session. None of them can be set by the caller.

Headers

  • Authorization string Required

    e.g. Bearer {session access_token}

Path parameters

  • page_id integer Required

    the link's page, or one of its subform pages

application/json

Body Required

  • fields array[object] Required
    Hide fields attributes Show fields attributes object
    • element_id integer
    • element_name string
    • value

      the value; base64 for media elements

    • extension string

      media file extension; omitted means png

      Values are jpg, jpeg, or png.

    • encoding string

      Value is base64.

  • parent_record_id integer

    subform records only

  • parent_page_id integer

    subform records only

  • parent_element_id integer

    subform records only

  • javascript_state string

Responses

  • 201 application/json

    Created - the record was written.

    Hide response attribute Show response attribute object
    • id integer Required

      id of the new record

  • 400 application/json

    Bad Request - the body is not one record object, a field is invalid for its element, a field uses a shape a public link does not accept (see the description), or the parent fields are missing or present when they should not be.

    Hide response attribute Show response attribute object
    • error_message string Required

      human-readable reason for the failure

  • 401 application/json

    Unauthorized - no session token, an unknown or expired one, or the link is no longer collecting.

    Hide response attribute Show response attribute object
    • error_message string Required

      human-readable reason for the failure

  • 403 application/json

    Forbidden - page_id is not the link's page or one of its subform pages, the parent fields do not name a real subform of page_id, the parent record was not written by this session, or public links are switched off.

    Hide response attribute Show response attribute object
    • error_message string Required

      human-readable reason for the failure

  • 404 application/json

    Not Found - page_id is not a number.

    Hide response attribute Show response attribute object
    • error_message string Required

      human-readable reason for the failure

  • 429 application/json

    Too Many Requests - the profile has used its public link submissions for this month (nothing is written), or this session has written its maximum number of records.

    Hide response attribute Show response attribute object
    • error_message string Required

      human-readable reason for the failure

POST /public_link_sessions/current/pages/{page_id}/records
curl \
 --request POST 'https://api.iformbuilder.com/exzact/api/v81/[servername]/public_link_sessions/current/pages/{page_id}/records' \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer pls_0123456789abcdef0123456789abcdef.0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef" \
 --data '{
  "fields": [
    {
      "element_name": "full_name",
      "value": "Jane Doe"
    },
    {
      "element_name": "photo",
      "value": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg==",
      "extension": "png"
    }
  ]
}'
Request example
{
  "fields": [
    {
      "element_name": "full_name",
      "value": "Jane Doe"
    },
    {
      "element_name": "photo",
      "value": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg==",
      "extension": "png"
    }
  ]
}
Response examples (201)
{
  "id": 1001
}
Response examples (400)
{
  "error_message": "string"
}
Response examples (401)
{
  "error_message": "string"
}
Response examples (403)
{
  "error_message": "string"
}
Response examples (404)
{
  "error_message": "string"
}
Response examples (429)
{
  "error_message": "string"
}