Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: Wuwan, Qi <wuwanqi1@noreply.gitea.eco.tsi-dev.otc-service.com> Co-committed-by: Wuwan, Qi <wuwanqi1@noreply.gitea.eco.tsi-dev.otc-service.com>
10 KiB
Sending an Email to a Labeling Team Member
Function
This API is used to send an email to a labeling team member.
Debugging
You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.
URI
POST /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/notify
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
dataset_id |
Yes |
String |
Dataset ID. |
project_id |
Yes |
String |
Project ID. For details about how to obtain a project ID, see Obtaining a Project ID and Name. |
workforce_task_id |
Yes |
String |
ID of a team labeling task. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
emails |
Yes |
Array of strings |
Email list of a labeling team member. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
results |
Array of BatchResponse objects |
Result of sending an email to a labeling team member. |
success |
Boolean |
Check whether the operation is successful. Options:
|
Example Requests
Sending an Email to a Labeling Team Member
{ "emails" : [ "xxx@xxx.com", "xxx@xxx.com" ] }
Example Responses
Status code: 200
OK
{ "success" : true }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
Error Codes
See Error Codes.