Experience View Actions
https://api.losant.com/applications/APPLICATION_ID
/experience/views/EXPERIENCE_VIEW_ID
Below are the various requests that can be performed against the
Experience View resource, as well as the expected
parameters and the potential responses.
Delete
Deletes an experience view
Method And Url
DELETE https://api.losant.com/applications/APPLICATION_ID
/experience/views/EXPERIENCE_VIEW_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, experienceView.*, or experienceView.delete.
Request Path Components
Path Component |
Description |
Example |
APPLICATION_ID |
ID associated with the application |
575ec8687ae143cd83dc4a97 |
EXPERIENCE_VIEW_ID |
ID associated with the experience view |
575ed78e7ae143cd83dc4aab |
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/views/EXPERIENCE_VIEW_ID
Successful Responses
Code |
Type |
Description |
200 |
Success |
If experience view was successfully deleted |
Error Responses
Code |
Type |
Description |
400 |
Error |
Error if malformed request |
404 |
Error |
Error if experience view was not found |
Get
Retrieves information on an experience view
Method And Url
GET https://api.losant.com/applications/APPLICATION_ID
/experience/views/EXPERIENCE_VIEW_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, experienceView.*, or experienceView.get.
Request Path Components
Path Component |
Description |
Example |
APPLICATION_ID |
ID associated with the application |
575ec8687ae143cd83dc4a97 |
EXPERIENCE_VIEW_ID |
ID associated with the experience view |
575ed78e7ae143cd83dc4aab |
Request Query Parameters
Name |
Required |
Description |
Default |
Example |
version |
N |
Version of this experience view to return |
develop |
version=develop |
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/views/EXPERIENCE_VIEW_ID
Successful Responses
Error Responses
Code |
Type |
Description |
400 |
Error |
Error if malformed request |
404 |
Error |
Error if experience view was not found |
Patch
Updates information about an experience view
Method And Url
PATCH https://api.losant.com/applications/APPLICATION_ID
/experience/views/EXPERIENCE_VIEW_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, experienceView.*, or experienceView.patch.
Request Path Components
Path Component |
Description |
Example |
APPLICATION_ID |
ID associated with the application |
575ec8687ae143cd83dc4a97 |
EXPERIENCE_VIEW_ID |
ID associated with the experience view |
575ed78e7ae143cd83dc4aab |
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 View Patch schema. For example, the following would be a
valid body for this request:
{
"body": "New Content! <p>{{newData}}</p>",
"viewTags": {
"customKey": "newCustomValue"
}
}
Curl Example
curl -H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
-X PATCH \
-d '{"body":"New Content! <p>{{newData}}</p>","viewTags":{"customKey":"newCustomValue"}}' \
https://api.losant.com/applications/APPLICATION_ID/experience/views/EXPERIENCE_VIEW_ID
Successful Responses
Code |
Type |
Description |
200 |
Experience View |
Updated experience view information |
Error Responses
Code |
Type |
Description |
400 |
Error |
Error if malformed request |
404 |
Error |
Error if experience view was not found |