SiteJabber Review Requests API

openapi: 3.2.0
info:
  title: SmartCustomer (Sitejabber) Business Review Requests API
  version: v1
  summary: Business review, product review, review request, messaging and privacy API for SmartCustomer (formerly Sitejabber).
  description: 'Transcribed by API Evangelist from SmartCustomer''s own published API reference at https://api.sitejabber.com/ (Slate source: https://github.com/smartcustomer-reviews/business-api-docs).'
  contact:
    name: SmartCustomer API Support
    email: support@smartcustomer.com
    url: https://api.sitejabber.com/
  termsOfService: https://www.smartcustomer.com/terms
  x-transcribed-by: API Evangelist enrichment pipeline
  x-transcription-source: https://api.sitejabber.com/
servers:
- url: https://api.smartcustomer.com/v1
  description: Production. The same reference is also served from https://api.sitejabber.com/ under the pre-rebrand Sitejabber name.
security:
- client_token: []
  user_token: []
tags:
- name: Review Requests
paths:
  /businesses/{business}/review/request/add:
    post:
      operationId: createReviewRequest
      summary: Create review request
      tags:
      - Review Requests
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseEnvelope'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      description: 'One of email or phone is required: the reference marks both required, noting each is required only if the other is not provided.'
      parameters:
      - $ref: '#/components/parameters/business'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                email:
                  type: string
                  description: email of the customer, required if phone is not provided
                phone:
                  type: string
                  description: phone of the customer, required if email is not provided
                order_id:
                  type: string
                  description: order id of the purchase
                order_date:
                  type: string
                  description: order date of the purchase in yyyy-mm-dd format
                first_name:
                  type: string
                  description: first name of the customer
                last_name:
                  type: string
                  description: last name of the customer
                labels:
                  type: string
                  description: comma separated labels to attach to the review after it's completed by the customer
                location:
                  type: string
                  description: business location identifier
                language:
                  type: string
                  description: language for the request
                product_skus:
                  type: string
                  description: product SKUs of the purchase (comma separated)
                return_link:
                  type: integer
                  description: (1 => true, 0 => false), if true, returns the link to complete the review, and does not send the review request email
              required:
              - order_id
              - order_date
  /businesses/{business}/review/request/remove:
    post:
      operationId: removeReviewRequest
      summary: Remove review request
      tags:
      - Review Requests
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseEnvelope'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      parameters:
      - $ref: '#/components/parameters/business'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                email:
                  type: string
                  description: email of the customer
                order_id:
                  type: string
                  description: order id of the purchase, if not specified all requests for the given email will be removed
              required:
              - email
components:
  responses:
    TooManyRequests:
      description: Too many requests. 1000 calls per hour per unique user token; no more than 10 calls in a 10 second window.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseEnvelope'
  parameters:
    business:
      name: business
      in: path
      required: true
      description: The business's display address (domain without scheme), e.g. yourdomain.com
      schema:
        type: string
      example: yourdomain.com
  schemas:
    ResponseEnvelope:
      type: object
      description: Every response carries a success flag and a status key. When success is false and status is ERROR, errorCode and errorReason are present.
      properties:
        status:
          type: string
          description: OK if everything went good, ERROR if there was an error processing the request
        success:
          type: boolean
          description: true or false
        errorCode:
          type: integer
          description: Error code, only present when status is ERROR
        errorReason:
          type: string
          description: Error message, only present when status is ERROR
  securitySchemes:
    client_token:
      type: apiKey
      in: query
      name: client_token
      description: API key issued to the business, passed as a query parameter on every request.
    user_token:
      type: apiKey
      in: header
      name: user_token
      description: User session token returned by POST /login. Typically expires after 6 months; calling login invalidates any previous token.
externalDocs:
  description: SmartCustomer API reference
  url: https://api.sitejabber.com/