Skip to content

Latest commit

 

History

History
133 lines (94 loc) · 4.72 KB

experienceVersion.md

File metadata and controls

133 lines (94 loc) · 4.72 KB

Experience Version Actions

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

Contents

Delete

Deletes an experience version

result = client.experience_version.delete(
  applicationId: my_application_id,
  experienceVersionIdOrName: my_experience_version_id_or_name)

puts 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.cli, all.Organization, all.User, all.User.cli, experienceVersion.*, or experienceVersion.delete.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
experienceVersionIdOrName string Y Version ID or version name associated with the experience version 575ed78e7ae143cd83dc4aab
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Success If experience version was successfully deleted

Error Responses

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

Get

Retrieves information on an experience version

result = client.experience_version.get(
  applicationId: my_application_id,
  experienceVersionIdOrName: my_experience_version_id_or_name)

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

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
experienceVersionIdOrName string Y Version ID or version name associated with the experience version 575ed78e7ae143cd83dc4aab
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Experience Version Experience version information

Error Responses

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

Patch

Updates information about an experience version

result = client.experience_version.patch(
  applicationId: my_application_id,
  experienceVersionIdOrName: my_experience_version_id_or_name,
  experienceVersion: my_experience_version)

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

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
experienceVersionIdOrName string Y Version ID or version name associated with the experience version 575ed78e7ae143cd83dc4aab
experienceVersion Experience Version Patch Y Object containing new properties of the experience version Experience Version Patch Example
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Experience Version Updated experience version information

Error Responses

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