Review Links Service API Endpoints

The production API base URL is https://api.tradesmentechnologies.com/.

Authentication

Most endpoints require a Bearer token in the Authorization header: Authorization: Bearer <your_token>

Mutating requests may carry an Idempotency-Key header so a retry never acts twice — see Idempotent Retries in the Accounts API documentation.

The public endpoint uses document code validation instead of Bearer tokens.

Base Path

/prod/review-links

Endpoints

Create or Update Review Links

Create or update the review links for the authenticated user's company. Since there is one record per company, this acts as an upsert.

• Method: PUT
• Path: /prod/review-links
• Authentication: Required (Bearer Token)
• Request Body:

  {
    "googleLink": "https://g.page/r/your-business/review",
    "otherLink": "https://yelp.com/biz/your-business"
  }
  

  Note: Both fields are optional strings, but at least one of googleLink or otherLink must be provided.
• Success Response: 200 OK

  {
    "message": "Review links saved successfully"
  }
  

• Error Responses:
  • 400 Bad Request: Missing body, invalid JSON, or neither googleLink nor otherLink provided.
  • 401 Unauthorized: Missing or invalid token.
  • 500 Internal Server Error: Unexpected server error.

Get Review Links

Get the review links for the authenticated user's company.

• Method: GET
• Path: /prod/review-links
• Authentication: Required (Bearer Token)
• Success Response: 200 OK

  {
    "companyId": "uuid",
    "googleLink": "https://g.page/r/your-business/review",
    "otherLink": "https://yelp.com/biz/your-business",
    "updatedAt": "2026-01-01T00:00:00.000Z"
  }
  

  Note: Only the fields that were set will be present in the response.
• Error Responses:
  • 401 Unauthorized: Missing or invalid token.
  • 404 Not Found: No review links configured for this company.
  • 500 Internal Server Error: Unexpected server error.

Delete Review Links

Delete the review links for the authenticated user's company.

• Method: DELETE
• Path: /prod/review-links
• Authentication: Required (Bearer Token)
• Success Response: 200 OK

  {
    "message": "Review links deleted successfully"
  }
  

• Error Responses:
  • 401 Unauthorized: Missing or invalid token.
  • 500 Internal Server Error: Unexpected server error.

Get Review Links (Public)

Get the review links for a company, validated by a document code. No authentication required.

• Method: GET
• Path: /prod/review-links/public
• Authentication: None (validated by document code)
• Query Parameters:
  • companyId (required): The company ID.
  • documentId (required): A document ID belonging to the company.
  • documentCode (required): The document's code for validation.
• Success Response: 200 OK

  {
    "googleLink": "https://g.page/r/your-business/review",
    "otherLink": "https://yelp.com/biz/your-business",
    "updatedAt": "2026-01-01T00:00:00.000Z"
  }
  

  Note: Only the fields that were set will be present in the response. The companyId is stripped from the response.
• Error Responses:
  • 400 Bad Request: Missing companyId, documentId, or documentCode.
  • 403 Forbidden: Document code does not match.
  • 404 Not Found: Document not found or no review links configured for this company.
  • 500 Internal Server Error: Unexpected server error.