Remove a Guest
Note: Only Guests in stopped state can be removed
Format
| Method | POST |
|---|---|
| URL | /tasks/create |
| Request content | GuestDelete Object |
| Successful answer | TaskResult Object |
| Unexpected error | HTTP 500 |
GuestDelete Object
Schema
| repeat | String | Reserved |
|---|---|---|
| retries | String | Number of times this task will be retried, in case of error |
| type | String | Task type identifier. In this case, "guest_delete" |
| guest_id | String | Unique identifier of the Guest |
JSON example
{
"repeat": "0",
"retries": "0",
"type": "guest_delete",
"guest_id": "testguest"
} |