Experience User Actions

https://api.losant.com/applications/APPLICATION_ID/experience/users/EXPERIENCE_USER_ID

Below are the various requests that can be performed against the Experience User resource, as well as the expected parameters and the potential responses.

Delete

Deletes an experience user

Method And Url

DELETE https://api.losant.com/applications/APPLICATION_ID/experience/users/EXPERIENCE_USER_ID

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, experienceUser.*, or experienceUser.delete.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
EXPERIENCE_USER_ID	ID associated with the experience user	575ed78e7ae143cd83dc4aab

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X DELETE \
    https://api.losant.com/applications/APPLICATION_ID/experience/users/EXPERIENCE_USER_ID

Successful Responses

Code	Type	Description
200	Success	If experience user was successfully deleted

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if experience user was not found

Get

Retrieves information on an experience user

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/experience/users/EXPERIENCE_USER_ID

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, experienceUser.*, or experienceUser.get.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
EXPERIENCE_USER_ID	ID associated with the experience user	575ed78e7ae143cd83dc4aab

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/applications/APPLICATION_ID/experience/users/EXPERIENCE_USER_ID

Successful Responses

Code	Type	Description
200	Experience User	Experience user information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if experience user was not found

Patch

Updates information about an experience user

Method And Url

PATCH https://api.losant.com/applications/APPLICATION_ID/experience/users/EXPERIENCE_USER_ID

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, experienceUser.*, or experienceUser.patch.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
EXPERIENCE_USER_ID	ID associated with the experience user	575ed78e7ae143cd83dc4aab

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the Experience User Patch schema. For example, the following would be a valid body for this request:

{
  "password": "aNewPassword",
  "userTags": {
    "customKey": "newCustomValue"
  }
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"password":"aNewPassword","userTags":{"customKey":"newCustomValue"}}' \
    https://api.losant.com/applications/APPLICATION_ID/experience/users/EXPERIENCE_USER_ID

Successful Responses

Code	Type	Description
200	Experience User	Updated experience user information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if experience user was not found

Schemas

Error

Schema for errors returned by the API

Error Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 2 keys
▶
type:{} 1 key
▶
message:{} 1 key

Error Example

▶
root:{} 2 keys
type:"NotFound"
message:"Application was not found"

Experience User

Schema for a single Experience User

Experience User Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 14 keys
▶
id:{} 2 keys
▶
experienceUserId:{} 2 keys
▶
applicationId:{} 2 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
passwordLastUpdated:{} 2 keys
▶
lastLogin:{} 2 keys
▶
email:{} 3 keys
▶
firstName:{} 2 keys
▶
lastName:{} 2 keys
▶
avatarUrl:{} 3 keys
▶
tokenCutoff:{} 2 keys
▶
userTags:{} 3 keys
▶
experienceGroups:{} 2 keys

Experience User Example

▶
root:{} 12 keys
id:"58b9d782cbfafe1be675744d"
experienceUserId:"58b9d782cbfafe1be675744d"
applicationId:"575ec8687ae143cd83dc4a97"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
passwordLastUpdated:"2016-06-13T04:00:00.000Z"
lastLogin:"2016-06-13T04:00:00.000Z"
email:"experienceuser@example.com"
firstName:"Example"
lastName:"Name"
avatarUrl:"https://example.avatar.url/is_here.png"
▶
userTags:{} 1 key

Experience User Patch

Schema for the body of an Experience User modification request

Experience User Patch Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 7 keys
▶
email:{} 3 keys
▶
firstName:{} 2 keys
▶
lastName:{} 2 keys
▶
password:{} 3 keys
▶
tokenCutoff:{} 2 keys
▶
userTags:{} 3 keys
▶
experienceGroupIds:{} 3 keys
additionalProperties:false

Experience User Patch Example

▶
root:{} 2 keys
password:"aNewPassword"
▶
userTags:{} 1 key

Success

Schema for reporting a successful operation

Success Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 1 key
▶
success:{} 2 keys

Success Example

▶
root:{} 1 key
success:true