Tags

List Tags

get

Retrieve project tags used to organize customers and reviews.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

contextstring · enum · nullableOptional

When set, only tags for this scope are returned; omit for all tags.

Possible values:

Responses

200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Short code or application-level status code for this resource.

get/tags

GET /project/tags HTTP/1.1
Host: api.moregoodreviews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

{
  "success": true,
  "code": 200,
  "data": [
    {
      "id": 9,
      "uuid": "719c34f3-30fd-4d9e-82dd-172ce6d554af",
      "name": "VIP",
      "slug": "vip",
      "sprite": "fas fa-star",
      "color": "#F59E0B",
      "context": "customer",
      "ai_instructions": null,
      "has_ai_tagging": false
    }
  ]
}

Create Tag

post

Create a project tag for customer or review organization.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Request body for creating a project tag.

namestringRequired

Display name for this tag.

colorstring · nullableOptional

Hex color associated with this tag. Accepts

spritestring · max: 50Optional

Font Awesome icon: two CSS class names as used with Font Awesome Web Fonts / classic CSS (not SVG/React props). Format is a style prefix (fab, fad, fak, fal, far, fas, or fat), one ASCII space, then an icon slug starting with fa- (lowercase letters and digits, hyphen-separated words). Examples: fab fa-google, fas fa-star. On write, omit, send null, or whitespace-only to clear. Font Awesome 6 semantic pairs such as fa-solid fa-star are not accepted; use fas fa-star instead.

Pattern: ^(fab|fad|fak|fal|far|fas|fat)\s+fa-[a-z0-9]+(?:-[a-z0-9]+)*$

contextstring · enum · nullableOptional

Resource type this tag applies to.

Possible values:

ai_instructionsstring · nullableOptional

Instructions used by AI tagging for review tags.

has_ai_taggingboolean · nullableOptional

Whether AI tagging is enabled for this tag.

Responses

200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Application-level status code returned by this API.

post/tags

POST /project/tags HTTP/1.1
Host: api.moregoodreviews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 207

{
  "name": "Great Service",
  "context": "review",
  "color": "#10B981",
  "sprite": "fas fa-thumbs-up",
  "ai_instructions": "Apply this tag to reviews that praise friendly, helpful, or timely service.",
  "has_ai_tagging": true
}

200

Success

{
  "success": true,
  "code": 200,
  "data": {
    "id": 801,
    "uuid": "19bb3170-f4dc-4fc7-986b-dd2360f07f4e",
    "name": "Great Service",
    "slug": "great-service",
    "sprite": "fas fa-thumbs-up",
    "color": "#10B981",
    "context": "review",
    "ai_instructions": null,
    "has_ai_tagging": false
  }
}

Update Tag

put

Rename, recolor, or adjust slug and AI tagging settings for an existing workspace tag.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

Unique numeric identifier for this tag.

Body

Request body for updating a project tag.

namestringRequired

Display name for this tag.

slugstring · max: 30 · nullableOptional

Stable URL-safe slug override; must remain unique among project tags when provided.

colorstring · nullableOptional

Hex color associated with this tag. Accepts

spritestring · max: 50Optional

Pattern: ^(fab|fad|fak|fal|far|fas|fat)\s+fa-[a-z0-9]+(?:-[a-z0-9]+)*$

ai_instructionsstring · nullableOptional

Instructions used by AI tagging for review tags when has_ai_tagging is true.

has_ai_taggingbooleanOptional

Whether AI tagging is enabled for this tag on review-context tags.

Responses

200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Application-level status code returned by this API.

put/tags/{id}

PUT /project/tags/{id} HTTP/1.1
Host: api.moregoodreviews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 205

{
  "name": "Great Team",
  "slug": "great-team",
  "color": "#059669",
  "sprite": "fas fa-thumbs-up",
  "ai_instructions": "Apply when reviews mention friendly staff or standout teamwork experiences.",
  "has_ai_tagging": true
}

200

Success

{
  "success": true,
  "code": 200,
  "data": {
    "id": 801,
    "uuid": "19bb3170-f4dc-4fc7-986b-dd2360f07f4e",
    "name": "Great Team",
    "slug": "great-team",
    "sprite": "fas fa-thumbs-up",
    "color": "#059669",
    "context": "review",
    "ai_instructions": "Apply when reviews mention friendly staff or standout teamwork experiences.",
    "has_ai_tagging": true
  }
}

Delete Tag

delete

Soft-delete a workspace tag shared across customers and reviews.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

Unique numeric identifier for this tag.

Responses

200

Success

application/json

Object confirming the tag was deleted.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Application-level status code returned by this API.

delete/tags/{id}

DELETE /project/tags/{id} HTTP/1.1
Host: api.moregoodreviews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

{
  "success": true,
  "code": 200
}

PreviousSources

NextBranding

Last updated 0 minutes ago

Was this helpful?