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.Application.cli, all.Organization, all.User, all.User.cli, experienceView.*, or experienceView.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/views/EXPERIENCE_VIEW_ID

Successful Responses

Error Responses

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.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, experienceView.*, or experienceView.get.

Request Path Components

Request Query Parameters

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/views/EXPERIENCE_VIEW_ID

Successful Responses

Error Responses

Linked Resources

Retrieves information on resources linked to an experience view

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/experience/views/EXPERIENCE_VIEW_ID/linkedResources

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.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, experienceView.*, or experienceView.linkedResources.

Request Path Components

Request Query Parameters

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/views/EXPERIENCE_VIEW_ID/linkedResources

Successful Responses

Error Responses

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.Application.cli, all.Organization, all.User, all.User.cli, experienceView.*, or experienceView.patch.

Request Path Components

Request Headers

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

Error Responses