Overview

The profiles endpoint contains information related to the profiles for a given business. You can use this endpoint to view profile URLs, claimed status, and to update the URL.

Default Fields

FieldTypeDescription
claimedboolTrue/False value denoting whether the profile has been claimed on the third party source.
data_sourceintegerid of the data_source the profile is for.
idintegerid of the profile object
namestringThe name of the business as it appears on the third party source.
urlstringThe url the data and reviews are gathered from.

List All Profiles

https://ad1.replypro.io/api/public/accounts/<account_id>/companies/<company_id>/businesses/<business_id>/profiles

Example of returned data:

{
  "next": null,
  "previous": null,
  "results": [
    {
      "claimed": true,
      "data_source": 2,
      "id": 28669,
      "name": "Five Guys",
      "url": "https://www.yelp.com/biz/five-guys-boise"
    },
    {
      "claimed": false,
      "data_source": 18,
      "id": 28675,
      "name": "Five Guys",
      "url": "https://www.tripadvisor.com/Restaurant_Review-g35394-d2688266-Reviews-Five_Guys-Boise_Idaho.html"
    }
  ]
}

Get Profile

https://ad1.replypro.io/api/public/accounts/<account_id>/companies/<company_id>/businesses/<business_id>/profiles/<profile_id>
{
  "next": null,
  "previous": null,
  "results": [
    {
      "claimed": true,
      "data_source": 2,
      "id": 28669,
      "name": "Five Guys",
      "url": "https://www.yelp.com/biz/five-guys-boise"
    }
  ]
}

Example of returned data with additional fields:

Updating Profiles

You can update certain fields of a Profile resource by making a PUT request to the endpoint with the fields you are updating specified in the body.

https://ad1.replypro.io/api/public/accounts/<account_id>/companies/<company_id>/businesses/<business_id>/profiles/<profile_id>

Fields Allowing Update

FieldTypeDescription
urlStringUpdating the address will replace what we currently have on file for this data_source and will remove any
{
  "url": "https://www.yelp.com/biz/five-guys-boise"
}
{
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 28669,
      "url": "https://www.yelp.com/biz/five-guys-boise"
    }
  ]
}