Our help articles and product guides are moving to a new home at docs.xtremepush.com

Articles in this section

User Profile Methods

Avatar
Xtremepush Support
  • Updated
Follow

The user profile methods are used to list the users, get info on particular user profiles, and import user profile data. Available Methods are:

 

List

Used to get a list of previously created user profiles. All user profiles may be returned or lists of user profiles of a certain type if criteria are provided.

URL

api/external/list/profile

Parameters

Parameter Description
apptoken Your App token
order Order the list in either ascending or descending order based on any of the attributes e.g. "order": ["id ASC", "endtime" ] or “order”: [“id DESC”, “endtime” ]
select Select what attributes to return e.g. "select": ["id", "project_id",
"user_id", "email", "email_addressable"]
condition Filter the returned push actions based on some criteria e.g. "condition": [ ["email_addressable", "=" , 1] ]
limit Used with offset for pagination e.g. "limit: 50, "offset": 0 returns a max of 50 profiles starting at position 0
offset Used with limit for pagination e.g. "limit": 50, "offset": 0 returns a max of 50 profiles starting at position 0

 

Example

Get a list of all user profiles

curl -X POST -d '{"apptoken":"YOUR_APPTOKEN"}' https://external-api.xtremepush.com/api/external/list/profile

Get a list of all user profiles who are email addressable

curl -X POST -d '{"apptoken":"YOUR_APP_TOKEN", "condition":[["email_addressable","=",0]]}' https://external-api.xtremepush.com/api/external/list/profile

Get a list of emails from all profiles that have an email set and are email addressable but are not subscribed for email, in a paginated format:

curl -X POST -d '{"apptoken":"YOUR_APP_TOKEN", "select": ["email"], "condition": [["email_subscription","=",0], ["email_addressable","=",1], ["email","is not",null]], "order": ["id ASC", "id"], "limit": 50, "offset": 0}' https://external-api.xtremepush.com/api/external/list/profile

  

Info

Used to get info on a user profile.

URL

api/external/info/profile

Parameters

Parameter Description
apptoken Your App Token
id The profile id of the profile you are looking for
select

Select what attributes to return e.g. "select": ["id", "project_id",
"user_id", "email", "email_addressable"]

Example

Return the info for the user profile with the given id.

curl -X POST -d '{"apptoken":"YOUR_APPTOKEN", "id":PROFILE_ID}' https://external-api.xtremepush.com/api/external/info/profile

Return the id, email and email addressable attribute of the user profile with the given id.

curl -X POST -d '{"apptoken":"YOUR_APPTOKEN", "id":PROFILE_ID, "select":["id","email","email_addressable"]}' https://external-api.xtremepush.com/api/external/info/profile

Example of the id, email and email addressable attribute of a profile being returned successfully.

{
 "success": true,
 "code": 200,
 "model": {
     "id": "example_id",
     "email": "user1email@example.com",
     "email_addressable": 1
   }
}

 

Import

Used to create new user profiles and/or set attributes for these profiles.

 

URL

api/external/import/profile

 

Parameters

Parameter Description
apptoken Your App Token
columns The attributes you would like to set, must include either user_id or email
rows

The values for the attributes per user


 Example

set the user_id, email, and two profile attributes for two seperate users.

curl -X POST -d '{
 "apptoken": "YOUR_APP_TOKEN",
 "columns": ["user_id", "email", "profile_attribute1", "profile_attribute2"],
 "rows": [
       ["user_id1", "user1email@example.com", "user_1_profile_attribute1_value", "user_1_profile_attribute2_value"],
       ["user_id2", "user2email@example.com", "user_2_profile_attribute1_value", "user_2_profile_attribute2_value"]
 ]
}' https://external-api.xtremepush.com/api/external/import/profile

 

List/ProfileSubscription

Used to get a list of subscription statuses from user profiles.

URL

api/external/list/profile-subscription

Parameters

Parameter Description
apptoken Your App token
order Optional - order the list in either ascending or descending order based on any of the attributes e.g. "order": ["update_time" ] or "order": ["update_time DESC"]
select Optional - select what attributes to return e.g. "select": ["channel",
"mobile_number", "email","profile_id", "status","update_time" ,"user_id"]
condition Optional - filter the returned data based on some criteria  "condition": [["user_id", "=", 1234]] or "condition": [["update_time", ">", 123123]]
limit Optional - used with offset for pagination e.g. "limit: 50, "offset": 0 returns a max of 50 profiles starting at position 0. Defaults to 10000
offset Optional - used with limit for pagination e.g. "limit": 50, "offset": 0 returns a max of 50 profiles starting at position 0. Defaults to 0

 

Example

Get a list of a single user subscription status:

curl -X POST -d '{"apptoken":"YOUR_APPTOKEN", "condition":[["user_id", "=", "USER_ID"]]}' https://external-api.xtremepush.com/api/external/list/profile-subscription

Get a list of all user subscription status that have updated since a certain time: 

curl -X POST -d '{"apptoken":"YOUR_APPTOKEN", "condition":[["update_time", ">", 123123]]}' https://external-api.xtremepush.com/api/external/list/profile-subscription

Response:

{
 "code": 200,
 "data": [
   {
     "channel": "sms",
     "mobile_number": "000000000000",
     "profile_id": "11e8dd30e8b6ef58aed408002795b510",
     "status": 0,
     "update_time": 1541076902,
     "user_id": 1234
   },
   {
     "channel": "email",
     "email": "test@xtremepush.com",
     "profile_id": "11e8dd30e8b6ef58aed408002795b510",
     "status": 0,
     "update_time": 1541076902,
     "user_id": 1234
   }
 ],
 "success": true
}

 

List/ProfileAttribute

Used to get a list of profile attribute values.

URL

api/external/list/profile-attribute

Parameters

Parameter Description
apptoken Your App token
order Optional - order the list in either ascending or descending order based on any of the attributes e.g. "order": ["attribute_name" ] or “order”: [“update_time DESC” ]
select Optional - select what attributes to return e.g. "select": ["value", "update_time"]
condition Optional - filter the returned data based on some criteria e.g. the most common usage is usually to get attributes for a specific user "condition": [["user_id", "=", "USER_ID"]]
limit Optional - Used with offset for pagination e.g. "limit: 50, "offset": 0 returns a max of 50 profiles starting at position 0. Defaults to 10000
offset Optional - Used with limit for pagination e.g. "limit": 50, "offset": 0 returns a max of 50 profiles starting at position 0. Defaults to 0

 

Example

Get a list of all user attributes: 

curl -X POST -d '{"apptoken":"YOUR_APPTOKEN", "condition":[["user_id", "=", "USER_ID"]]}' https://external-api.xtremepush.com/api/external/list/profile-attribute

Response:

{
 "code": 200,
 "data": [
   {
     "profile_id": "11e8dd30e8b6ef58aed408002795b510",
     "user_id": 1234,
     "attribute_name": "first_name",
     "value": "John",
     "update_time": 1541076902
   }
 ],
 "success": true
}

 

Related articles

Comments

0 comments

Article is closed for comments.