SubscriberProfileField v1.2

Subscriber profiles allow you to have custom data associated with a subscriber. Use subscriberProfileField to manage the data fields themselves and subscriberProfileData to manage the data held by them.

What can I do with subscriberProfileField?

Create and manage subscriber profile fields in order to store custom information alongside your subscriber records, using subscriberProfileData. These fields can be utilised in a number of places.

  • The columnheader attribute is used when a subscriber submits a form. In the Sign-Up.to system it is also used when personalising messages and identifing the field to store data against when importing.
  • Common attributes of a subscriber are available through subscriber; be sure to check a suitable attribute doesn't already exist before creating a new subscriberProfileField!

Setting goaltracking to "true" will allow subscriberProfileData to be updated when a Goal Tracking event occurs.

GET /subscriberProfileField or /subscriberProfileField/:id

AttributeTypeFilterSortDescription
id
intYesYesUnique ID of the subscriber profile attribute.
columnheader
stringYesYesThe header used to identify data for this attribute in imports. Must be unique.
format
arrayNoNoApplication data containing formatting information.
name
stringYesYesA name for the profile attribute.
type
enumYesNoAttribute type can be "string", "decimal", "date". Default "string".
goaltracking
boolYesNoWhether data in the attribute can be updated by Goal Tracking events. Default "false".
cdate
decimalNoYesCreation timestamp.
mdate
decimalNoNoLast modification timestamp.

format contains legacy application formatting information.

HEAD /subscriberProfileField or /subscriberProfileField/:id

AttributeTypePresenceDescription
id
intOptionalUnique ID of the subscriber profile attribute.
columnheader
stringOptionalThe header used to identify data for this attribute in imports. Must be unique.
name
stringOptionalA name for the profile attribute.
type
enumOptionalAttribute type can be "string", "decimal", "date". Default "string".
goaltracking
boolOptionalWhether data in the attribute can be updated by Goal Tracking events. Default "false".

POST /subscriberProfileField

AttributeTypePresenceDescription
columnheader
stringRequiredThe header used to identify data for this attribute in imports. Must be unique.
name
stringRequiredA name for the profile attribute.
type
enumOptionalAttribute type can be "string", "decimal", "date". Default "string".
goaltracking
boolOptionalWhether data in the attribute can be updated by Goal Tracking events. Default "false".

All fields are created with a type of string, this means that only one subscriberProfileData string value can be stored per subscriber.

PUT /subscriberProfileField or /subscriberProfileField/:id

AttributeTypePresenceDescription
id
intRequiredUnique ID of the subscriber profile attribute.
columnheader
stringOptionalThe header used to identify data for this attribute in imports. Must be unique.
name
stringOptionalA name for the profile attribute.
goaltracking
boolOptionalWhether data in the attribute can be updated by Goal Tracking events. Default "false".

If columnheader is modified and the field is referenced by a form, the form won't display this field or capture any data.

DELETE /subscriberProfileField or /subscriberProfileField/:id

AttributeTypePresenceDescription
id
intRequiredUnique ID of the subscriber profile attribute.

If referenced by a form, this field will no longer display or capture data.

Any data held in subscriberProfileData which matches the given id will be removed.

Error codes

There are no error codes for this endpoint.

Examples

Have you seen our example of this endpoint being used with other endpoints?

JSON response

{
    "id":                 412,
    "columnheader":       "favourite_colour",
    "name":               "Favourite colour",
    "type":               "string",
    "goaltracking":       true,
    "format":             [{
                              "type": "select_single",
                              "value": [
                                  "Pink",
                                  "Blue",
                                  "Yellow"
                              ],
                              "size": "3"
                          }]
    "cdate":              1234567890,
    "mdate":              1412754091
}