Back to top

API Documentation

Testimonials

Overview

Testimonials are user-submitted reviews or endorsements that belong to a brand. They can optionally be linked to email threads (when captured from email conversations). Each testimonial is connected to a contact.

Testimonial

A Testimonial's data model is described in the table below:

Field Type Association Description
id uuid Internal identifier of the object
created_at number Unix timestamp of creation
updated_at number Unix timestamp of last update
brand uuid The brand this testimonial belongs to
user User testimonial.user The user associated with this testimonial
email_thread EmailThread testimonial.email_thread Optional email thread this was captured from
contact Contact testimonial.contact The contact who gave the testimonial
content string The testimonial text content
rating integer Rating from 1-5 (optional)
created_by uuid User who created this record
updated_by uuid User who last updated this record

Endpoints

Get all testimonials for a brand

Get all testimonials for a brand
GET/brands/:id/testimonials

Example URI

GET /brands/:id/testimonials
URI Parameters
HideShow
id
string (required) Example: 63ad974b-55ce-4bb4-8744-547db3a8e65e
Response  200
HideShow
Body
{
  "code": "OK",
  "data": [
    {
      "id": "a27db843-ca80-4cb1-9253-406b224e481d",
      "brand": "63ad974b-55ce-4bb4-8744-547db3a8e65e",
      "content": "This is an amazing real estate service! They helped us find our dream home.",
      "rating": 5,
      "created_at": 1774173607.54759,
      "updated_at": 1774173607.54759,
      "deleted_at": null,
      "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "updated_by": null,
      "type": "testimonial"
    },
    {
      "id": "d8cbcf63-e443-44ff-9f1c-0b982429b09e",
      "brand": "63ad974b-55ce-4bb4-8744-547db3a8e65e",
      "content": "This is an amazing real estate service! They helped us find our dream home.",
      "rating": 5,
      "created_at": 1774173607.54759,
      "updated_at": 1774173607.54759,
      "deleted_at": null,
      "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "updated_by": null,
      "type": "testimonial"
    },
    {
      "id": "be8ba9ba-475a-43ae-9df7-731b8f56b1ce",
      "brand": "63ad974b-55ce-4bb4-8744-547db3a8e65e",
      "content": "Great service!",
      "rating": null,
      "created_at": 1774173607.54759,
      "updated_at": 1774173607.54759,
      "deleted_at": null,
      "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "updated_by": null,
      "type": "testimonial"
    }
  ],
  "info": {
    "count": 3,
    "total": 0
  }
}

Get a specific testimonial

Get a specific testimonial
GET/brands/:id/testimonials/:testimonial

Example URI

GET /brands/:id/testimonials/:testimonial
URI Parameters
HideShow
id
string (required) Example: 63ad974b-55ce-4bb4-8744-547db3a8e65e
testimonial
string (required) Example: a27db843-ca80-4cb1-9253-406b224e481d
associations
string (required) Example: testimonial.contact
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "a27db843-ca80-4cb1-9253-406b224e481d",
    "brand": "63ad974b-55ce-4bb4-8744-547db3a8e65e",
    "contact": {
      "id": "af28920e-917e-4027-8117-439ff92771ed",
      "display_name": "Johnny",
      "partner_name": "Jane Doe",
      "brand": "63ad974b-55ce-4bb4-8744-547db3a8e65e",
      "brand_id": "63ad974b-55ce-4bb4-8744-547db3a8e65e",
      "user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "sort_field": "Johnny",
      "last_touch": null,
      "last_touch_action": null,
      "next_touch": null,
      "touch_freq": null,
      "ios_address_book_id": null,
      "android_address_book_id": null,
      "created_at": 1774173609.307293,
      "updated_at": 1774173607.54759,
      "deleted_at": null,
      "created_for": "direct_request",
      "updated_for": "direct_request",
      "deleted_for": null,
      "title": null,
      "first_name": "John",
      "partner_first_name": "Jane",
      "middle_name": "M.",
      "last_name": "Doe",
      "partner_last_name": "Doe",
      "marketing_name": null,
      "nickname": "Johnny",
      "email": "[email protected]",
      "primary_email": "[email protected]",
      "emails": [
        "[email protected]"
      ],
      "parked": false,
      "partner_email": "[email protected]",
      "phone_number": "+989124834198",
      "primary_phone_number": "+989124834198",
      "phone_numbers": [
        "+989124834198"
      ],
      "company": "Rechat",
      "birthday": "1970-01-12T00:00:00.000Z",
      "profile_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
      "cover_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
      "job_title": "Contact Test Subject",
      "source_type": "ExplicitlyCreated",
      "source": null,
      "website": [
        "http://www.gholi.com"
      ],
      "tags": [
        "poo",
        "foo",
        "New"
      ],
      "address": [
        {
          "city": "Dallas",
          "full": "Street, Dallas Texas 72890",
          "name": "Street",
          "type": "stdaddr",
          "extra": "Office",
          "line1": "Street",
          "line2": "Dallas Texas 72890",
          "state": "Texas",
          "country": "US",
          "postcode": "72890"
        }
      ],
      "type": "contact"
    },
    "content": "This is an amazing real estate service! They helped us find our dream home.",
    "rating": 5,
    "created_at": 1774173607.54759,
    "updated_at": 1774173607.54759,
    "deleted_at": null,
    "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "updated_by": null,
    "type": "testimonial"
  }
}

Create a testimonial

Create a testimonial
POST/brands/:id/testimonials

Example URI

POST /brands/:id/testimonials
URI Parameters
HideShow
id
string (required) Example: 63ad974b-55ce-4bb4-8744-547db3a8e65e
associations
string (required) Example: testimonial.contact
Request
HideShow
Body
{
  "content": "This is an amazing real estate service! They helped us find our dream home.",
  "contact": "af28920e-917e-4027-8117-439ff92771ed",
  "rating": 5
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "a27db843-ca80-4cb1-9253-406b224e481d",
    "brand": "63ad974b-55ce-4bb4-8744-547db3a8e65e",
    "contact": {
      "id": "af28920e-917e-4027-8117-439ff92771ed",
      "display_name": "Johnny",
      "partner_name": "Jane Doe",
      "brand": "63ad974b-55ce-4bb4-8744-547db3a8e65e",
      "brand_id": "63ad974b-55ce-4bb4-8744-547db3a8e65e",
      "user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "sort_field": "Johnny",
      "last_touch": null,
      "last_touch_action": null,
      "next_touch": null,
      "touch_freq": null,
      "ios_address_book_id": null,
      "android_address_book_id": null,
      "created_at": 1774173609.307293,
      "updated_at": 1774173607.54759,
      "deleted_at": null,
      "created_for": "direct_request",
      "updated_for": "direct_request",
      "deleted_for": null,
      "title": null,
      "first_name": "John",
      "partner_first_name": "Jane",
      "middle_name": "M.",
      "last_name": "Doe",
      "partner_last_name": "Doe",
      "marketing_name": null,
      "nickname": "Johnny",
      "email": "[email protected]",
      "primary_email": "[email protected]",
      "emails": [
        "[email protected]"
      ],
      "parked": false,
      "partner_email": "[email protected]",
      "phone_number": "+989124834198",
      "primary_phone_number": "+989124834198",
      "phone_numbers": [
        "+989124834198"
      ],
      "company": "Rechat",
      "birthday": "1970-01-12T00:00:00.000Z",
      "profile_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
      "cover_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
      "job_title": "Contact Test Subject",
      "source_type": "ExplicitlyCreated",
      "source": null,
      "website": [
        "http://www.gholi.com"
      ],
      "tags": [
        "poo",
        "foo",
        "New"
      ],
      "address": [
        {
          "city": "Dallas",
          "full": "Street, Dallas Texas 72890",
          "name": "Street",
          "type": "stdaddr",
          "extra": "Office",
          "line1": "Street",
          "line2": "Dallas Texas 72890",
          "state": "Texas",
          "country": "US",
          "postcode": "72890"
        }
      ],
      "type": "contact"
    },
    "content": "This is an amazing real estate service! They helped us find our dream home.",
    "rating": 5,
    "created_at": 1774173607.54759,
    "updated_at": 1774173607.54759,
    "deleted_at": null,
    "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "updated_by": null,
    "type": "testimonial"
  }
}

Update a testimonial

Update a testimonial
PUT/brands/:id/testimonials/:testimonial

Example URI

PUT /brands/:id/testimonials/:testimonial
URI Parameters
HideShow
id
string (required) Example: 63ad974b-55ce-4bb4-8744-547db3a8e65e
testimonial
string (required) Example: a27db843-ca80-4cb1-9253-406b224e481d
associations
string (required) Example: testimonial.contact
Request
HideShow
Body
{
  "content": "Updated testimonial content - even better service!",
  "contact": "af28920e-917e-4027-8117-439ff92771ed",
  "rating": 4
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "a27db843-ca80-4cb1-9253-406b224e481d",
    "brand": "63ad974b-55ce-4bb4-8744-547db3a8e65e",
    "contact": {
      "id": "af28920e-917e-4027-8117-439ff92771ed",
      "display_name": "Johnny",
      "partner_name": "Jane Doe",
      "brand": "63ad974b-55ce-4bb4-8744-547db3a8e65e",
      "brand_id": "63ad974b-55ce-4bb4-8744-547db3a8e65e",
      "user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "sort_field": "Johnny",
      "last_touch": null,
      "last_touch_action": null,
      "next_touch": null,
      "touch_freq": null,
      "ios_address_book_id": null,
      "android_address_book_id": null,
      "created_at": 1774173609.307293,
      "updated_at": 1774173607.54759,
      "deleted_at": null,
      "created_for": "direct_request",
      "updated_for": "direct_request",
      "deleted_for": null,
      "title": null,
      "first_name": "John",
      "partner_first_name": "Jane",
      "middle_name": "M.",
      "last_name": "Doe",
      "partner_last_name": "Doe",
      "marketing_name": null,
      "nickname": "Johnny",
      "email": "[email protected]",
      "primary_email": "[email protected]",
      "emails": [
        "[email protected]"
      ],
      "parked": false,
      "partner_email": "[email protected]",
      "phone_number": "+989124834198",
      "primary_phone_number": "+989124834198",
      "phone_numbers": [
        "+989124834198"
      ],
      "company": "Rechat",
      "birthday": "1970-01-12T00:00:00.000Z",
      "profile_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
      "cover_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
      "job_title": "Contact Test Subject",
      "source_type": "ExplicitlyCreated",
      "source": null,
      "website": [
        "http://www.gholi.com"
      ],
      "tags": [
        "poo",
        "foo",
        "New"
      ],
      "address": [
        {
          "city": "Dallas",
          "full": "Street, Dallas Texas 72890",
          "name": "Street",
          "type": "stdaddr",
          "extra": "Office",
          "line1": "Street",
          "line2": "Dallas Texas 72890",
          "state": "Texas",
          "country": "US",
          "postcode": "72890"
        }
      ],
      "type": "contact"
    },
    "content": "Updated testimonial content - even better service!",
    "rating": 4,
    "created_at": 1774173607.54759,
    "updated_at": 1774173607.54759,
    "deleted_at": null,
    "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "updated_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "type": "testimonial"
  }
}

Delete a testimonial

Delete a testimonial
DELETE/brands/:id/testimonials/:testimonial

Example URI

DELETE /brands/:id/testimonials/:testimonial
URI Parameters
HideShow
id
string (required) Example: 63ad974b-55ce-4bb4-8744-547db3a8e65e
testimonial
string (required) Example: a27db843-ca80-4cb1-9253-406b224e481d
Response  204

Generated by aglio on 22 Mar 2026