Profiles

Profiles represent the customers in your e-commerce platform. They contain personal information, subscription status, and custom attributes. All profile endpoints are scoped to a language.

The profile model

The profile model contains all the information about your customers, including their contact details, subscription preferences, and any custom attributes you've defined.

Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier for the profile.

  • Name
    email
    Type
    string
    Description

    The email address of the profile.

  • Name
    active
    Type
    boolean
    Description

    Whether the profile is active.

  • Name
    unsubscribed
    Type
    boolean
    Description

    Whether the profile has unsubscribed from communications.

  • Name
    subscribed_to_newsletter
    Type
    boolean
    Description

    Whether the profile is subscribed to the newsletter.

  • Name
    subscribed_to_newsletter_at
    Type
    timestamp
    Description

    Timestamp of when the profile subscribed to the newsletter.

  • Name
    double_opt_in
    Type
    boolean
    Description

    Whether the profile has confirmed via double opt-in.

  • Name
    first_name
    Type
    string
    Description

    The first name of the customer.

  • Name
    middle_name
    Type
    string
    Description

    The middle name of the customer.

  • Name
    last_name
    Type
    string
    Description

    The last name of the customer.

  • Name
    gender
    Type
    string
    Description

    The gender of the customer. One of male, female, or unidentified.

  • Name
    company_name
    Type
    string
    Description

    The company name associated with the profile.

  • Name
    telephone
    Type
    string
    Description

    The phone number of the customer.

  • Name
    street
    Type
    string
    Description

    The street address.

  • Name
    housenumber
    Type
    string
    Description

    The house number.

  • Name
    city
    Type
    string
    Description

    The city.

  • Name
    province
    Type
    string
    Description

    The province or state.

  • Name
    zipcode
    Type
    string
    Description

    The postal/zip code.

  • Name
    country_code
    Type
    string
    Description

    The ISO country code.

  • Name
    birthdate
    Type
    date
    Description

    The date of birth of the customer.

  • Name
    tags
    Type
    array
    Description

    An array of tags associated with the profile.

  • Name
    is_registered
    Type
    boolean
    Description

    Whether the customer has a registered account.

  • Name
    is_company
    Type
    boolean
    Description

    Whether the profile belongs to a company.

  • Name
    custom_attributes
    Type
    array
    Description

    An array of custom attribute objects with name and a value field (string_value, integer_value, date_value, datetime_value, or boolean_value).

GET/v2/languages/:language_id/profiles

List all profiles

This endpoint allows you to retrieve a paginated list of all profiles for a given language. By default, a maximum of ten profiles are shown per page, with a maximum of 250 per page.

Optional attributes

  • Name
    page
    Type
    integer
    Description

    Page offset to fetch. Defaults to 1.

  • Name
    per_page
    Type
    integer
    Description

    Number of profiles per page. Defaults to 10, maximum 250.

  • Name
    created_after
    Type
    timestamp
    Description

    Only return profiles created after this date.

  • Name
    created_before
    Type
    timestamp
    Description

    Only return profiles created before this date.

  • Name
    updated_after
    Type
    timestamp
    Description

    Only return profiles updated after this date.

  • Name
    updated_before
    Type
    timestamp
    Description

    Only return profiles updated before this date.

  • Name
    emails[]
    Type
    array
    Description

    Filter profiles by specific email addresses.

Request

GET
/v2/languages/:language_id/profiles
curl -G https://app.reloadify.com/api/v2/languages/en/profiles \
  -H "Authorization: Bearer {token}" \
  -d per_page=10 \
  -d page=1

Response

{
  "data": [
    {
      "id": "prof_abc123",
      "email": "emma@example.com",
      "active": true,
      "unsubscribed": false,
      "first_name": "Emma",
      "last_name": "de Vries",
      "gender": "female",
      "subscribed_to_newsletter": true,
      "double_opt_in": true,
      "city": "Amsterdam",
      "country_code": "NL",
      "tags": ["vip", "repeat-buyer"],
      "custom_attributes": [
        {
          "name": "loyalty_tier",
          "string_value": "gold"
        }
      ]
    },
    {
      "id": "prof_def456"
      // ...
    }
  ]
}
PUT/v2/languages/:language_id/profiles

Create or update a profile

This endpoint allows you to create a new profile or update an existing one by email. If a profile with the given email already exists, it will be updated.

Required attributes

  • Name
    id
    Type
    string
    Description

    The unique identifier for the profile in your system.

  • Name
    email
    Type
    string
    Description

    The email address of the customer.

Optional attributes

  • Name
    active
    Type
    boolean
    Description

    Whether the profile is active.

  • Name
    first_name
    Type
    string
    Description

    The first name of the customer.

  • Name
    middle_name
    Type
    string
    Description

    The middle name of the customer.

  • Name
    last_name
    Type
    string
    Description

    The last name of the customer.

  • Name
    gender
    Type
    string
    Description

    One of male, female, or unidentified. Defaults to unidentified.

  • Name
    subscribed_to_newsletter
    Type
    boolean
    Description

    Whether the customer is subscribed to the newsletter.

  • Name
    subscribed_to_newsletter_at
    Type
    timestamp
    Description

    When the customer subscribed to the newsletter.

  • Name
    double_opt_in
    Type
    boolean
    Description

    Whether the customer confirmed via double opt-in.

  • Name
    is_registered
    Type
    boolean
    Description

    Whether the customer has a registered account.

  • Name
    is_company
    Type
    boolean
    Description

    Whether the profile belongs to a company.

  • Name
    company_name
    Type
    string
    Description

    The company name.

  • Name
    telephone
    Type
    string
    Description

    The phone number of the customer.

  • Name
    street
    Type
    string
    Description

    The street address.

  • Name
    housenumber
    Type
    string
    Description

    The house number.

  • Name
    city
    Type
    string
    Description

    The city.

  • Name
    province
    Type
    string
    Description

    The province or state.

  • Name
    zipcode
    Type
    string
    Description

    The postal/zip code.

  • Name
    country_code
    Type
    string
    Description

    The ISO country code.

  • Name
    birthdate
    Type
    date
    Description

    The date of birth.

  • Name
    tags
    Type
    array
    Description

    An array of tag strings.

  • Name
    tag_import_type
    Type
    string
    Description

    How to handle tags: overwrite_tag, add_tag, or delete_tag.

  • Name
    custom_attributes
    Type
    array
    Description

    An array of custom attribute objects. Each object requires a name and one value field: string_value, integer_value, date_value, datetime_value, or boolean_value.

Request

PUT
/v2/languages/:language_id/profiles
curl -X PUT https://app.reloadify.com/api/v2/languages/en/profiles \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "profile": {
      "id": "cust_12345",
      "email": "emma@example.com",
      "first_name": "Emma",
      "last_name": "de Vries",
      "gender": "female",
      "subscribed_to_newsletter": true,
      "tags": ["vip"],
      "tag_import_type": "add_tag",
      "custom_attributes": [
        {
          "name": "loyalty_tier",
          "string_value": "gold"
        }
      ]
    }
  }'

Response

{
  "id": "prof_abc123",
  "email": "emma@example.com",
  "active": true,
  "unsubscribed": false,
  "first_name": "Emma",
  "last_name": "de Vries",
  "gender": "female",
  "subscribed_to_newsletter": true,
  "double_opt_in": false,
  "city": null,
  "country_code": null,
  "tags": ["vip"],
  "custom_attributes": [
    {
      "name": "loyalty_tier",
      "string_value": "gold"
    }
  ]
}
GET/v2/languages/:language_id/profiles/:profile_id

Retrieve a profile

This endpoint allows you to retrieve a profile by providing the profile ID. Refer to the model at the top of this page to see which properties are included with profile objects.

Request

GET
/v2/languages/en/profiles/prof_abc123
curl https://app.reloadify.com/api/v2/languages/en/profiles/prof_abc123 \
  -H "Authorization: Bearer {token}"

Response

{
  "id": "prof_abc123",
  "email": "emma@example.com",
  "active": true,
  "unsubscribed": false,
  "first_name": "Emma",
  "last_name": "de Vries",
  "gender": "female",
  "subscribed_to_newsletter": true,
  "double_opt_in": true,
  "company_name": null,
  "telephone": "+31612345678",
  "city": "Amsterdam",
  "province": "Noord-Holland",
  "country_code": "NL",
  "tags": ["vip", "repeat-buyer"],
  "is_registered": true,
  "is_company": false,
  "custom_attributes": [
    {
      "name": "loyalty_tier",
      "string_value": "gold"
    }
  ]
}
DELETE/v2/languages/:language_id/profiles/:profile_id

Delete a profile

This endpoint allows you to delete a profile. Be careful — this action is irreversible and will remove all data associated with the profile.

Request

DELETE
/v2/languages/en/profiles/prof_abc123
curl -X DELETE https://app.reloadify.com/api/v2/languages/en/profiles/prof_abc123 \
  -H "Authorization: Bearer {token}"

Was this page helpful?