Public Access Links

Setting Actor Property Values on a Link

Changed on

Sets or unsets pre-registered Actor Property values on a Public Access Link. The body must contain a properties object mapping property names to string values or null. Sending null for a property unsets it.

Returns the extended Public Link, including a properties object containing all currently set property values.

Requires public_link.update permission.

patch/v1/projects/{projectId}/forms/{xmlFormId}/public-links/{linkId}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/projects/{projectId}/forms/{xmlFormId}/public-links/{linkId}
  • Auth
    none declared

Path parameters

projectIdnumber required

The numeric ID of the Project

xmlFormIdstring required

The xmlFormId of the Form being referenced.

linkIdinteger required

The numeric ID of the Link

Request body

propertiesobject

An object mapping actor property names to string values or null. Set a property by providing a string value; unset it by providing null.

Example request

{
  "properties": {
    "region": "North",
    "supervisor": null
  }
}

Response

Returns the extended Public Link with the updated properties.

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 actor

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.

propertiesobject nullable

An object mapping actor property names to their currently set string values for this Public Link. Only properties with values set are included. null if no properties have been set.

Example response

{
  "createdAt": "2018-04-18T23:19:14.802Z",
  "displayName": "My Display Name",
  "id": 115,
  "updatedAt": "2018-04-18T23:42:11.406Z",
  "deletedAt": "2018-04-18T23:42:11.406Z",
  "token": "d1!E2GVHgpr4h9bpxxtqUJ7EVJ1Q$Dusm2RBXg8XyVJMCBCbvyE8cGacxUx3bcUT",
  "createdBy": {
    "createdAt": "2018-04-18T23:19:14.802Z",
    "displayName": "My Display Name",
    "id": 115,
    "updatedAt": "2018-04-18T23:42:11.406Z",
    "deletedAt": "2018-04-18T23:42:11.406Z"
  },
  "properties": {
    "region": "North"
  }
}

Changes