Experience Actions#

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

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

Bootstrap#

Bootstraps the experience for this application with standard endpoints and views

Method And Url #

PATCH https://api.losant.com/applications/APPLICATION_ID/experience/bootstrap

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, experience.*, or experience.bootstrap.

Request Path Components #

Path Component Description Example
APPLICATION_ID ID associated with the application 575ec8687ae143cd83dc4a97

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 Bootstrap Options schema. For example, the following would be a valid body for this request:

{
  "replaceExisting": true
}

Curl Example #

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"replaceExisting":true}' \
    https://api.losant.com/applications/APPLICATION_ID/experience/bootstrap

Successful Responses #

Code Type Description
200 Experience Bootstrap Result If bootstrap was successful

Error Responses #

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

Delete#

Deletes multiple parts of an experience including users, groups, slugs, domains, versions, endpoints, views, and workflows

Method And Url #

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

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, experience.*, or experience.delete.

Request Path Components #

Path Component Description Example
APPLICATION_ID ID associated with the application 575ec8687ae143cd83dc4a97

Request Query Parameters #

Name Required Description Default Example
keepUsers N If this is set, Experience Users will not be removed. keepUsers=true
keepGroups N If this is set, Experience Groups will not be removed. keepGroups=true
keepSlugs N If this is set, Experience Slugs will not be removed. keepSlugs=true
keepDomains N If this is set, Experience Domains will not be removed. keepDomains=true
removeVersions N If this is set, all Experience Versions and their contents will be removed (except for develop). removeVersions=true
keepViews N If this is set, Experience Views (in the develop version) will not be removed. keepViews=true
keepEndpoints N If this is set, Experience Endpoints (in the develop version) will not be removed. keepEndpoints=true
removeWorkflows N If this is set, all Experience Workflows (in the develop version) will ve removed. removeWorkflows=true

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

Successful Responses #

Code Type Description
200 Success If deletion was successful

Error Responses #

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