Sources

List Sources

get

Retrieve review source metadata available for project reviews.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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/sources

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

200

Success

{
  "success": true,
  "code": 200,
  "data": [
    {
      "id": 5,
      "uuid": "59fd6c84-2955-4ef7-a665-48a87b79f35b",
      "name": "Google",
      "slug": "google",
      "sprite": "fab fa-google",
      "color": "#DB4437",
      "icon": null
    }
  ]
}

Create Source

post

Create a review source with a display name. The slug is generated from the name. Optional color and sprite class apply when no custom icon image is configured for this source.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Request body for creating a review source.

namestring · max: 30Required

Display name for this source.

colorstring · max: 30 · nullableOptional

Hex color badge for this source.

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]+)*$

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.

post/sources

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

{
  "name": "Partner Portal",
  "color": "#6366F1",
  "sprite": "fas fa-globe"
}

200

Success

{
  "success": true,
  "code": 200,
  "data": {
    "id": 912,
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Partner Portal",
    "slug": "partner-portal",
    "sprite": "fas fa-globe",
    "color": "#6366F1",
    "icon": null
  }
}

Update Source

put

Update display name, slug, color, or sprite class for an existing review source. Sending a sprite while a custom icon image is set returns an error.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

Unique numeric identifier for this review source.

Body

Request body for updating a review source.

namestring · max: 30Required

Display name for this source.

slugstring · max: 30 · nullableOptional

URL-friendly identifier unique among sources in this project.

colorstring · max: 30 · nullableOptional

Hex color badge for this source.

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]+)*$

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.

put/sources/{id}

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

{
  "name": "Partner Portal",
  "slug": "partner-portal",
  "color": "#4F46E5",
  "sprite": "fas fa-link"
}

200

Success

{
  "success": true,
  "code": 200,
  "data": {
    "id": 912,
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Partner Portal",
    "slug": "partner-portal",
    "sprite": "fas fa-link",
    "color": "#4F46E5",
    "icon": null
  }
}

Delete Source

delete

Soft-delete a review source when it is no longer used for ingestion or display.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

Unique numeric identifier for this review source.

Responses

200

Success

application/json

Object confirming the source was deleted.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Application-level status code returned by this API.

delete/sources/{id}

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

200

Success

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