Profiles

Profile Structure

Here is an example profile structure followed by a complete list of properties that are available for a profile:

{
  "type": "ProfileV1",
  "id": "/en/v1/profiles/fe14dace-7832-4b64-9bfd-9f8b7690883a",
  "attributes": {
    "uuid": "fe14dace-7832-4b64-9bfd-9f8b7690883a",
    "identifier": "Employee ID",
    "name": "Name",
    "attributes": {
      "Employee ID": "SIR",
      "Name": "Siri",
      "Department": "Customer Success",
      "Email": "siri@echonovum.com",
      "Mobile": "+41790000000",
      "Role": "CS Hero"
    },
    "accessCodes": {
      "subject": "PsV434",
      "object": "MgP2e3"
    },
    "allowMultisurvey": false
  }
}

Available Properties

UUID

The unique identifier of the profile.

Property: uuid

Type: string

Required: true

Identifier

The name of the attribute that defines the identifier of the profile. It is part of the attributes object.

Property: identifier

Type: string

Required: true

Name

The name of the attribute that defines the name of the profile. It is part of the attributes object.

Property: name

Type: string

Required: true

Attributes

The attributes that are part of the profile. Key-value pairs where the key is the name of the attribute and the value is the value of the attribute.

Property: attributes

Type: object

Required: true

Access Codes

The access codes that are part of the profile.

Property: accessCodes

Type: object

Required: true

Allow Multi-Survey

Whether the profile is allowed to participate through the multiple survey view.

Property: allowMultisurvey

Type: boolean

Last modified: 29 May 2024