Creating a Labeling Team Member¶
Function¶
This API is used to create 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}/workforces/{workforce_id}/workers
Parameter | Mandatory | Type | Description |
---|---|---|---|
project_id | Yes | String | Project ID. For details about how to obtain a project ID, see Obtaining a Project ID and Name. |
workforce_id | Yes | String | ID of a labeling team. |
Request Parameters¶
Parameter | Mandatory | Type | Description |
---|---|---|---|
description | No | String | Member description. The description contains 0 to 256 characters and does not support the following special characters: |
emails | Yes | String | Email address of a labeling team member. |
role | Yes | Integer | Member role. Options:
|
Response Parameters¶
None
Example Requests¶
The following is an example of how to create a labeling team member. The member role has been set to 2, which is the team administrator.
{
"emails" : "xxx@xxx.com",
"description" : "",
"role" : "2"
}
Example Responses¶
Status code: 201
Created
{ }
Status Codes¶
Status Code | Description |
---|---|
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
Error Codes¶
See Error Codes.