Assign a team member to an order

PUT/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/assign_user/add

v2Operation ID v2_public_assign_user_add

Adds a team member to the order's Assigned To list. Assigning someone already assigned changes nothing.

Assigned people whose role sees only their own orders can then see and work on this one.

The answer is the full list. {hash_id} is the order's id (for example V4keXwwxMQyXw7); the ord_ unique key is not accepted here.

Permission

Needs permission to edit this order: the team owner, a role with update_all_order, or update_self_order for orders the user created or is assigned to.

Business rules

• user_id must be a member of the team; otherwise 404.

Side effects

• Gives the member access to the order if their role sees only their own orders. No 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 sales order's or quote's id (a hash id). The ord_ unique key and the order number do not work here.

  • Example V4keXwwxMQyXw7

Request body

application/json, required.

• actionstringrequired

  Required. Send assign; the path decides what happens.

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

  The team member's id, from the team's users.

Response

200Successful response.

• dataarray of objectsrequired
  Fields of each item (5)

  • avatar_urlstring | null
  • emailstring
  • idstring
  • namestring
  • timezonestring | null

    IANA time zone, for example America/Chicago.

• 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.

  When

  The API key's role can't edit this order.

  Fix

  Ask the team owner for sales order edit permission.

• 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 is not a member of this team.

  Fix

  Use an id from the team's users.

• 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 or user_id is missing, or action is not assign or unassign (validation_failed).

  Fix

  Send both fields.

Related

• PUTRemove a team member from an order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/assign_user/remove
• GETList team members/v1/api/store/{team_slug}/setting/user

Example request

curl

curl -X PUT 'https://secure.yoprint.com/v2/api/store/your-team/v2/sales_order/V4keXwwxMQyXw7/assign_user/add' \  -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": "PydH0WtBhSeiNU"  }'

Example response 200

Response

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