Skip to content

experienceUser.md

Latest commit

 

History

History
133 lines (94 loc) · 4.38 KB

experienceUser.md

File metadata and controls

133 lines (94 loc) · 4.38 KB

Experience User Actions

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

Contents

Delete

Deletes an experience user

result = client.experience_user.delete(
    applicationId=my_application_id,
    experienceUserId=my_experience_user_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, experienceUser.*, or experienceUser.delete.

Available Parameters

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

Successful Responses

Code Type Description
200 Success If experience user was successfully deleted

Error Responses

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

Get

Retrieves information on an experience user

result = client.experience_user.get(
    applicationId=my_application_id,
    experienceUserId=my_experience_user_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, experienceUser.*, or experienceUser.get.

Available Parameters

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

Successful Responses

Code Type Description
200 Experience User Experience user information

Error Responses

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

Patch

Updates information about an experience user

result = client.experience_user.patch(
    applicationId=my_application_id,
    experienceUserId=my_experience_user_id,
    experienceUser=my_experience_user)

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, experienceUser.*, or experienceUser.patch.

Available Parameters

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

Successful Responses

Code Type Description
200 Experience User Updated experience user information

Error Responses

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