Enable or disable the album (BETA)

This call is currently in a restricted BETA status. Contact your Technical Account Manager for more information.

Enable or disable the album for an organization.

Note: If the album is enabled for the organization, this call updates the album's configuration and starts building the album.
If the album is disabled, this call deletes the album and all of its data. Disabling the album call is irreversible - all images will be deleted.

The following profiles have permission to make this call:

  • partners
  • sub-partners
  • administrators
  • supervisors

Request
Security:
bearerAuth
path Parameters
orgId
required
string

The ID of the organization. Obtain this from GET /organizations.

Example: 62
Request Body schema: application/json
albumStatus
required
string

The status of the album assigned to the organization.

Enum: "enabled" "disabled"
Responses
200

Successful operation

400

Bad request error

401

Unauthorized error

403

Forbidden error

500

Internal server error

post/organization-album/{orgId}/album/config
Request samples
application/json
{
  • "albumStatus": "enabled"
}
Response samples
application/json
{
  • "requestId": "06327cae-e075-42ca-b620-c5cfdd3b4e37"
}