Connectors Reference

Buffer

Buffer is a social media management for marketers and agencies. Access your pending and sent updates, social media profiles, and more.

 

Status: Preview

Tier: Standard

Version: 1.0.0

 

Actions:

Name

Summary

CreateUpdate (string CreateUpdateProfileId, string CreateUpdateText)

Create an update

ShareUpdate (string profile_id, string udpate_id)

Share an update

ListProfiles ()

List profiles

ListUpdates (string profile_id)

List updates

 

Triggers:

Name

Summary

TrigPendingUpdates (string profile_id)

When an update is pending

TrigSentUpdates (string profile_id)

When an update is shared

 

Objects:

Name

Summary

CreateUpdateResponse

 

ListPendingUpdatesResponse

 

ListProfilesResponseItem

 

ListSentUpdatesResponse

 

ShareUpdateResponse

 

 

Actions:

CreateUpdate

Summary: Create an update

Description: Create an update for a specific profile.

 

Syntax:

Buffer.CreateUpdate (string CreateUpdateProfileId, string CreateUpdateText)

 

Parameters:

Name

Type

Summary

Required

Related Action

CreateUpdateProfileId

string

(Profile ID)

Profile

True

ListProfiles

CreateUpdateText

string

(Text)

 

True

 

Returns:

          Type:CreateUpdateResponse

 

ShareUpdate

Summary: Share an update

Description: Share a pending update.

 

Syntax:

Buffer.ShareUpdate (string profile_id, string udpate_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

profile_id

string

(Profile ID)

Profile

True

ListProfiles

udpate_id

string

(Update ID)

Update

True

ListUpdates

 

Returns:

          Type:ShareUpdateResponse

 

ListProfiles

Summary: List profiles

Description: List profiles

 

Syntax:

Buffer.ListProfiles ()

 

Returns:

          Type:array of (ListProfilesResponseItem)

 

ListUpdates

Summary: List updates

Description: List pending updates for the specified social media profile.

 

Syntax:

Buffer.ListUpdates (string profile_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

profile_id

string

(Profile ID)

Profile

True

ListProfiles

 

Returns:

          Type:ListPendingUpdatesResponse

 

Triggers:

Trigger TrigPendingUpdates

Summary: When an update is pending

Description: Triggers a new flow When an update is pending.

 

Syntax:

Buffer.TrigPendingUpdates (string profile_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

profile_id

string

(Profile ID)

Profile

True

ListProfiles

 

Returns:

          Type:ListPendingUpdatesResponse

 

Trigger TrigSentUpdates

Summary: When an update is shared

Description: Triggers a new flow When an update is shared.

 

Syntax:

Buffer.TrigSentUpdates (string profile_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

profile_id

string

(Profile ID)

Profile

True

ListProfiles

 

Returns:

          Type:ListSentUpdatesResponse

 


 

CreateUpdateResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

updates

array of (UpdatesItem)

 

updates

 

UpdatesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

created_at

integer(int32)

Created At

The datetime the update was created at.

day

string

Day

The text version of the date the update is due.

due_at

integer(int32)

Due At

The datetime when the update is due.

due_time

string

Due Time

The time when the update is due.

id

string

Id

The id of the update.

profile_id

string

Profile Id

The id of the profile associated with the update.

profile_service

string

Profile Update

The service of the profile associated with the update.

shared_now

boolean

IsSharedNow

A boolean value indicating if the update is shared.

status

string

Status

The status of the update.

text

string

Text

The text of the update.

text_formatted

string

Text Formatted

The formatted text of the update.

type

string

Type

The type of update.

updated_at

integer(int32)

Updated At

The datetime the update was updated.

user_id

string

User Id

The id of the user.

via

string

Via

How the update was created.

 


 

ListPendingUpdatesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

updates

array of (UpdatesItem)

 

updates

 

UpdatesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

created_at

integer(int32)

Created At

The datetime the update was created at.

day

string

Day

The text version of the date the update is due.

due_at

integer(int32)

Due At

The datetime when the update is due.

due_time

string

Due Time

The time when the update is due.

id

string

Id

The id of the update.

profile_id

string

Profile Id

The id of the profile associated with the update.

profile_service

string

Profile Update

The service of the profile associated with the update.

shared_now

boolean

IsSharedNow

A boolean value indicating if the update is shared.

status

string

Status

The status of the update.

text

string

Text

The text of the update.

text_formatted

string

Text Formatted

The formatted text of the update.

type

string

Type

The type of update.

updated_at

integer(int32)

Updated At

The datetime the update was updated.

user_id

string

User Id

The id of the user.

via

string

Via

How the update was created.

 


 

ListProfilesResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

avatar

string

Avatar

The URL to the avatar of the profile.

counts

Counts

 

 

default

boolean

IsDefault

A boolean value indicating if the profile is the default profile.

disabled

boolean

IsDisabled

A boolean value indicating if the profile is disabled.

disconnected

boolean

IsDisconnected

A boolean value indicating if the profile is disconnected.

id

string

Id

The id of the profile

locked

boolean

IsLocked

A boolean value indicating if the profile is locked.

service

string

service

The service connected to the profile.

service_id

string

Service Id

The id of the service connected to the profile.

service_type

string

Service Type

The type of service connected to the profile.

service_username

string

service_username

The username for the service connected to the profile.

timezone

string

Timezone

The selected timezone for the profile.

timezone_city

string

Timezone City

The city name corresponding to the selected timezone.

user_id

string

User Id

The id of the user who created the profile.

dropdown_label

string

Label

A label consisting of the service connected to the profile, as well as the profile username.

 

Counts

Summary:

Description:

 

          Properties:

Name

Type

Summary

drafts

integer(int32)

Drafts

The number of draft updates.

reminders

integer(int32)

Reminders

The number of reminders.

sent

integer(int32)

sent

The number of sent updates.

pending

integer(int32)

Pending

The number of pending updates.

 


 

ListSentUpdatesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

updates

array of (UpdatesItem)

 

updates

 

UpdatesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

created_at

integer(int32)

Created At

The datetime the update was created at.

day

string

Day

The text version of the date the update is due.

due_at

integer(int32)

Due At

The datetime when the update is due.

due_time

string

Due Time

The time when the update is due.

id

string

Id

The id of the update.

profile_id

string

Profile Id

The id of the profile associated with the update.

profile_service

string

Profile Update

The service of the profile associated with the update.

shared_now

boolean

IsSharedNow

A boolean value indicating if the update is shared.

status

string

Status

The status of the update.

text

string

Text

The text of the update.

text_formatted

string

Text Formatted

The formatted text of the update.

type

string

Type

The type of update.

updated_at

integer(int32)

Updated At

The datetime the update was updated.

user_id

string

User Id

The id of the user.

via

string

Via

How the update was created.

statistics

Statistics

 

 

 

Statistics

Summary:

Description:

 

          Properties:

Name

Type

Summary

comments

integer(int32)

Comments

The number of comments on the update.

likes

integer(int32)

Likes

The number of likes on the update.

clicks

integer(int32)

Clicks

The number of clicks on the update.

 


 

ShareUpdateResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

success

boolean

IsSuccess

A boolean value indicating if the update was successfully shared.