Skip to content

experienceSlugs.md

Latest commit

 

History

History
87 lines (60 loc) · 2.81 KB

experienceSlugs.md

File metadata and controls

87 lines (60 loc) · 2.81 KB

Experience Slugs Actions

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

Contents

Get

Returns the experience slugs for an application

result = client.experience_slugs.get(applicationId=my_application_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.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, experienceSlugs.*, or experienceSlugs.get.

Available Parameters

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

Successful Responses

Code Type Description
200 Experience Slugs Collection of experience slugs

Error Responses

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

Post

Create a new experience slug for an application

result = client.experience_slugs.post(
    applicationId=my_application_id,
    experienceSlug=my_experience_slug)

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, experienceSlugs.*, or experienceSlugs.post.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
experienceSlug Experience Slug Post Y New experience slug information Experience Slug Post Example
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
201 Experience Slug Successfully created experience slug

Error Responses

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