NotifyWorkers

Description

The NotifyWorkers operation sends e-mail to one or more Workers, given the recipients' Worker IDs.

Worker IDs are included in the assignment data returned by GetAssignmentsForHIT. You can send e-mail to any Worker who has ever submitted results for a HIT you created that you have approved or rejected.

The e-mail sent to Workers includes your e-mail address as the "reply-to" address, so Workers can respond to the e-mail. You can change the e-mail address for your account using the Requester Console (http://requester.mturk.amazon.com/) by selecting "Your Account" from the navigation bar.

Up to 100 Worker IDs can be sent the same message with a single call to NotifyWorkers.

Sample Request: Using NotifyWorkers (REST)

The following example of a call to the NotifyWorkers operation sends an e-mail message to three Workers.

http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
&AWSAccessKeyId=[the Requester's Access Key ID]
&Version=2008-04-01
&Operation=NotifyWorkers
&Signature=[signature for this request]
&Timestamp=[your system's local time]
&Subject=Thank%20you
&MessageText=Hello!%20Just%20wanted%20to%20say%20thank%20you...
&WorkerId.1=AZ3123EXAMPLE
&WorkerId.2=AZ3456EXAMPLE
&WorkerId.3=AZ3789EXAMPLE

Request Parameters

A request to the Mechanical Turk Service includes parameters that control its behavior and the data it returns. Required parameters must be included for the request to succeed.

NotifyWorkers accepts parameters common to all operations. Some common parameters are required. See Common Parameters for more information.

The following parameters are specific to the NotifyWorkers operation:

Name	Description	Type	Value
`Operation`	The operation you would like to call. To access the `NotifyWorkers` operation, set the `Operation` parameter to `NotifyWorkers`.	Required	`NotifyWorkers`
`Subject`	The subject line of the e-mail message to send. It can include up to 200 characters.	Required	A string
`MessageText`	The text of the e-mail message to send. It can include up to 4,096 characters.	Required	A string
`WorkerId`	The ID of the Worker to notify, as returned by `GetAssignmentsForHIT`. This parameter may be repeated up to 100 times to specify multiple Workers to notify.	Required	A valid Worker ID

Responses

If there are no errors, the response includes a NotifyWorkersResult element, which contains the Request (if the Request response group is specified).

If there are errors, the response also includes a NotifyWorkersFailureStatus element. There is one NotifyWorkersFailureStatus element for each WorkerID that could not be notified.

The NotifyWorkersFailureStatus element includes the elements in the following table.

Name Description

NotifyWorkersFailureStatus

Specifies whether the Requester should retry sending the notification to the Worker. The possible values are:

HardFailure— Do not retry. This error can occur if the Worker account is suspended, or if the Worker did not work on any of your HITs.
SoftFailure— Resend the notification.

	Note
	Resend the message only to those WorkerIds that returned a SoftFailure. If you retry this operation with your original request parameters, some Workers could receive duplicate emails.

NotifyWorkersFailureMessage

A string that describes the error.

WorkerId

The WorkerId that could not be notified.

If none of the Workers could be notified, the Request element included in the NotifyWorkersResult element contains an Errors element with one or more Error elements. For more information, see Understanding Responses.