Sign in
Public Access Links

Creating a Link

To create a new Public Access Link to this Form, you must send at least a displayName for the resulting Actor. You may also provide once: true if you want to create a link that can only be filled by each respondent once. This setting is enforced by Enketo using local device tracking; the link is still distributable to multiple recipients, and the enforcement can be defeated by using multiple browsers or devices.

You may also optionally provide a properties object to set pre-registered Actor Property values on the Link at creation time.

post/v1/projects/{projectId}/forms/{xmlFormId}/public-links

Path parameters

projectIdnumber required

The numeric ID of the Project

xmlFormIdstring required

The xmlFormId of the Form being referenced.

Response

OK

createdAtstring required

ISO date format

displayNamestring required

All Actors, regardless of type, have a display name

idnumber required
type'user' | 'field_key' | 'public_link' | 'singleUse' required

the Type of this Actor; typically this will be user.

updatedAtstring

ISO date format

deletedAtstring

ISO date format

tokenstring

If present, this is the Token to include as the st query parameter for this Public Link. If not present, this Public Link has been revoked.

onceboolean

If set to true, an Enketo single submission survey will be created instead of a standard one, limiting respondents to a single submission each.

Changes

Changed in 4 of the 54 revisions of this API.15

  • dcd5409827e11See the full diff
    • ○

      added the new optional request property properties

      new-optional-request-property

  • 022694254f0d1See the full diff
    • ○

      api operation id Creating a Link removed and replaced with createLink

      api-operation-id-removed

  • b11b54eea4871See the full diff
    • ○

      removed the non-success response with the status 403

      response-non-success-status-removed

  • e8c2858fd4eb12See the full diff
    • ●

      removed the request property properties

      request-property-removed

    • ○

      api operation id createLink removed and replaced with Creating a Link

      api-operation-id-removed

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog