Custom Access Codes

Custom access codes are used to get an access link to surveys. They can be created via the API and can be linked to none (anonymous), one or multiple profiles and a survey.

Custom Access Code Structure

Here is an example profile structure followed by a full list of the attributes that are available for a profile:

{
  "data": {
    "type": "CustomAccessCodeV1",
    "attributes": {
      "code": "5S767T",
      "singleParticipation": true,
      "expiresAt": "2020-06-23T21:27:00.000+01:00",
      "createdAt": "2023-11-09T06:28:02+00:00"
    },
    "relationships": {
      "subject": {
        "data": {
          "type": "ProfileV1",
          "id": "/en/v1/profiles/86a8a563-93c6-5ee0-8925-45d32e02490b"
        }
      },
      "object": {
        "data": {
          "type": "ProfileV1",
          "id": "/en/v1/profiles/86a8a563-93c6-5ee0-8925-45d32e02490b"
        }
      },
      "survey": {
        "data": {
          "type": "SurveyV1",
          "id": "/en/v1/surveys/61cd3277-542e-11ea-a019-4201ac1ac00f"
        }
      }
    }
  }
}

Available Properties

Code

The custom access code that is used in the url to access the participation view.

e.g. https://feedback.echonovum/5S767T

Property: code

Type: string

Required: true

Length: 6

Single Participation

Custom access codes can be set to allow only a single participation. This means that the access code can only be used once.

Property: singleParticipation

Type: boolean

Required: true

Expiration Date

Custom access codes can be set to expire at a specific date and time. After the expiration date, the access code can no longer be used.

Property: expiresAt

Type: string

Format datetime

Required: true

Creation Date

The date and time when the custom access code was created.

Property: createdAt

Type: string

Format datetime

Required: true

Relationships

Custom access codes can be linked to profiles and surveys.

Subject

The profile that participates in the survey.

Property: subject within the relationships object

Type: object

Required: false

Object

The object in the survey. Usually contains event data.

Property: object within the relationships object

Type: object

Required: false

Survey

The survey that is shown when accessing the custom access code.

Property: survey within the relationships object

Type: object

Required: false

Last modified: 27 May 2024