Connectors Reference
Dynamic Signal is an Employee Communication and Engagement Platform, trusted by organizations to connect, align and engage employees. Connect to Dynamic Signal to create and manage your posts and users.
|
Status: Preview |
Tier: Premium |
Version: 1.0 |
|
Name |
Summary |
|
Get a user by email |
|
|
Get user tags |
|
|
Get divisions |
|
|
PutDocument (string fileName, string id, string File, string Content-Type) |
Upload a document to a post |
|
Preregister a user |
|
|
Upload image |
|
|
Get a post |
|
|
Create a post |
|
|
PutImageToPost (string id, string File, string Content-Type) |
Add an image to a post via upload |
|
AddImageToPost (string id, AddImageToPostParameterBody body) |
Add an image to a post via URL |
|
Update a post |
|
|
Get post tags |
|
|
Get categories |
|
|
Get targets |
|
|
Manage posts |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Get a user by email
Description: Retrieves a user by their email address
Syntax:
DynamicSignal.GetUserByEmail (GetUserByEmailParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Type:userRequestResponse
Summary: Get user tags
Description: Gets a list of user tags defined in the system
Syntax:
DynamicSignal.GetUserTags ()
Returns:
Description: A list of user tags defined in the system
Summary: Get divisions
Description: Gets the list of divisions
Syntax:
DynamicSignal.GetDivisions ()
Returns:
Type:divisionsResponse
Description: The divisions defined in the system
Summary: Upload a document to a post
Description: Uploads a document to a post via binary upload
Syntax:
DynamicSignal.PutDocument (string fileName, string id, string File, string Content-Type)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
fileName |
string (File Name) |
The document's preferred filename (with extension) |
True |
|
|
id |
string(uuid) (ID) |
The post ID |
True |
|
|
File |
string(binary)
|
|
True |
|
|
Content-Type |
string (Content-Type such as image/jpg, image/pjpeg, image/png, image/x-png, image/gif) |
Content-Type of uploaded file |
True |
Returns:
Type:documentInfoResponse
Description: Information relevant to an attached document
Summary: Preregister a user
Description: Creates a new user in the preregistered state
Syntax:
DynamicSignal.PreregisterUser (PreregisterUserParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Type:userRequestResponse
Summary: Upload image
Description: Uploads an image via binary upload
Syntax:
DynamicSignal.ManageImage (string File, string Content-Type)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
File |
string(binary)
|
|
True |
|
|
Content-Type |
string (Content-Type such as image/jpg, image/pjpeg, image/png, image/x-png, image/gif) |
Content-Type of uploaded file |
True |
Returns:
Type:uploadImageResponse
Summary: Get a post
Description: Gets a specific post by ID
Syntax:
DynamicSignal.GetPost (string id, [Optional]integer userId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string(uuid) (ID) |
The post ID.; This is the unique identifier for the post. |
True |
|
|
userId |
integer(int64) (User ID) |
The user who is viewing the post. The logged in user will be used if no ID is specified |
False |
Returns:
Type:postResponse
Description: A post
Summary: Create a post
Description: Creates a post.
Syntax:
DynamicSignal.CreatePost (CreatePostParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Type:postResponse
Description: A post
Summary: Add an image to a post via upload
Description: Sets the post image via binary upload.
Syntax:
DynamicSignal.PutImageToPost (string id, string File, string Content-Type)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string(uuid) (ID) |
The post ID |
True |
|
|
File |
string(binary)
|
|
True |
|
|
Content-Type |
string (Content-Type such as image/jpg, image/pjpeg, image/png, image/x-png, image/gif) |
Content-Type of uploaded file |
True |
Returns:
Type:successResponse
Description: A simple response indicating the action was carried out successfully
Summary: Add an image to a post via URL
Description: Sets the post image via a URL.
Syntax:
DynamicSignal.AddImageToPost (string id, AddImageToPostParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string(uuid) (ID) |
The post ID, required: true |
True |
|
|
body |
|
|
True |
Returns:
Type:successResponse
Description: A simple response indicating the action was carried out successfully
Summary: Update a post
Description: Edits an existing post.
Syntax:
DynamicSignal.UpdatePost (string id, UpdatePostParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string(uuid) (ID) |
The post ID |
True |
|
|
body |
|
|
True |
Returns:
Type:postResponse
Description: A post
Summary: Get post tags
Description: Gets the post tags defined in the system
Syntax:
DynamicSignal.GetPostTags ()
Returns:
Description: A list of post tags defined in the system
Summary: Get categories
Description: Gets a list of categories that are visible to the authenticated user
Syntax:
DynamicSignal.GetCategories ()
Returns:
Type:categoriesResponse
Description: Detailed information related to categories
Summary: Get targets
Description: Gets a list of the community's targets and target definitions
Syntax:
DynamicSignal.GetTargets ()
Returns:
Type:targetDefinitionsInfoResponse
Description: A list of target definitions and associated targets for the community.
Summary: Manage posts
Description: Allows server-authenticated calls to update properties for multiple posts in a single request
Syntax:
DynamicSignal.ManagePosts (ManagePostsParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Type:successResponse
Description: A simple response indicating the action was carried out successfully
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
url |
string Url |
The HTTP or HTTPS URL |
Summary:
Description: An affiliation answer
Properties:
|
Name |
Type |
Summary |
|
answerId |
integer(int64) Answer ID |
The answer ID |
|
answer |
string Answer |
The answer |
|
score |
number(double) Score |
The score, if provided |
|
freeText |
string Free Text |
Text for questions with FreeText question type |
|
declineToAnswer |
boolean Decline To Answer |
If set, this is the answer signifying that a user declined to answer the question. |
|
position |
integer(int64) Position |
The answers sorting position |
Summary:
Description: An affiliation question
Properties:
|
Name |
Type |
Summary |
|
questionId |
integer(int64) Question ID |
The question ID |
|
name |
string Name |
The question |
|
scorePosition |
integer(int32) Score Position |
The questions sorting position |
|
description |
string Description |
The questions description |
|
questionType |
string
|
Values: [SingleAnswer, MultipleAnswer, FreeText] |
|
required |
boolean Required |
Whether the question has to be answered to register |
|
isPubliclyVisible |
boolean Is Publicly Visible |
|
Summary:
Description: Detailed information related to categories
Properties:
|
Name |
Type |
Summary |
|
categories |
array of (categoryResponse)
|
|
|
subscriptionPrompt |
string Subscription Prompt |
The label to prompt members to select category subscriptions |
|
enableCategorySubscription |
boolean Enable Category Subscription |
Whether members are allowed to modify their category subscriptions |
|
requireSubscriptionSelection |
boolean Require Subscription Selection |
Whether members are required to select category subscriptions during onboarding |
|
landingPageDefaultCategory |
integer(int64) Landing Page Default Category |
The default content to show when loading news feed information |
Summary:
Description: Basic category information
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int64) ID |
The category ID |
|
name |
string Name |
The category name |
|
parentCategoryId |
integer(int64) Parent Category ID |
The parent category ID |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int64) ID |
The category ID |
|
name |
string Name |
The category name |
|
description |
string Description |
The category description |
|
displayOrder |
integer(int32) Display Order |
The order in which to display the category |
|
isPinned |
boolean Is Pinned |
Whether the category has been pinned by an administrator |
|
isForced |
boolean Is Forced |
Whether the authenticated user is force-subscribed to the given category |
|
isSubscribed |
boolean Is Subscribed |
Wther the authenticated user is subscribed to the given category |
|
isHidden |
boolean Is Hidden |
Whether the category is hidden by an administrator |
|
isUserSelectable |
boolean Is User Selectable |
Whether users are allowed to select categories for submitted posts |
|
parentCategoryId |
integer(int64) Parent Category ID |
The parent category ID |
|
childCategories |
array of (categoryResponse1)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int64) ID |
The category ID |
|
name |
string Name |
The category name |
|
description |
string Description |
The category description |
|
displayOrder |
integer(int32) Display Order |
The order in which to display the category |
|
isPinned |
boolean Is Pinned |
Whether the category has been pinned by an administrator |
|
isForced |
boolean Is Forced |
Whether the authenticated user is force-subscribed to the given category |
|
isSubscribed |
boolean Is Subscribed |
Wther the authenticated user is subscribed to the given category |
|
isHidden |
boolean Is Hidden |
Whether the category is hidden by an administrator |
|
isUserSelectable |
boolean Is User Selectable |
Whether users are allowed to select categories for submitted posts |
|
parentCategoryId |
integer(int64) Parent Category ID |
The parent category ID |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
description |
string Description |
The short description of the post |
|
tagLine |
string Tag Line |
The tag line of the post |
|
content |
string Content |
The body of the post |
|
creatorComments |
string Creator Comments |
A message associated with the post |
|
permaLink |
string Perma Link |
The external URL referenced by the post |
|
internalDiscussionsEnabled |
boolean Internal Discussions Enabled |
Whether members are allowed to perform like action and add comments on posts internally |
|
title |
string Title |
The title of the post |
|
memberVideoUrl |
string Member Video Url |
The video URL referenced by the post |
|
postType |
string Post Type |
The basic type of the post Values: [Text, Video] |
|
approvalState |
string Approval State |
The approval state of the post. Defaults to the author's Review Status setting. Values: [Pending, Published, Excluded] |
|
displayMode |
string Display Mode |
Indicates redirection of a post to an internal or external location Values: [DisplayInApp, OpenExternally] |
|
sharable |
boolean Sharable |
Whether the VoiceStorm platform and widgets will allow for the post to be shared |
|
startDate |
string(date-time) Start Date |
The date after which the post is available for viewing |
|
endDate |
string(date-time) End Date |
The date the after which the post will no longer be available for viewing |
|
suggestedShareText |
string Suggested Share Text |
The suggested share text for the post |
|
shortSuggestedShareText |
string Short Suggested Share Text |
The suggested share text for the post for short message providers |
|
sharePoints |
integer(int32) Share Points |
The number of points awarded when a user shares the post |
|
clickPoints |
integer(int32) Click Points |
The number of points awarded when someone clicks on a shared link to the post |
|
shareWithImages |
boolean Share With Images |
Controls if posts shared to short message services (like Twitter) have images shared |
|
shareImagesOnly |
boolean Share Images Only |
Controls if posts shared to certain services are treated as image/photo only updates |
|
tags |
array of (postTagRequestResponse) Tags |
A list of tags that have been set on the post |
|
language |
string Language |
The language of the post content |
|
documents |
array of (string(uuid)) Documents |
A list of documents IDs to attach to this post |
|
creatorId |
integer(int64) Creator ID |
The user that is creating the post; This property is only available for server-authenticated requests at this time. All other posts are automatically set to the authenticated user. |
|
displayCreator |
boolean Display Creator |
Controls whether the creator information is to be displayed with the post or not; This property is only available for server-authenticated requests at this time. |
|
categoryIds |
array of (integer(int64)) Category IDs |
A list of category IDs that have been assigned to the post |
|
targetIds |
array of (integer(int64)) Target IDs |
A list of target Ids that have been assigned to the post |
Summary:
Description: A division definition
Properties:
|
Name |
Type |
Summary |
|
divisionId |
integer(int64) Division ID |
The division ID |
|
name |
string Name |
The division name |
|
parentDivisionId |
integer(int64) Parent Division ID |
The ID of this divisions parent |
Summary:
Description: The divisions defined in the system
Properties:
|
Name |
Type |
Summary |
|
divisions |
array of (divisionResponse)
|
|
|
prompt |
string Prompt |
The label to prompt members to select a division |
|
showUserDivisionSelection |
boolean Show User Division Selection |
Whether registered members can change their own division |
|
showUserDivisionSelectionDuringOnboarding |
boolean Show User Division Selection During Onboarding |
Whether new members should select their own division during registration |
|
requireUserDivisionSelection |
boolean Require User Division Selection |
Whether members must select their own division. |
|
allowMultipleDivisions |
boolean Allow Multiple Divisions |
Whether members are allowed to select multiple or only one division |
Summary:
Description: Information relevant to an attached document
Properties:
|
Name |
Type |
Summary |
|
id |
string(uuid) ID |
The documents ID |
|
fileName |
string File Name |
The documents filename (with extension) |
|
extension |
string Extension |
The documents file extension |
|
mimeType |
string Mime Type |
The documents MIME type |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string |
The user's email |
|
include |
array of (string) Include |
Specifies optional data to return with the user. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
postIds |
array of (string(uuid)) Post IDs |
The posts being modified |
|
tags |
array of (string) Tags |
A collection of tag names that can be applied to posts |
|
divisionIds |
array of (integer(int64)) Division IDs |
The division IDs to which the posts belong |
|
categoryIds |
array of (integer(int64)) Category IDs |
The category ID's to which the posts belong |
|
targetIds |
array of (integer(int64)) Target IDs |
The target ID's to which the posts belong |
|
approvalState |
string Approval State |
The Approval state for the posts (This is not affected by the DELETE requests) Values: [Pending, Published, Excluded] |
Summary:
Description: Detailed information for a specific post tag
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int64) ID |
The tag ID |
|
name |
string Name |
The tag name |
|
isAvailableToMembers |
boolean Is Available To Members |
Determines if the tag is avilable to be used on member-facing post submission pages (if enabled) |
Summary:
Description: A list of post tags defined in the system
Properties:
|
Name |
Type |
Summary |
|
tags |
array of (managePostTagResponse)
|
|
Summary:
Description: Detailed information for a specific user tag
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int64) ID |
The tag ID |
|
name |
string Name |
The tag name |
|
type |
string
|
Values: [Tag, Attribute] |
|
acceptedValues |
array of (string)
|
|
Summary:
Description: A list of user tags defined in the system
Properties:
|
Name |
Type |
Summary |
|
tags |
array of (manageUserTagResponse)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
author |
string Author |
The stored text to display as the author. |
|
profileImageUrl |
string Profile Image Url |
The authors profile picture on the social network |
|
providerUserId |
string Provider User ID |
The authors ID on the social network |
|
providerUserName |
string Provider User Name |
The authors name on the social network |
|
profileUrl |
string Profile Url |
The authors profile URL on the social network |
|
postSourceName |
string Post Source Name |
The name of the source of the post. |
|
postSourceSite |
string Post Source Site |
The website in which the post originated |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
url |
string Url |
The images URL |
|
width |
integer(int32) Width |
The images width |
|
height |
integer(int32) Height |
The images height |
|
mimeType |
string Mime Type |
The images MIME type |
|
sslUrl |
string Ssl Url |
The images secure URL |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
url |
string Url |
The posts URL |
|
expandedUrl |
string Expanded Url |
The expanded URL (if it exists) |
|
title |
string Title |
The posts title |
|
domain |
string Domain |
The links domain |
|
faviconUrl |
string Favicon Url |
The favicon URL of the link |
|
name |
string Name |
The name of the link assigned by the social provider |
|
caption |
string Caption |
The short caption of the link (i.e., the text under the link) |
|
description |
string Description |
The description of the link (i.e., the longer text under the caption) |
|
modifiedDate |
string(date-time) Modified Date |
|
|
createdDate |
string(date-time) Created Date |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Name |
The name of the media object |
|
width |
integer(int32) Width |
The width of the media object in pixels |
|
height |
integer(int32) Height |
The height of the media object in pixels |
|
mimeType |
string Mime Type |
The MIME type of the media object |
|
html |
string Html |
HTML that can be used to render the media object |
|
url |
string Url |
The URL to the media object |
|
origin |
string Origin |
If available, specifies the original location of the media object |
|
provider |
string Provider |
The social provider name |
|
role |
string Role |
The type of media (if determined) |
|
duration |
integer(int64) Duration |
The video duration in milliseconds |
|
description |
string Description |
The video format description |
|
hasVideoUrl |
boolean Has Video Url |
Indicates that this media has a video URL that must be signed by using the "WatchVideo" include |
Summary:
Description: A post
Properties:
|
Name |
Type |
Summary |
|
postId |
string(uuid) Post ID |
The post ID |
|
postSourceId |
integer(int64) Post Source ID |
The source ID |
|
title |
string Title |
The title of the post |
|
description |
string Description |
The short description of the post |
|
tagLine |
string Tag Line |
The tag line of the post |
|
content |
string Content |
The body of the post |
|
rawContent |
string Raw Content |
The body of the post including all HTML (when both Content and RawContent are included) |
|
creatorComments |
string Creator Comments |
A message associated with the post |
|
creatorInfo |
|
Summary information about a user |
|
location |
string Location |
Geographic location related to the post |
|
properties |
Properties |
Miscellaneous properties of the post. Not available with all post types |
|
permaLink |
string Perma Link |
The external URL referenced by the post |
|
cleanPermaLink |
string Clean Perma Link |
The permalink (excluding problematic spaces and newlines) |
|
postType |
string
|
Values: [Text, Video] |
|
postSourceType |
string
|
Values: [Member, Manager, Brand] |
|
postBylineType |
string
|
Values: [Author, Source, Hidden] |
|
provider |
string Provider |
The social provider from which the post originated (e.g., Facebook, Twitter). |
|
approvalState |
string
|
Values: [Pending, Published, Excluded] |
|
displayMode |
string
|
Values: [DisplayInApp, OpenExternally] |
|
status |
string
|
Values: [Active, Archived] |
|
userEditable |
boolean User Editable |
|
|
userShareable |
boolean User Shareable |
Indicates whether the current user is able to share the post. If no current user, defaults to true. |
|
userCommentable |
boolean User Commentable |
Indicates whether the current user is able to participate in dicussions on the post. If no current user, defaults to false. |
|
sharable |
boolean Sharable |
Whether the platform and widgets will allow for the post to be shared |
|
broadcasted |
boolean Broadcasted |
Whether the post has been broadcast to users for sharing |
|
pinned |
boolean Pinned |
Whether the post has been set for priority display in streams |
|
publishDate |
string(date-time) Publish Date |
For user-submitted content, the date of post submission; for content imported from an external source, the publication date according to the source |
|
startDate |
string(date-time) Start Date |
The date after which the post is available for viewing |
|
endDate |
string(date-time) End Date |
The date the after which the post will no longer be available for viewing |
|
eventStartDate |
string(date-time) Event Start Date |
The date the event begins (for event-type posts) |
|
eventEndDate |
string(date-time) Event End Date |
The date the event ends (for event-type posts) |
|
providerTimeStamp |
string(date-time) Provider Time Stamp |
The date of the post from the providers perspective, i.e., when it was originally posted on the social provider |
|
receivedPublishPoints |
boolean Received Publish Points |
Whether the user who submitted the post received points when the post was published |
|
suggestedShareText |
string Suggested Share Text |
The suggested share text for the post |
|
shortSuggestedShareText |
string Short Suggested Share Text |
The suggested share text for the post for short message providers |
|
suggestedShareTextList |
array of (string)
|
|
|
shortSuggestedShareTextList |
array of (string)
|
|
|
sharePoints |
integer(int32) Share Points |
The number of points awarded when a user shares the post |
|
clickPoints |
integer(int32) Click Points |
The number of points awarded when someone clicks on a shared link to the post |
|
providerPostId |
string Provider Post ID |
The original ID of the post on the providers network |
|
urlSlug |
string Url Slug |
The SEO text to put in public links to the post |
|
classification |
string Classification |
The type of post on the providers network. |
|
shareWithImages |
boolean Share With Images |
Controls if posts shared to short message services (like Twitter) have images shared |
|
shareImagesOnly |
boolean Share Images Only |
Controls if posts shared to certain services are treated as image/photo only updates |
|
actions |
string Actions |
A JSON blob containing a list of action items for the post and URLs |
|
mentions |
string Mentions |
The mentions (users, hash tags, etc.) stored as a JSON blob. |
|
statistics |
|
|
|
userShareInfo |
|
|
|
author |
|
|
|
links |
array of (postLinkRequestResponse)
|
|
|
tags |
array of (postTagRequestResponse)
|
|
|
media |
array of (postMediaRequestResponse)
|
|
|
images |
|
|
|
candidateImages |
array of (postCandidateImageResponse)
|
|
|
visible |
boolean Visible |
Whether the post is currently visible |
|
shareDisclosures |
array of (postShareDisclosureResponse)
|
|
|
shareCommentRules |
array of (postShareCommentRulesResponse)
|
|
|
language |
string Language |
The language of the post content |
|
userHidden |
boolean User Hidden |
Whether the user has hidden the post from one or more streams |
|
isViewedByUser |
boolean Is Viewed By User |
Whether the post has been viewed by the current user. |
|
isDiscussionViewedByUser |
boolean Is Discussion Viewed By User |
Whether the posts discussion thread has been viewed by the current user |
|
isLikedByUser |
boolean Is Liked By User |
Whether the post has been internally liked by the current user. |
|
isCommentedByUser |
boolean Is Commented By User |
Whether the post has been commented on by the current user. |
|
isSharedByUser |
boolean Is Shared By User |
Whether the post has been previously shared by the current user |
|
targets |
array of (targetOverviewResponse)
|
|
|
categories |
array of (categoryOverviewResponse)
|
|
|
currentTime |
string(date-time) Current Time |
The current time on the server. |
Summary: Properties
Description: Miscellaneous properties of the post. Not available with all post types
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
provider |
string
|
Values: [None, Twitter, Blog, Facebook, Yelp, Flickr, Foursquare, SMS, WordPress, TypePad, LiveJournal, Blogger, FacebookPage, GenericUrl, YouTube, SyndicatedUrl, Email, Tumblr, GooglePlus, SquareSpace, LinkedIn, Posterous, Joomla, Drupal, MovableType, Reddit, VK, Picasa, Vimeo, Instagram, Sonico, Odnoklassniki, GetGlue, LastFM, BazaarVoice, LinkedInGroup, Chatter, Weibo, Tencent, Pinterest, LinkedInPage, CutAndPaste, Bitly, Jive, GoogleContact, Office365, JivePlace, Xing, SapJam, SalesforceSocialStudio, Slack, Yammer, SmartContent, CiscoSpark, FacebookWorkplace, InstagramBusiness, FacebookNative] |
|
shareMaxCharacterLimit |
integer(int32) Share Max Character Limit |
The maximum length of a users comment in a share on this provider. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
provider |
string
|
Values: [None, Twitter, Blog, Facebook, Yelp, Flickr, Foursquare, SMS, WordPress, TypePad, LiveJournal, Blogger, FacebookPage, GenericUrl, YouTube, SyndicatedUrl, Email, Tumblr, GooglePlus, SquareSpace, LinkedIn, Posterous, Joomla, Drupal, MovableType, Reddit, VK, Picasa, Vimeo, Instagram, Sonico, Odnoklassniki, GetGlue, LastFM, BazaarVoice, LinkedInGroup, Chatter, Weibo, Tencent, Pinterest, LinkedInPage, CutAndPaste, Bitly, Jive, GoogleContact, Office365, JivePlace, Xing, SapJam, SalesforceSocialStudio, Slack, Yammer, SmartContent, CiscoSpark, FacebookWorkplace, InstagramBusiness, FacebookNative] |
|
providerDisplayName |
string Provider Display Name |
The providers display name |
|
shareDisclosureText |
string Share Disclosure Text |
The disclosure text appended to each share |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
totalInAppShareCount |
integer(int32) Total In App Share Count |
Synonym for ShareCount |
|
trackingId |
string Tracking ID |
|
|
shareCount |
integer(int64) Share Count |
The count of shares initiated in the app that have been verified as successfully shared |
|
reactionCount |
integer(int64) Reaction Count |
The count of reactions (likes, retweets, etc.) to shares |
|
impressionCount |
integer(int64) Impression Count |
The potential views of a post by sharers friends and followers |
|
viewedCount |
integer(int64) Viewed Count |
The number of times the post has been visited by logged-in users |
|
clickCount |
integer(int64) Click Count |
The count of clicks to the posts link from shares |
|
likeCount |
integer(int64) Like Count |
The count of internal likes on the post |
|
commentCount |
integer(int64) Comment Count |
The count of internal comments on the post |
|
commentLikeCount |
integer(int64) Comment Like Count |
The sum of all likes across all internal comments on the post |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Name |
The tag name |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
pointsEarned |
integer(int32) Points Earned |
The number of points earned by the user for sharing |
|
shareCount |
integer(int32) Share Count |
The number of times the user shared |
|
mostRecentShareDate |
string(date-time) Most Recent Share Date |
Date of the users most recent share of this post |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string |
The user's email address |
|
externalSsoUserId |
string External Sso User ID |
The user's ID on the external system managed by the SSO Identity Provider |
|
handle |
string Handle |
The user's handle |
|
firstName |
string First Name |
The user's first name. |
|
lastName |
string Last Name |
The user's last name. |
|
divisionIds |
array of (integer(int64)) Division IDs |
A list of divisions to which the user will be assigned. |
|
targetIds |
array of (integer(int64)) Target IDs |
A list of targets to assign to the user. |
|
tags |
array of (userTagRequestResponse) Tags |
A list of tags to assign to the user. |
|
sendInvitationEmail |
boolean Send Invitation Email |
Determines whether to send an invitation email to the user. |
|
invitationMessage |
string Invitation Message |
An optional plain text message to include in the invitation email. |
|
notificationsDefault |
string Notifications Default |
Setting that controls when the users will start receiving email notifications. Values: [Immediately, AfterFirstLogin] |
|
privileges |
|
Privileges that can be assigned to a user during registration via integrations |
Summary:
Description: A simple response indicating the action was carried out successfully
Properties:
|
Name |
Type |
Summary |
|
code |
string Code |
A value of "success" indicates a successful operation |
Summary:
Description: Detailed information for a specific target definition and its associated targets
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int64) ID |
The Id of the target definition |
|
name |
string Name |
The name of the target definition |
|
getUserConfirmation |
boolean Get User Confirmation |
Determines whether a user is asked to confirm/select their preference |
|
allowMultipleSelections |
boolean Allow Multiple Selections |
Determines whether multiple targets can be selected |
|
selectionRequired |
boolean Selection Required |
Determines whether a selection in this definition is required |
|
targetSelectionPrompt |
string Target Selection Prompt |
A customized label to prompt users to select their preference |
|
childTargets |
array of (targetInfoResponse)
|
|
Summary:
Description: A list of target definitions and associated targets for the community.
Properties:
|
Name |
Type |
Summary |
|
definitions |
array of (targetDefinitionInfoResponse)
|
|
Summary:
Description: Detailed information for a specific target.
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int64) ID |
The target ID |
|
name |
string Name |
The name of the target |
|
description |
string Description |
The targets descritption |
|
definitionId |
integer(int64) Definition ID |
The ID of the target definition the target belongs to |
|
parentId |
integer(int64) Parent ID |
The ID of the targets parent, if it has one |
|
isSubscribed |
boolean Is Subscribed |
Whether the user is subscribed to a specific target |
|
childTargets |
array of (targetInfoResponse1)
|
|
Summary:
Description: Detailed information for a specific target.
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int64) ID |
The target ID |
|
name |
string Name |
The name of the target |
|
description |
string Description |
The targets descritption |
|
definitionId |
integer(int64) Definition ID |
The ID of the target definition the target belongs to |
|
parentId |
integer(int64) Parent ID |
The ID of the targets parent, if it has one |
|
isSubscribed |
boolean Is Subscribed |
Whether the user is subscribed to a specific target |
|
childTargets |
array of (targetInfoResponse2)
|
|
Summary:
Description: Detailed information for a specific target.
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int64) ID |
The target ID |
|
name |
string Name |
The name of the target |
|
description |
string Description |
The targets descritption |
|
definitionId |
integer(int64) Definition ID |
The ID of the target definition the target belongs to |
|
parentId |
integer(int64) Parent ID |
The ID of the targets parent, if it has one |
|
isSubscribed |
boolean Is Subscribed |
Whether the user is subscribed to a specific target |
|
childTargets |
array of (targetInfoResponse3)
|
|
Summary:
Description: Detailed information for a specific target.
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int64) ID |
The target ID |
|
name |
string Name |
The name of the target |
|
description |
string Description |
The targets descritption |
|
definitionId |
integer(int64) Definition ID |
The ID of the target definition the target belongs to |
|
parentId |
integer(int64) Parent ID |
The ID of the targets parent, if it has one |
|
isSubscribed |
boolean Is Subscribed |
Whether the user is subscribed to a specific target |
Summary:
Description: A lightweight target response consisting of the targets name, ID, and the ID of the target definition it belongs to
Properties:
|
Name |
Type |
Summary |
|
name |
string Name |
The targets name |
|
id |
integer(int64) ID |
The targets ID |
|
definitionId |
integer(int64) Definition ID |
The ID of the target definition to which the target belongs |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
title |
string Title |
The title of the post |
|
description |
string Description |
The short description of the post |
|
tagLine |
string Tag Line |
The tag line of the post |
|
content |
string Content |
The body of the post |
|
creatorComments |
string Creator Comments |
A message associated with the post |
|
permaLink |
string Perma Link |
The external URL referenced by the post |
|
internalDiscussionsEnabled |
boolean Internal Discussions Enabled |
Whether members are allowed to perform like action and add comments on posts internally |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
imageIdentifier |
string Image Identifier |
The identifier to the uploaded image |
Summary:
Description: A user affiliation
Properties:
|
Name |
Type |
Summary |
|
question |
|
An affiliation question |
|
answer |
|
An affiliation answer |
Summary:
Description: A user channel.
Properties:
|
Name |
Type |
Summary |
|
userChannelId |
integer(int64) User Channel ID |
The internal user channel ID |
|
userId |
integer(int64) User ID |
The internal user ID |
|
provider |
string
|
Values: [None, Twitter, Blog, Facebook, Yelp, Flickr, Foursquare, SMS, WordPress, TypePad, LiveJournal, Blogger, FacebookPage, GenericUrl, YouTube, SyndicatedUrl, Email, Tumblr, GooglePlus, SquareSpace, LinkedIn, Posterous, Joomla, Drupal, MovableType, Reddit, VK, Picasa, Vimeo, Instagram, Sonico, Odnoklassniki, GetGlue, LastFM, BazaarVoice, LinkedInGroup, Chatter, Weibo, Tencent, Pinterest, LinkedInPage, CutAndPaste, Bitly, Jive, GoogleContact, Office365, JivePlace, Xing, SapJam, SalesforceSocialStudio, Slack, Yammer, SmartContent, CiscoSpark, FacebookWorkplace, InstagramBusiness, FacebookNative] |
|
name |
string Name |
The users name on the social provider |
|
displayName |
string Display Name |
The users display name on the social provider |
|
providerUserId |
string Provider User ID |
The providers user ID |
|
status |
string
|
Values: [Active, Archived, AuthRequired] |
|
url |
string Url |
The URL for the channel |
|
friends |
integer(int32) Friends |
The number of friends the user has on the channel |
|
followers |
integer(int32) Followers |
The number of followers the user has on the channel |
|
following |
integer(int32) Following |
The number of people the user is following on the channel |
|
posts |
integer(int32) Posts |
The number of posts the user has made on the channel. |
|
views |
integer(int32) Views |
The number of views the user has on the channel |
|
pointBalance |
integer(int64) Point Balance |
The point balance of the user on the channel |
|
sourceDisplayName |
string Source Display Name |
The display name of the user channel when used as a content source |
|
reach |
integer(int32) Reach |
The users reach on the channel |
|
sharable |
boolean Sharable |
Whether the channel supports sharing |
|
sharingDefault |
boolean Sharing Default |
Whether the channel is preselected for sharing |
|
authRequired |
boolean Auth Required |
Whether the channels credentials need to be renewed |
|
statistics |
|
|
|
profilePictureImages |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: A collection of a users defaults
Properties:
|
Name |
Type |
Summary |
|
defaultPostState |
string
|
Values: [Shareable, NonShareable] |
|
defaultPostApprovalState |
string
|
Values: [Pending, Published, Excluded] |
|
defaultPostShowInternalDiscussions |
boolean Default Post Show Internal Discussions |
The users default post internal discussions state when creating a post |
|
defaultPostShowCreatorInfo |
boolean Default Post Show Creator Info |
The users default state when creating a post regarding showing creator name and photo |
Summary:
Description: Summary information about a user
Properties:
|
Name |
Type |
Summary |
|
userId |
integer(int64) User ID |
ID of the user |
|
displayName |
string Display Name |
Display name of the user |
|
profilePictureImages |
|
|
|
isActive |
boolean Is Active |
Whether the user is still an active member of the community |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: A managers permissions
Properties:
|
Name |
Type |
Summary |
|
viewBroadcast |
boolean View Broadcast |
Allows the manager to view broadcasts |
|
listBroadcast |
boolean List Broadcast |
Allows the manager to view lists of broadcasts |
|
editBroadcast |
boolean Edit Broadcast |
Allows the manager to create and edit broadcasts |
|
viewBroadcastStats |
boolean View Broadcast Stats |
Allows the manager to view broadcast stats |
|
viewPost |
boolean View Post |
Allows the manager to view posts |
|
listPost |
boolean List Post |
Allows the manager to view lists of posts |
|
editPost |
boolean Edit Post |
Allows the manager to create and edit posts |
|
viewPostStats |
boolean View Post Stats |
Allows the manager to view post stats |
|
viewSurvey |
boolean View Survey |
Allows the manager to view surveys |
|
listSurvey |
boolean List Survey |
Allows the manager to view lists of surveys |
|
editSurvey |
boolean Edit Survey |
Allows the manager to create and edit surveys |
|
communitySettings |
boolean Community Settings |
Allows the manager to view and edit community settings |
Summary:
Description: Privileges that can be assigned to a user during registration via integrations
Properties:
|
Name |
Type |
Summary |
|
canSharePosts |
boolean Can Share Posts |
Indicates if the user has the ability to share posts |
|
canCommentPosts |
boolean Can Comment Posts |
Indicates if the user has the ability to comment and like posts |
|
canSubmitPosts |
boolean Can Submit Posts |
Indicates if the user has the ability to submit posts |
|
canManageOrganization |
boolean Can Manage Organization |
Indicates if the user has the ability to communicate with direct and indirect reports within the community |
Summary:
Description: A users privileges
Properties:
|
Name |
Type |
Summary |
|
canSubmitPosts |
boolean Can Submit Posts |
Indicates if the user has the ability to submit posts, based on their privileges and the community settings |
|
canSharePosts |
boolean Can Share Posts |
Indicates if the user has the ability to share posts, based on their privileges and the community settings |
|
canCommentPosts |
boolean Can Comment Posts |
Indicates if the user has the ability to comment and like posts, based on their privileges and the community settings |
|
canManageCommunity |
boolean Can Manage Community |
Indicates if the user is a manager within community, based on their privileges and the community settings |
|
canManageOrganization |
boolean Can Manage Organization |
Indicates if the user has the ability to communicate with direct and indirect reports within the community, based on their privileges and the community settings |
|
canSetPostShareable |
boolean Can Set Post Shareable |
Whether the user can set the Shareable status when submitting a post |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int64) ID |
The users internal ID |
|
|
string |
The users email address |
|
handle |
string Handle |
The users handle (the "user name") |
|
displayName |
string Display Name |
The users preferred display name |
|
fullName |
string Full Name |
The first and last name of the user |
|
firstName |
string First Name |
The users first name |
|
lastName |
string Last Name |
The users last name |
|
displayNameFormat |
string
|
Values: [Full, Short] |
|
status |
string
|
Values: [New, Active, Archived, Suspended, Preregistered, PendingApproval, Rejected] |
|
profileCompleted |
boolean Profile Completed |
Whether the users profile was completed during onboarding |
|
lastActivityDate |
string(date-time) Last Activity Date |
The last time the user interacted with the system. |
|
title |
string Title |
The users title |
|
location |
string Location |
The users self-described location (may not be an actual geographic location) |
|
externalApiUserId |
string External Api User ID |
The users ID on the external system managed by the caller of this API |
|
managerUserId |
integer(int64) Manager User ID |
The ID of the users manager (for organizational hierarchy features) |
|
timeZone |
string Time Zone |
User time zone represented as a tz database time zone name as set by IANA. Example: "America/Los_Angeles". |
|
selectedTimeZone |
string Selected Time Zone |
The users selected time zone represented as a tz database time zone name as set by IANA. Example: "America/Los_Angeles". |
|
pointBalance |
integer(int64) Point Balance |
The total points earned to date |
|
unredeemedPoints |
integer(int64) Unredeemed Points |
The points currently available for redemption |
|
redeemedPoints |
integer(int64) Redeemed Points |
The number of points redeemed over the users lifetime |
|
apiInfo |
string Api Info |
API-specific property bag |
|
hasPassword |
boolean Has Password |
Whether the user has a password associated with the account. |
|
mustChangePassword |
boolean Must Change Password |
Whether the user must change their password based on community settings |
|
isAccountVerified |
boolean Is Account Verified |
Indicates if the user has verified their email address |
|
statistics |
|
|
|
tags |
|
|
|
badges |
|
|
|
affiliations |
array of (userAffiliationResponse)
|
|
|
divisions |
array of (divisionResponse)
|
|
|
channels |
array of (userChannelResponse)
|
|
|
profilePictureImages |
|
|
|
languages |
array of (string)
|
|
|
primaryLanguage |
string Primary Language |
The users primary interface language |
|
scheduleSettings |
|
A users scheduled sharing preferences |
|
isSso |
boolean Is Sso |
Whether the user is setup to authenticate using SSO |
|
permissions |
|
A managers permissions |
|
privileges |
|
A users privileges |
|
identifiers |
array of (whitelistIdentifiersResponse)
|
|
|
targets |
array of (targetOverviewResponse)
|
|
|
defaults |
|
A collection of a users defaults |
|
welcomeBannerDismissed |
boolean Welcome Banner Dismissed |
Whether the user has dismissed the welcome banner |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: A users scheduled sharing preferences
Properties:
|
Name |
Type |
Summary |
|
days |
string
|
Values: [Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday] |
|
times |
array of (string)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Name |
The tag or attribute name |
|
value |
string Value |
The optional value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int64) ID |
The whitelist definition ID |
|
value |
string Value |
The users response for the given whitelist definition |