SubscriberProfileData 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 subscriberProfileData?

Store, fetch and search any custom subscriber data. If you require core subscriber data, use subscriber.

  • Personalise content for a subscriber by filtering subscriber_id.
  • Try searching for subscribers who match a particular value and subscriberprofilefield_id.
  • Use HEAD with subscriber_id and subscriberprofilefield_id to check whether a value exists for the subscriber.
  • Filtering by subscriberprofilefield_id will give you the stored data from that subscriberProfileField for each of your subscribers.

GET /subscriberProfileData or /subscriberProfileData/:id

AttributeTypeFilterSortDescription
id
stringYes*NoThe unique identifier of the subcriber profile data.
subscriber_id
intYes*YesThe unique identifier of the subscriber to which this record pertains.
subscriberprofilefield_id
intYes*YesThe identifier of the subscriber profile field for which this datum stores a value.
value
stringNoNoThe value stored within this subscriber's instance of the specified field.

*At least one of these attributes must be present in a GET request.

The id attribute is an artificial primary key made up of subscriberprofilefield_id and subscriber_id. Please note that its type is string.

HEAD /subscriberProfileData or /subscriberProfileData/:id

AttributeTypePresenceDescription
id
stringOptional*The unique identifier of the subcriber profile data.
subscriber_id
intOptional*The unique identifier of the subscriber to which this record pertains.
subscriberprofilefield_id
intOptional*The identifier of the subscriber profile field for which this datum stores a value.

*At least one of these attributes must be present in a HEAD request.

POST /subscriberProfileData

AttributeTypePresenceDescription
subscriber_id
intRequiredThe unique identifier of the subscriber to which this record pertains.
subscriberprofilefield_id
intRequiredThe identifier of the subscriber profile field for which this datum stores a value.
value
stringRequiredThe value stored within this subscriber's instance of the specified field.

PUT /subscriberProfileData or /subscriberProfileData/:id

AttributeTypePresenceDescription
id
stringOptionalThe unique identifier of the subcriber profile data.
subscriber_id
intOptional*The unique identifier of the subscriber to which this record pertains.
subscriberprofilefield_id
intOptional*The identifier of the subscriber profile field for which this datum stores a value.
value
stringRequiredThe value stored within this subscriber's instance of the specified field.

*Both of these attributes are mandatory in a PUT request unless id is present.

DELETE /subscriberProfileData or /subscriberProfileData/:id

AttributeTypePresenceDescription
id
stringOptional*The unique identifier of the subcriber profile data.
subscriber_id
intOptional*The unique identifier of the subscriber to which this record pertains.
subscriberprofilefield_id
intOptional*The identifier of the subscriber profile field for which this datum stores a value.

*At least one of these attributes must be present in a DELETE request.

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":                           "12345_87654321",
    "subscriber_id":                87654321,
    "subscriberprofilefield_id":    12345,
    "value":                        "Ice cream"
}