Send a notification to a lab instance

The SendNotification command allows you to send a notification to a specified lab instance for the user to see. For notifications sent using the POST HTTP verb, the notification text is limited to 4000 characters.

Securityapi_key
Request
query Parameters
labinstanceid
required
integer <int64>

The ID of the lab instance to send the notification to.

Example: labinstanceid=2393048
notification
required
string

The text of the notification to send. Please ensure the message is properly encoded. Line breaks can be included using \n. For notifications sent using the POST HTTP verb, the notification text is limited to 4000 characters.

Example: notification=I'd+like+to+let+you+know
name
string

An optional name for the notification. If you name the notification, subsequent SendNotification commands using the same labInstanceId and name will cause the existing notification to be updated. It is also possible to delete a named notification by sending the name along with no notification value.

Example: name=Hello
Responses
200

OK Response.

post/sendnotification
Request samples 
Response samples 
application/json
{
  • "Id": 28297,
  • "Result": 1,
  • "Status": 1,
  • "Error": null
}