Skip to content

Latest commit

 

History

History
163 lines (121 loc) · 5.15 KB

experienceDomain.md

File metadata and controls

163 lines (121 loc) · 5.15 KB

Experience Domain Actions

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

Contents

Delete

Deletes an experience domain

var params = {
  applicationId: myApplicationId,
  experienceDomainId: myExperienceDomainId
};

// with callbacks
client.experienceDomain.delete(params, function (err, result) {
  if (err) { return console.error(err); }
  console.log(result);
});

// with promises
client.experienceDomain.delete(params)
  .then(console.log)
  .catch(console.error);

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, experienceDomain.*, or experienceDomain.delete.

Available Parameters

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

Successful Responses

Code Type Description
200 Success If experience domain was successfully deleted

Error Responses

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

Get

Retrieves information on an experience domain

var params = {
  applicationId: myApplicationId,
  experienceDomainId: myExperienceDomainId
};

// with callbacks
client.experienceDomain.get(params, function (err, result) {
  if (err) { return console.error(err); }
  console.log(result);
});

// with promises
client.experienceDomain.get(params)
  .then(console.log)
  .catch(console.error);

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, experienceDomain.*, or experienceDomain.get.

Available Parameters

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

Successful Responses

Code Type Description
200 Experience Domain Experience domain information

Error Responses

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

Patch

Updates information about an experience domain

var params = {
  applicationId: myApplicationId,
  experienceDomainId: myExperienceDomainId,
  experienceDomain: myExperienceDomain
};

// with callbacks
client.experienceDomain.patch(params, function (err, result) {
  if (err) { return console.error(err); }
  console.log(result);
});

// with promises
client.experienceDomain.patch(params)
  .then(console.log)
  .catch(console.error);

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

Available Parameters

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

Successful Responses

Code Type Description
200 Experience Domain Updated experience domain information

Error Responses

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