Skip to content

Latest commit

 

History

History
178 lines (127 loc) · 6.5 KB

experienceEndpoint.md

File metadata and controls

178 lines (127 loc) · 6.5 KB

Experience Endpoint Actions

Details on the various actions that can be performed on the Experience Endpoint resource, including the expected parameters and the potential responses.

Contents

Delete

Deletes an experience endpoint

result = client.experience_endpoint.delete(
    applicationId=my_application_id,
    experienceEndpointId=my_experience_endpoint_id)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, experienceEndpoint.*, or experienceEndpoint.delete.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
experienceEndpointId string Y ID associated with the experience endpoint 575ed78e7ae143cd83dc4aab
includeWorkflows string N If the workflows that utilize this experience endpoint should also be deleted. true
losantdomain string N Domain scope of request (rarely needed) example.com

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

result = client.experience_endpoint.get(
    applicationId=my_application_id,
    experienceEndpointId=my_experience_endpoint_id)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. 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.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
experienceEndpointId string Y ID associated with the experience endpoint 575ed78e7ae143cd83dc4aab
version string N Version of this experience endpoint to return develop develop
losantdomain string N Domain scope of request (rarely needed) example.com

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

result = client.experience_endpoint.linked_resources(
    applicationId=my_application_id,
    experienceEndpointId=my_experience_endpoint_id)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. 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.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
experienceEndpointId string Y ID associated with the experience endpoint 575ed78e7ae143cd83dc4aab
version string N Version of this experience endpoint to query develop develop
includeCustomNodes string N If the result of the request should also include the details of any custom nodes referenced by returned workflows false true
losantdomain string N Domain scope of request (rarely needed) example.com

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

result = client.experience_endpoint.patch(
    applicationId=my_application_id,
    experienceEndpointId=my_experience_endpoint_id,
    experienceEndpoint=my_experience_endpoint)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, experienceEndpoint.*, or experienceEndpoint.patch.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
experienceEndpointId string Y ID associated with the experience endpoint 575ed78e7ae143cd83dc4aab
experienceEndpoint Experience Endpoint Patch Y Object containing new properties of the experience endpoint Experience Endpoint Patch Example
losantdomain string N Domain scope of request (rarely needed) example.com

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