Skip to content
This repository was archived by the owner on Apr 16, 2025. It is now read-only.
Mohamad Nour Chawich edited this page Jul 8, 2016 · 7 revisions

WikiAPI ReferenceProfilesPages

Intro

Shoutit Pages are special profiles that can be managed by multiple User profiles. These user profiles are called Page Admins. Pages are mostly used by businesses to represent their brand, product or company on Shoutit.

Authentication

Pages can't make direct requests, instead; the admin of a Page can create requests on his page's behalf. This is explained here Pages Authentication.

Page Object

The regular Page object is a basically a Profile object while the Detailed Page has extra properties. All these properties can be edited except is_verified which reflects the Business Verification state of the page.

Detailed Page

{
  "name": "Page name",
  "about": "",
  "is_published": false,
  "description": "",
  "phone": "",
  "founded": "",
  "impressum": "",
  "overview": "",
  "mission": "",
  "general_info": "",
  "is_verified": false
}

Page Categories

There are only two levels of page categories. Main categories and sub categories. Clients should present the list of main categories first then once the user selects a main category show him its children to select one from them.

  • children and image of sub categories are always empty [] or null

Page Category

{
    "id": "3448c61e-68bb-4c43-93e7-d78f9f462157",
    "name": "Company",
    "slug": "main-company",
    "image": "https://tag-image.static.shoutit.com/company.png",
    "children": [
        {
            "id": "a4155074-057c-4b5b-8350-cdcf9f21cf1d",
            "name": "Company",
            "slug": "company",
            "image": null,
            "children": []
        }
    ]
}

Pages Verification

Pages have two kinds of verification Pages Activation and Business Verification

Pages Activation

A page is activated when at least one of its admins is activated i.e. he has verified his email. For a page to be listed in the public pages directory it should be activated and published i.e. both is_activated and is_published set to true. Page admins can at anytime un-list their pages by setting is_published to false.

Business Verification

Pages can be verified on a business level by submitting their contact information along with documents that certify their legal existence. Once the verification request is submitted, Shoutit admin should manually review it and either accept or reject it.

Pages endpoints

https://dev.api.shoutit.com/docs/#!/pages

Clone this wiki locally