Docs/Models

SocialChannel

object

A connected social channel.

The public view of a social channel a project has connected. Access tokens are never exposed. Add one via Add Social Channel, which returns an OAuth URL to complete the connection.

Fields

_idstringrequired

Unique channel identifier.

platformSocialPlatformrequired

The platform this channel posts to.

statusSocialChannelStatusrequired

The connection state.

infoobjectoptional

Display details read live from the platform. Absent when the platform call fails or the channel is not connected yet.

namestringrequired

The account display name.

handlestringrequired

The account handle, without a leading @.

imagestringoptional

The profile image URL.

Example

{
  "_id": "a1b2c3d4e5f6",
  "platform": "x",
  "status": "CONNECTED",
  "info": {
    "name": "Fountain",
    "handle": "fountain_app",
    "image": "https://pbs.twimg.com/profile_images/fountain.jpg"
  }
}

Example

{
  "_id": "a1b2c3d4e5f6",
  "platform": "x",
  "status": "CONNECTED",
  "info": {
    "name": "Fountain",
    "handle": "fountain_app",
    "image": "https://pbs.twimg.com/profile_images/fountain.jpg"
  }
}