Menu
Amazon Mechanical Turk
API Reference (API Version 2014-08-15)

NotifyWorkers

Description

The NotifyWorkers operation sends an email to one or more Workers that you specify with the Worker ID.

You can specify up to 100 Worker IDs to send the same message with a single call to the NotifyWorkers operation.

Note

The NotifyWorkers operation will send a notification email to a Worker only if you have previously approved or rejected work from the Worker.

Request Parameters

The NotifyWorkers operation 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:

NameDescriptionRequired

Operation

The name of the operation

Type: String

Valid Values: NotifyWorkers

Default: None

Yes

Subject

The subject line of the email message to send.

Type: String

Default: None

Constraints: can include up to 200 characters.

Yes

MessageText

The text of the email message to send

Type: String

Default: None

Constraints: can include up to 4,096 characters

Yes

WorkerId

The ID of the Worker to notify, as returned by the GetAssignmentsForHIT operation.

Type: String

Default: None

Constraints: You can repeat this parameter up to 100 times to notify multiple Workers.

Yes

Response Elements

A successful request for the NotifyWorkers operation returns with no errors. The response includes the elements described in the following table. The operation returns no other data.

NameDescription

NotifyWorkersResult

Contains a Request element if the Request ResponseGroup is specified.

Examples

The following example shows how to use the NotifyWorkers operation.

Sample Request

The following example sends an email message to three Workers.

https://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
&AWSAccessKeyId=[the Requester's Access Key ID]
&Version=2014-08-15
&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
         

Sample Response

The following is an example response.

<NotifyWorkersResult>
  <Request>
    <IsValid>True</IsValid>
  </Request>
</NotifyWorkersResult>