Experience Endpoint Actions

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

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

Delete

Deletes an experience endpoint

Method And Url

DELETE https://api.losant.com/applications/APPLICATION_ID/experience/endpoints/EXPERIENCE_ENDPOINT_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, experienceEndpoint.*, or experienceEndpoint.delete.

Request Path Components

Path Component Description Example
APPLICATION_ID ID associated with the application 575ec8687ae143cd83dc4a97
EXPERIENCEENDPOINTID ID associated with the experience endpoint 575ed78e7ae143cd83dc4aab

Request Query Parameters

Name Required Description Default Example
includeWorkflows N If the workflows that utilize this experience endpoint should also be deleted. includeWorkflows=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/endpoints/EXPERIENCE_ENDPOINT_ID

Successful Responses

Code Type Description
200 Success If experience endpoint was successfully deleted

Error Responses

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

Get

Retrieves information on an experience endpoint

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/experience/endpoints/EXPERIENCE_ENDPOINT_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, experienceEndpoint.*, or experienceEndpoint.get.

Request Path Components

Path Component Description Example
APPLICATION_ID ID associated with the application 575ec8687ae143cd83dc4a97
EXPERIENCEENDPOINTID ID associated with the experience endpoint 575ed78e7ae143cd83dc4aab

Request Query Parameters

Name Required Description Default Example
version N Version of this experience endpoint to return develop version=develop

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/endpoints/EXPERIENCE_ENDPOINT_ID

Successful Responses

Code Type Description
200 Experience Endpoint Experience endpoint information

Error Responses

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

Linked Resources

Retrieves information on resources linked to an experience endpoint

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/experience/endpoints/EXPERIENCE_ENDPOINT_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.read, all.Organization, all.Organization.read, all.User, all.User.read, experienceEndpoint.*, or experienceEndpoint.linkedResources.

Request Path Components

Path Component Description Example
APPLICATION_ID ID associated with the application 575ec8687ae143cd83dc4a97
EXPERIENCEENDPOINTID ID associated with the experience endpoint 575ed78e7ae143cd83dc4aab

Request Query Parameters

Name Required Description Default Example
version N Version of this experience endpoint to query develop version=develop
includeCustomNodes N If the result of the request should also include the details of any custom nodes referenced by returned workflows false includeCustomNodes=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 GET \
    https://api.losant.com/applications/APPLICATION_ID/experience/endpoints/EXPERIENCE_ENDPOINT_ID/linkedResources

Successful Responses

Code Type Description
200 Experience Linked Resources Linked resource information

Error Responses

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

Patch

Updates information about an experience endpoint

Method And Url

PATCH https://api.losant.com/applications/APPLICATION_ID/experience/endpoints/EXPERIENCE_ENDPOINT_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, experienceEndpoint.*, or experienceEndpoint.patch.

Request Path Components

Path Component Description Example
APPLICATION_ID ID associated with the application 575ec8687ae143cd83dc4a97
EXPERIENCEENDPOINTID ID associated with the experience endpoint 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 Endpoint Patch schema. For example, the following would be a valid body for this request:

{
  "access": "group",
  "experienceGroupIds": [
    "58c1de6f8f812590d8e82983"
  ]
}

Curl Example 

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"access":"group","experienceGroupIds":["58c1de6f8f812590d8e82983"]}' \
    https://api.losant.com/applications/APPLICATION_ID/experience/endpoints/EXPERIENCE_ENDPOINT_ID

Successful Responses

Code Type Description
200 Experience Endpoint Updated experience endpoint information

Error Responses

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

Was this page helpful?

Still looking for help? You can also search the Losant Forums or submit your question there.