Assign or unassign a user on a customer

PUT/v1/api/store/{team_slug}/customer/{id}/assign

v1Operation ID v1_public_customer_assign_update

Adds a team member to the customer's assigned users (action: assign) or removes one (action: unassign), and returns the assigned users. Assigning someone already assigned changes nothing.

Permission

Needs the Manage Customers permission: "Manage All" for any customer, or "Manage Assigned to User" for customers assigned to you.

Business rules

• System customers can't be changed (422).
• assign needs a member of the team. unassign for someone who is not assigned changes nothing and still answers 200 with the list.

Path parameters

• team_slugstringrequired

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

  • Example your-team
• idstringrequired

  The customer's id (id from List customers or Create a customer). A hash id from an earlier answer; unique keys and document numbers (such as PO0042) don't work here.

  • Example uAu3dAKIaHyAYk

Request body

application/json, required.

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

  The user's id. For assign it must be a member of your team. For unassign, someone who is not assigned (or an id that matches nobody) changes nothing.

Response

200Successful response.

• dataarray of objectsrequired
  Fields of each item (3)

  • idstringrequired

    The user id.

  • namestring | nullrequired
  • avatar_urlstring | 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.

  When

  Your role can't change this customer: it has no Manage Customers permission, or it manages only customers assigned to you and this one is not. This 403 has a short body, {"message": "No Permission to update Customer"}.

  Fix

  Ask for Manage Customers "Manage All", or to be assigned to the customer.

• 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

  No live customer with this id in the team: deleted customers are not found here. error.code is null and error.message names the record type.

  Fix

  Check the id. Find deleted customers with the trashed_only filter and restore them first.

• 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 is not assign or unassign, or user_id is missing or not a valid id. error.code is validation_failed.

  Fix

  Send both fields.

  When

  action is assign and user_id is not a member of the team (error.fields.user_id: "The user must be a member of this team. Use an id from the team's user list.").

  Fix

  Use an id from List users.

Related

• GETList the users assigned to a customer/v1/api/store/{team_slug}/customer/{id}/assign
• GETList team members/v1/api/store/{team_slug}/setting/user

Example request

curl

curl -X PUT 'https://secure.yoprint.com/v1/api/store/your-team/customer/uAu3dAKIaHyAYk/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": "lOURnovd3hkIQI"  }'

Example response 200

Response

{
  "data": [
    {
      "avatar_url": "https://example.com/avatars/alex.png",
      "id": "lOURnovd3hkIQI",
      "name": "Alex Rivera"
    }
  ],
  "status": 200,
  "success": true
}