Assign or unassign a person on a task

PUT/v2/api/store/{team_slug}/v2/work_pipeline/{hash_id}/assign

v2Operation ID v2_public_job_work_pipeline_assign

Adds one team member to a task, or removes one. Returns the task's assignees after the change (people who have left the team are left out).

Permission

Any member of the team may assign or unassign anyone on the team.

Business rules

• Assigning someone already assigned, or unassigning someone who isn't, changes nothing and succeeds.

Side effects

• No email or notification is sent.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team
• hash_idstringrequired

  The task's hash id. Hash ids only: a unique key or a document number gives 404.

  • Example hpioY1gDBQZdbI

Request body

application/json, required.

• actionstringrequired
  • One of: "assign", "unassign"
• user_idstringrequired

  A member of your team (from List users).

Response

200Successful response.

• dataarray of objectsrequired

  The task's assignees after the change.

  Fields of each item (5)

  • avatar_urlstring | null
  • emailstring
  • idstring

    The user.

  • namestring
  • timezonestring | null
• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

  When

  The user isn't on your team, or the task isn't your team's.

  Fix

  Use ids from List users and the task list.

• 422The request was refused and changed nothing. validation_failed lists what to fix in error.fields; other codes name a business rule, explained in error.message. A few checks answer with only {"message": "..."}. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer connect_timeout ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.

  When

  action isn't assign or unassign, or user_id is missing.

  Fix

  Send both fields.

Related

• GETList team members/v1/api/store/{team_slug}/setting/user
• PUTUpdate a task/v2/api/store/{team_slug}/v2/work_pipeline/{hash_id}

Example request

curl

curl -X PUT 'https://secure.yoprint.com/v2/api/store/your-team/v2/work_pipeline/hpioY1gDBQZdbI/assign' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "action": "assign",    "user_id": "4mdDkMg3dgQOa3"  }'

Example response 200

Response

{
  "data": [
    {
      "avatar_url": null,
      "email": "alex@example.com",
      "id": "4mdDkMg3dgQOa3",
      "name": "Alex Rivera",
      "timezone": "America/Chicago"
    }
  ],
  "status": 200,
  "success": true
}