Mark Play as Done
POST
/api/components/{id}/plays/{uid}/state
const url = 'https://example.com/api/components/example/plays/example/state';const options = { method: 'POST', headers: { cookie: 'ms.session_token=<ms.session_token>', 'Content-Type': 'application/json' }, body: '{"state":"discarded","reason":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/components/example/plays/example/state \ --header 'Content-Type: application/json' \ --cookie ms.session_token=<ms.session_token> \ --data '{ "state": "discarded", "reason": "example" }'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string
uid
required
string
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
state
required
string
reason
string
Responses
Section titled “Responses”Success
The request failed validation
Media typeapplication/json
The request’s body, query or params didn’t match the route’s schema
object
error
required
string
details
required
What was wrong, one entry per problem
Array<object>
object
message
required
string
path
Where the problem is, e.g. [“amount”] or [“items”, 0, “id”]
Array
Example
{ "error": "Validation failed"}