appViews.close

DELETE

/v1/app-views/{viewId}

const url = 'https://example.com/v1/app-views/example';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://example.com/v1/app-views/example \
  --header 'Authorization: Bearer <token>'

Authorizations

token
session

Parameters

Path Parameters

viewId

required

string

Responses

200

400

ExperienceInputInvalid | OrganizationRequired

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: ExperienceInputInvalid

message

required

string

Example

{
  "_tag": "ExperienceInputInvalid"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

AppRestricted | PermissionDenied | MembershipRequired | ForbiddenOrigin

application/json

Any of:

object

_tag

required

string

Allowed values: AppRestricted

restriction

required

object

cardUrl

required

string

reason

required

string

>= 1 characters

appealUrl

required

string

Example

{
  "_tag": "AppRestricted"
}

404

ExperienceNotFound

application/json

object

_tag

required

string

Allowed values: ExperienceNotFound

required

string

Example

{
  "_tag": "ExperienceNotFound"
}

409

AppViewUnavailable | SessionConflict

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: AppViewUnavailable

reason

required

string

Allowed values: Declaration Resource ConnectionChanged Closed Unsupported Protocol

message

required

string

Example

{
  "_tag": "AppViewUnavailable",
  "reason": "Declaration"
}

503

ExperienceStorageUnavailable | AuthorizationUnavailable | AuthenticationUnavailable

application/json

Any of:

object

_tag

required

string

Allowed values: ExperienceStorageUnavailable

Example

{
  "_tag": "ExperienceStorageUnavailable"
}