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

Request Headers

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

Error Responses

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

Request Headers

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

Error Responses

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

Request Headers

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

Error Responses