/membervariables – Alida Help Center

Resource URL

/v1/applications/{communityApiKeyName}/membervariables

Note:

Use the appropriate regional endpoint to ensure that you comply with your organization's privacy policy, and applicable laws and regulations. For details about the available regional endpoints, and how to identify your organization's region, see Shared responsibility.

Available Methods

Method	Description
GET	Get a collection of Member Variables.
POST	Create a Member Variable.

Parameters

Parameters can be appended to the request to further refine the results returned.

Operation	Description	Example
Refine the response by field	To reduce the number of fields returned, specify the fields in a comma separated list.	`/membervariables?fields=constraints`
Filtering by value	By default, all the items are returned unless you specify your criteria using the variable name and value You can filter the response on the values in all of the available fields except for: `id` `categories` `memberVariableValues` `constraints`	`/membervariables?name=satisfaction`
Paging	The default is 20 items are returned at a time and the maximum is 1000.	Use the `limit` and `offset` query string parameters to effectively page through the results.
Sorting	You can sort the results on all of the available fields except for: `constraints` `categories` `memberVariableValues`	`/membervariables?sort=type:d`

For more information, see Content control.

Field Descriptions

Field Description

categories The string value for the member variable category. Possible values are profileVariable, systemVariable. or both.

constraints

The constraints collection specifies a set of behaviors that the system will implement for a given Member Variable. For the most part, these need not be adjusted from their defaults. For each supported constraint in the collection, a boolean value is recorded.

Property	Description
`disabled`	Not implemented
`hidden`	When set to `true`, the Member Variable will no longer be returned when sending a GET request to the `/membervariables` resource. However, it will remain accessible by specifying an `id` using the `/membervariables/{id}` resource.
`readOnly`	Not implemented
`returnLatest`	When set to `true`, this indicates that the latest Member Value should always be returned. This is true for System Variables such as `email`. This behavior can be seen in the `/membervalues/asof/{datetime}` resource.
`uniquePerMember`	When this constraint is set to `true`, the service will ensure that a given Member Variable Value is only ever assigned (including historically) to one member. The purpose of enabling this constraint is for implementing identity such as the `email` System Variable. It can also be set for non-System Variables and is helpful when integrating another system that has its own means of uniquely identifying members.

createdBy The GUID for the user who created the record.

createDate The date timestamp (UTC) for when the record was created.

dataType

The string value for the value definition (for example, number).

A Member Variable also has a datatype property, which controls the type of storage and retrieval of its Member Variable Values.

A datatype can be:

text
date
numeric

description The string name for the member variable.

id The GUID for the given member variable.

href A link that points to specific member variable.

lastUpdatedBy The GUID for the user who last updated the record.

lastUpdateDate The date timestamp (UTC) for when the record was last updated.

links This field is always empty.

memberVariableValues The link that points to the member variable values.

name The string name for the member variable.

referenceMemberVariableId The profile variable referenced by a calculated date profile variable. This field is only returned for calculated dates. The referenced variable must be set with the type: Open and the dataType: Date.

sensitive

The boolean value indicating whether or not the variable is eligible to be purged or modified.

You cannot POST a new value to the following sensitive system variables:

email
firstname
lastname
name
signupemail
signupfirstname
signuplastname
unsubscribereasonother
username

sequenceId This is an internal field.

source

The string value for the variable type. Possible values are:

system
profile

This field may also be empty.

type

The string value for question type. Possible values are:

open: Allows only a single Member Value to be assigned at any time, but indicates an unlimited number of possible values.
Sample question: Which city do you live in?
singleChoice:Allows one Member Value to be assigned to a member at any point in time.
Sample question: Which city do you live in?
multiChoice: Allows more than one Member Value to be assigned at any point in time.
Sample question: Select all the grocery stores you have shopped at from the list.

Note: Both singleChoice and multiChoice indicate a finite list of choices. For example, a list of answer options in a Multiple Choice question.

GET response structure


{
   "meta": {
      "offset": 0,
      "limit": 20,
      "count": 1
   },
   "items": [
      {
         "id": <GUID for member variable>,
         "name": <member variable name>,
         "description": <member variable description>,
         "source": <system|profile>,
         "type": <question type>,
         "dataType": <text|numeric|date>,
         "constraints": {
            "disabled": <true|false>,
            "hidden": <true|false>,
            "readOnly": <true|false>,
            "returnLatest": <true|false>,
            "uniquePerMember": <true|false>
         },
         "categories": [
            <array of profileVariable|profileVariable>
         ],
         "memberVariableValues": {
            "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/membervariables/membervariablevalues?memberVariableId={GUID for member variable}"
         },
         "sequenceId": <integer>,
         "sensitive": <true|false>,
         "createDate": <date and time UTC>,
         "lastUpdateDate": <date and time UTC>,
         "createdBy": <GUID of user>,
         "lastUpdatedBy": <GUID of user>,
         "links": [],
         "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/membervariables/{GUID for member variable}"
      }
   ],
   "links": [
      {
         "rel": "first",
         "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/membervariables?offset=0&limit=20"
      },
      {
         "rel": "prev"
      },
      {
         "rel": "last",
         "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/membervariables?offset=20&limit=20"
      },
      {
         "rel": "next",
         "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/membervariables?offset=20&limit=20"
      }
   ],
   "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/membervariables"
}

POST Behavior

The /membervariables resource can be created by sending a POST request either for a single item or a collection to /membervariables.

The following table indicates which properties must be included in a POST request, as well as the default values that will be set when not included.

Property	Required on POST?	Default	Notes
`categories`	No	`["profileVariable"]`
`constraints`	No	`false` for all
`dataType`	No	`text`
`description`	No	Proper-cased `name`	The maximum number of characters is 2000.
`name`	Yes	User input required, lowercased	The maximum number of characters is 400.
`referenceMemberVariableId`	No	A field ID, or list of field IDs	Used for Calculated Date profile variables
`sensitive`	No	false	For Calculated Dates, indicates that the referenced profile variable is sensitive.
`source`	No	Empty string
`type`	No	`singleChoice`

Example: POST /membervariables

[
   {
      "name": "City",
      "type": "singleChoice",
      "dataType": "text"
   },
   {
      "name": "Date of Birth",
      "type": "open",
      "dataType": "date"
   },
   {
      "name": "Areas of Interest",
      "type": "multiChoice",
      "dataType": "text"
   },
   {
      "name": "Income",
      "type": "open",
      "dataType": "numeric"
   },
   {
      "name": "Current Age",
      "type": "open",
      "dataType": "text",
      "sensitive": "true",
      "referenceMemberVariableId": "0872f5f9-d5b4-49a7-a5d7-afb201083a97"
    }
]

Sensitive Fields

All of the Member Variables contain a boolean property named sensitive. This property indicates whether or not the variable is eligible to be purged or modified.