Create a tag

POST/v1/api/store/{team_slug}/tag

v1Operation ID v1_public_tag_store

Creates a tag and returns it. Put it on customers with Tag a customer, and on sales orders with the sales order tag operations.

Permission

Any member of the team.

Business rules

• Tag names are not checked for duplicates: look in List tags before creating one.

Path parameters

• team_slugstringrequired

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

  • Example your-team

Request body

application/json, required.

• color_hexstringrequired

  # and 3 or 6 hex digits.

  • Matches ^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$
• namestringrequired

  Need not be unique.

Response

200Successful response.

• dataobjectrequired
  Child fields (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.

• 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

  name or color_hex is missing, or color_hex is not #RGB or #RRGGBB. error.code is validation_failed.

  Fix

  Send both, with a hex color.

Related

• PUTTag a customer/v1/api/store/{team_slug}/customer/{hash_id}/tag/attach
• PUTTag an order/v1/api/store/{team_slug}/sales_order/{hash_id}/tag/attach

Example request

curl

curl -X POST 'https://secure.yoprint.com/v1/api/store/your-team/tag' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "color_hex": "#2563EB",    "name": "Wholesale"  }'

Example response 200

Response

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