Tag a customer

PUT/v1/api/store/{team_slug}/customer/{hash_id}/tag/attach

v1Operation ID v1_public_customer_tag_attach

Puts one of your team's tags on the customer and returns the customer's tags. Tagging a customer twice with the same tag changes nothing. Create tags with Create a tag.

Permission

Any member of the team.

Path parameters

• team_slugstringrequired

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

  • Example your-team
• hash_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 EDhVUaC6jbLbed

Request body

application/json, required.

• idstringrequired

  The tag id.

Response

200Successful response.

• dataarray of objectsrequired

  Every tag on the customer after the change.

  Fields of each item (3)

  • color_hexstring | nullrequired

    Such as #2563EB. Null for a tag saved without a color.

  • idstringrequired
  • namestringrequired
• 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

  No tag, or no live customer, with this id in the team, or id is missing. error.code is null and error.message names the record type.

  Fix

  List tags to find the id.

Related

• PUTRemove a tag from a customer/v1/api/store/{team_slug}/customer/{hash_id}/tag/detach
• POSTCreate a tag/v1/api/store/{team_slug}/tag

Example request

curl

curl -X PUT 'https://secure.yoprint.com/v1/api/store/your-team/customer/EDhVUaC6jbLbed/tag/attach' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "id": "zzVW0sylTIm6oo"  }'

Example response 200

Response

{
  "data": [
    {
      "color_hex": "#2563EB",
      "id": "zzVW0sylTIm6oo",
      "name": "Wholesale"
    }
  ],
  "status": 200,
  "success": true
}