Demo

GET

Retrieves all demo accounts.

get
Query parameters
limitnumberOptional

The maximum number of records to return.

Example: 10
offsetnumberOptional

The number of records to skip.

Example: 0
Responses
200

Demo accounts retrieved successfully

application/json
get
/demo
GET /demo HTTP/1.1
Host: 
Accept: */*

{
  "count": 10,
  "users": [
    {
      "id": 1,
      "email": "user@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "previewLink": "encrypted_preview_link"
    }
  ]
}

POST

Creates a new demo account.

post
Body
emailstringOptionalExample: user@example.com
firstNamestringOptionalExample: John
lastNamestringOptionalExample: Doe
passwordstring | nullableOptionalExample: securePassword123
Responses
post
/demo/account
POST /demo/account HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 95

{
  "email": "user@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "password": "securePassword123"
}
{
  "id": 1,
  "email": "user@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "previewLink": "encrypted_preview_link"
}

Validates a preview link by decrypting the hash.

post
Responses
200

Preview link validated successfully

application/json
ResponsestringExample: user@example.com;password
post
/demo/preview
POST /demo/preview HTTP/1.1
Host: 
Accept: */*

user@example.com;password

Resets a demo account by its ID.

post
Path parameters
idnumberRequired
Responses
200

Demo account reset successfully

application/json
ResponseanyExample: {"message":"Demo account reset successfully","description":"The demo account has been reset successfully."}
post
/demo/account/reset/{id}
POST /demo/account/reset/{id} HTTP/1.1
Host: 
Accept: */*

{
  "message": "Demo account reset successfully",
  "description": "The demo account has been reset successfully."
}

Uploads a file to the S3 bucket.

post
Body
filestring · binaryOptional
Responses
200

File uploaded successfully

application/json
ResponsestringExample: formatted_file_name.jpg
post
/action-demo-files
POST /action-demo-files HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "file": "binary"
}
formatted_file_name.jpg

PATCH

Edits an existing demo account.

patch
Path parameters
idnumberRequired
Body
emailstringRequiredExample: user@example.com
firstNamestringRequiredExample: John
lastNamestringRequiredExample: Doe
passwordstring | nullableRequiredExample: securePassword123
Responses
200

Demo account edited successfully

application/json
patch
/demo/account/{id}
PATCH /demo/account/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 95

{
  "email": "user@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "password": "securePassword123"
}
{
  "id": 1,
  "email": "user@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "previewLink": "encrypted_preview_link"
}

DELETE

Deletes a demo account by its ID.

delete
Path parameters
idnumberRequired
Responses
200

Demo account deleted successfully

application/json
ResponseanyExample: {"message":"Demo account deleted successfully","description":"The demo account has been deleted successfully."}
delete
/demo/account/{id}
DELETE /demo/account/{id} HTTP/1.1
Host: 
Accept: */*

{
  "message": "Demo account deleted successfully",
  "description": "The demo account has been deleted successfully."
}

Deletes a file by its name from the S3 bucket.

delete
Path parameters
fileNamestringRequired
Responses
200

File deleted successfully

application/json
ResponseanyExample: {"message":"File deleted successfully","description":"The file has been deleted successfully."}
delete
/action-demo-files/{fileName}
DELETE /action-demo-files/{fileName} HTTP/1.1
Host: 
Accept: */*

{
  "message": "File deleted successfully",
  "description": "The file has been deleted successfully."
}
PreviousBusinessesNextEmail

Last updated