Table of Contents

Padoq stereotypes

Kate Santo Updated by Kate Santo

Stereotypes are a functionality that make creating and managing padoqs easier. The brand admin can create a number of stereotypes, each with different parameters that serve a specific purpose. They act as templates for padoqs. And when users create padoqs, they can select one of those preset stereotypes.

Stereotypes are managed via the CMS by the brand admin. Find out more about how they work in this guide.

See for yourself

  • You can download the iOS or Android app on your phone to follow this journey along. And you can also log in or sign up to the web app here
  • If you have access to the CMS (Content Management System), you can see what brand admins see by logging into it
  • You can also follow along by checking out the images or code snippets in this guide
  • And you will find the relevant endpoints linked and explained in this guide, but the full API is documented in Swagger UI

Creating stereotypes

  1. The brand admin logs into the CMS and opens stereotypes
  2. The createPadoqStereotype endpoint is called. It takes 1 parameter, namespace, which specifies the namespace where the stereotype will be created. The UI shows all of the properties in a padoq that can be preset via a stereotype. This is the full list:
    {
    "colour": "soft_pink",
    "permittedRichTags": [],
    "permittedPostTypes": [
    "BASIC",
    "COMMENT"
    ],
    "permittedGuestPostTypes": [
    "FORM_RS"
    ],
    "personaDetailsSchema": {},
    "maxVideoAttachmentSize": 0,
    "official": true,
    "minimumAge": 18,
    "allowPostTags": true,
    "privacyLevel": "PRIVATE",
    "personaProfilesPublic": true,
    "qrCodesEnabled": false,
    "allowGuests": false,
    "allowAttachments": true,
    "allowExternalLinks": true,
    "promoImageUri": {
    "uri": "string",
    "title": "string",
    "displayText": "string",
    "imageUri": "string",
    "mediaType": "image/jpeg",
    "mediaData": {
    "height": 100,
    "width": 100
    }
    },
    "adminCanUpdatePersonaDetails": true,
    "paymentProvidersConfig": {
    "additionalProp1": {},
    "additionalProp2": {},
    "additionalProp3": {}
    },
    "categories": [
    "East side",
    "North east"
    ],
    "clientAttributes": {},
    "permittedPrivileges": [
    "gold",
    "silver"
    ],
    "videoConfServerUri": "string",
    "displayOptions": {
    "options": [
    "HIDE_PADOQ_MENU"
    ]
    },
    "allowPayments": false,
    "imageLimit": 4,
    "adminImageLimit": 4,
    "attachmentLimit": 1,
    "maxAttachmentSize": 0,
    "maxRecipients": 50,
    "locationName": "Europe/Manchester",
    "autoAlias": true
    }
  3. Most of these properties are optional. So the brand admin can set them or not. If they don't set them, they will default to an established value. However, there are 5 properties in that list that always need to be specified:
    1. name: the name of the stereotype. It requires a string as its value and it needs to be unique within the brand
    2. personaProfilesPublic: this parameter sets whether members can view other members. One of the stereotypes in the free Padoq app is broadcast. In broadcast padoqs, admins can post and share content, but members can't. In padoqs like that, the personaProfilesPublic property is always false so members can't see other members' profiles
    3. colour: the colour that the padoqs in this stereotype will take as default
    4. permittedPostTypes: the post types that members of the padoq can create
    5. privacyLevel: sets the privacy level of the padoq. The possible values are public, secret and private. Public padoqs can be found in Explore and anyone in the app can join them (the padoq admin doesn't need to approve requests to join). Secret padoqs don't come up in Explore or in search and members can only join via an invite link. Private padoqs can be found in Explore, but the admin needs to approve requests to join

Reading stereotypes

When the brand admin launches stereotypes in the CMS, the getPadoqStereotypes endpoint is called. This returns a list of existing stereotypes (the name property is used in the UI). If there are stereotypes that are disabled, these also appear here.

When the brand admin opens a stereotype from that list, the content of the defaults property is displayed. This property contains all of the presets for that stereotype. In this example, it's empty just to keep it brief, but it can have any of the values explained in Creating stereotypes above.

{
"stereotypes": [
{
"name": "BROADCAST",
"description": "A mailshot style padoq stereotype. Only admins can post, members can only see admins in the member list.",
"defaults": {
}
}
]
}

Updating stereotypes

  1. The brand admin logs into the CMS and opens stereotypes. The getPadoqStereotypes endpoint is called
  2. The brand admin opens the stereotype they want to update. The full list of editable properties in the stereotype is displayed, with the values set in the defaults property
  3. When the user has made the necessary updates, the updatePadoqStereotype endpoint is called. It takes the name of the stereotype as a parameter, as well as the updates in the request body
  4. The stereotype is now updated

Deleting stereotypes

  1. The brand admin logs into the CMS and opens stereotypes. The getPadoqStereotypes endpoint is called
  2. The brand admin opens the stereotype they want to delete. There are 2 ways of deleting a stereotype in the UI, but both call the deletePadoqStereotype endpoint, which takes the name of the stereotype as a parameter and returns basic success or error messages

How did we do?

Creating a padoq (group)

Managing a padoq

Contact