Social Overview
Overview
This API provides Social Brand management, enabling businesses to create and manage their social media presence. A brand represents a social profile tied to a business, with attributes such as name, category, and business intent. Users can be assigned to brands to manage access.
Social Brands API Attributes
Given below are the response fields returned for the API endpoints in Social Brands.
Create a brand
| Name | Field Type | Description |
|---|---|---|
id |
String | The unique ID of the created brand |
name |
String | The name of the brand (required) |
businessIntent |
String | The primary intent of the business, e.g. LOCAL_BUSINESS (required) |
categories |
Array | The list of categories the brand belongs to (required) |
website |
String | The website URL of the brand |
phone |
String | The contact phone number for the brand |
description |
String | A description of the brand |
profileImageUrl |
String | URL of the brand’s profile image |
coverImageUrl |
String | URL of the brand’s cover image |
Assign a user to a brand
| Name | Field Type | Description |
|---|---|---|
socialProfileIds |
Array | The list of brand IDs the user is being assigned to. Derived from the URL — supports a single ID or multiple comma-separated IDs |
userId |
String | The ID of the user to assign to the brand(s) |