Retrieves the authenticated user's account information
Example Response
{
"data": {
"account": {
"id": "...",
"email": "...",
"backupEmail": "...",
"avatar": "..."
}
}
}Buffer API
Connect Buffer to your agents, automation tools, or build something entirely new.
Account
Queries 1
Outputs 1
OUTPUT
Account
Account is a representation of a Buffer user.
Fields 10
id
:
ID!
Unique identifier for the account
email
:
String!
Primary email address for the account
backupEmail
:
String
Backup email address for account recovery
avatar
:
String!
URL to the account's avatar image
Date the account was created in the Core DB. For older customers, it's possible a Publish account existed in the Publish DB for this customer before this date
timezone
:
String
The account-level timezone - this is used as a default input for streaks, posting plans, and new channel channel connections.
name
:
String
The account name, different from the organization name
The accounts preferences
The connected apps for the account
Types 2
TYPE
ConnectedApp
Connected App
Fields 8
The category of the connected app, when known.
clientId
:
ID!
The id of the connectedApp.
description
:
String!
A brief description of the connected app.
name
:
String!
The name of the connected app.
scopes
:
[String!]!
The access scopes granted to this connection for Buffer's public API
resources. Empty when the connection holds none.
userId
:
ID!
The id of the user that has granted access to the app.
website
:
String!
The website URL of the connected app.
The date and time when the connected app was created.
Enums 2
ENUM
ConnectedAppCategory
The category of a connected app.
ENUM
ScheduleOption
Scalars 2
Channels
Queries 2
Fetches a single channel using the provided ID
Arguments
| Name | Type | Description |
|---|---|---|
| input Required | ChannelInput! | Query's input. |
Example Response
{
"data": {
"channel": {
"id": "...",
"allowedActions": [
"backfillChannel"
],
"avatar": "...",
"descriptor": "..."
}
}
}Fetch all channels for the organization taking into account the current's user permissions
Arguments
| Name | Type | Description |
|---|---|---|
| input Required | ChannelsInput! | Query's input. |
Example Response
{
"data": {
"channels": [
{
"id": "...",
"allowedActions": [
"backfillChannel"
],
"avatar": "...",
"descriptor": "..."
}
]
}
}Outputs 1
OUTPUT
Channel
Channel entity
Fields 27
The ID of the channel
The allowed actions for the current user
avatar
:
String!
The avatar URL of the channel
descriptor
:
String!
Formatted name of the channel service and type: e.g. 'Twitter Profile' or 'Facebook Page'
displayName
:
String
The display name of the channel - nullable (reason?)
externalLink
:
String
The channel's URL on the social network (e.g. instagram.com/username or facebook.com/page)
Returns null if the channel is not supported
hasActiveMemberDevice
:
Boolean!
Whether at least one member of the orginization who have access to this channel
also has a user device registered for push notifications
isDisconnected
:
Boolean!
Indicates if the channel is properly connected to Buffer
isLocked
:
Boolean!
Indicates if the channel is locked - Locked channels can't be used for posting.
A channel can be locked when the organization downgrades and reduces the channel quantity of their plan.
isNew
:
Boolean!
Indicates if the channel was recently created (in less than 10 seconds). This is used to determine the redirect modal after channel authorization
isQueuePaused
:
Boolean!
Indicates is the queue is paused for the channel. A paused queue means schedules posts won't be published.
Link Shortening settings for the channel
Metadata or settings depending on the service type - such as the server URL for Mastodon or Location data for Facebook/GPB
name
:
String!
The name of the channel - the handle name, username, etc.
The organization ID of the channel
The posting goal for the channel
Provides the posting slots for each day of the week
Products that support a given channel
scopes
:
[String]!
Scopes requested for a given channel - empty array if we don't have them tracked
Represents the social network
serviceId
:
String!
Represents the external ID of the channel on social network API
showTrendingTopicSuggestions
:
Boolean!
Indicates if trending topic suggestions should be shown in the composer.
When false, users can still access trends via the trending icon button.
Defaults to true for backward compatibility.
timezone
:
String!
The timezone of the channel - Default if not set is Europe/London
The type of the channel - Page, Profile, Business, Group, Account, etc.
Weekly posting limit for the channel
The creation date of the channel
The last time the channel was updated
Types 36
TYPE
BlueskyMetadata
Bluesky metadata
Fields 1
serverUrl
:
String!
The instance of bluesky of the channel
Everything for one connected channel: its engagement capabilities, its full
`content` config, and per-feature authorization. Each channel carries
its own complete config — there is no service-level default to merge against.
Fields 6
Authorization status per feature for this channel. A feature is a capability
a channel can expose — e.g. posting, commenting, mentions, insights (see the
`Feature` enum).
The connected channel this config describes.
The channel's type within the service (e.g. profile, page, business).
Content config — one entry per content type, or a single entry
grouping several types that share identical rules (post / story / reel /
comment reply).
Engagement capabilities — one entry per engagement type. Empty when
engagement isn't supported on the channel.
The channel's social service (e.g. twitter, instagram).
Settings for link shortening
Fields 2
Configuration of link shortening integration. Null if disabled.
isEnabled
:
Boolean!
If link shortening is enabled for the channel
Error returned when the channel needs a refresh
Fields 2
ChannelIds that need refreshing
message
:
String!
Error message
Config for one or more content types that share the same properties
and rules. Grouping several `configurationContentTypes` in one entry avoids
duplicating an identical config (e.g. story + reel).
Fields 3
The content type(s) this config applies to (grouped when rules are identical).
Validation rules that decide whether a draft is valid.
The properties these content types support; absence means unsupported.
A supported reaction. `reactionType` is the opaque identity echoed back on the
react mutation; `visual` carries everything needed to render it.
Fields 2
The kind of reaction a user can apply (e.g. like, love, celebrate). This is
the identifier the client sends back to the react mutation when the user picks
this reaction; treat it as an opaque value rather than parsing it.
How to render this reaction (built-in icon or network image).
Per-engagement-type configuration. One entry per kind; `engagementType`
discriminates. Adding a kind is additive — a new `EngagementType` value, not a
new type.
Fields 7
The kind of engagement this entry configures (comment / mention).
Media configuration. Always present; `supportsMedia: false` = the platform
doesn't deliver attached media to Buffer, so none can be shown.
Optional network-specific engagement metadata (e.g. Google Business).
null when none applies.
Reactions. Always present; empty `supportedReactions` = reacting via Buffer
isn't supported.
Reply configuration. Always present; `supportsReplying: false` = replying via
Buffer not supported.
AI features supported for this engagement type. Empty when none.
Sync configuration — realTime/polling mechanism plus optional forced-sync detail.
TYPE
FacebookMetadata
Facebook metadata
Fields 1
Metadata about the location of the business associated with the channel. Only available for Facebook and GPB
Pairs a feature with the channel's authorization status for it (token/scope
level). One entry per authorization-gated feature the channel exposes.
Fields 3
The feature this status describes — a capability a channel can expose, e.g.
posting, commenting, mentions, insights, reacting to engagements (see the
`Feature` enum).
reason
:
String
Why the feature is in its current `status`, when a specific cause is known
(e.g. the connected platform user lacks rights on the account that owns
webhook subscriptions). Informative text for display/support — not a stable
machine key, so clients must not parse or switch on it. Null when the
status needs no explanation (`ok`) or no specific cause was identified.
Whether the channel is currently authorized to use `feature`: `ok` (usable),
`needsRefresh` (token refresh required), `notEnoughData` (missing scopes /
webhook metadata), `needsUpgrade` (client below the minimum version —
applies only to the mobile apps), or `notEnoughRights` (the connected
platform user's role is insufficient — reconnecting cannot fix it). See the
`AuthorizationStatus` enum.
Forced-sync detail. Present only when the kind's sync mechanism supports a
forced (manual) sync.
Fields 2
Rate limit for forced syncs. `null` when forced sync is unthrottled. Reuses
the `ForcedSyncRateLimit` type defined by the comment schema.
pollInterval
:
Int!
How often, in seconds, the channel is automatically polled for new items.
Rate limit configuration for forced sync operations.
Fields 2
allowedAttempts
:
Int!
Number of allowed forced backfill attempts within the period.
period
:
Int!
Rate limit period in seconds for forced backfill operations.
Google Business-specific engagement metadata. Distinct from the channel-level
`GoogleBusinessMetadata` (which carries location data) — this is the engagement
surface's rating/note metadata.
Fields 2
hasUserRating
:
Boolean!
Whether engagements on this channel carry a user star rating.
permanentNote
:
String!
A permanent note surfaced to the user about this channel's engagements.
Empty when there is nothing to tell the user.
Google Business metadata
Fields 1
Metadata about the location of the business associated with the channel. Only available for Facebook and GPB
Render from the built-in client icon set.
Fields 1
The built-in icon to render.
TYPE
IdeaMedia
Media attached to an idea
Fields 7
id
:
ID!
Unique identifier for the media in Buffer's upload system
alt
:
String
Alternative text description for accessibility
size
:
Int
File size in bytes
Source platform information for the media
thumbnailUrl
:
String
URL to a smaller version of the media for preview purposes
Type of media (e.g., image, video, gif)
url
:
String!
Direct URL to access the media file
TYPE
IdeaMediaSource
Media source for the idea, e.g. Unsplash, Gifphy, etc.
Fields 4
id
:
String
Unique identifier from the source platform
author
:
String
Name of the content creator/author
authorUrl
:
String
URL to the author's profile on the source platform
name
:
String!
Name of the media source platform (e.g., 'Unsplash', 'Giphy')
Render a network-supplied image (e.g. LinkedIn-branded reactions).
Fields 1
url
:
String!
URL of the network-supplied reaction image.
TYPE
LinkedInMetadata
LinkedIn metadata
Fields 1
shouldShowLinkedinAnalyticsRefreshBanner
:
Boolean!
Property parsed from scopes indicating whether the client should show the LinkedIn analytics refresh banner
TYPE
LinkShorteningConfig
Link Shortening Configuration
Fields 2
domain
:
String!
Domain of the link shortener - eg buff.ly, dub.co,
or the user's custom domain.
name
:
String!
Human readable string to describe the link shortening
service.
TYPE
LocationData
Location data about the channel
Fields 3
googleAccountId
:
String
Google Account Id of the business
location
:
String
Location of the business associated with the channel
mapsLink
:
String
Link to the map
TYPE
MastodonMetadata
Mastodon metadata
Fields 2
maxCharacters
:
Int!
Maximum character limit allowed for this channel's server instance
serverUrl
:
String!
The instance of mastodon of the channel
Media configuration for an engagement type — whether media attached to an
engagement reaches Buffer and can therefore be shown to the user.
Fields 3
additionalInformation
:
String
User-facing explanation of what the client can do about the missing media,
worded for the platform (e.g. "Instagram doesn't send media with mentions to
Buffer. Open the mention natively to see the full content."). Display text
only — not a stable machine key, so clients must not parse or switch on it.
Null when `supportsMedia` is true.
disclaimer
:
String
User-facing explanation of why media isn't shown. Display text only — not a
stable machine key, so clients must not parse or switch on it. Null when
`supportsMedia` is true.
supportsMedia
:
Boolean!
Whether media attached to this engagement type is delivered by the platform
and can be shown.
TYPE
PinterestBoard
A Pinterest board
Fields 6
id
:
String!
The ID of the board
avatar
:
String
The board avatar
description
:
String
The board description
name
:
String!
The board name
serviceId
:
String!
The ID of the service
url
:
String!
The board URL
The channel targeted by a single post in the promoteContentItemDraftToPosts
input list was not found or is not accessible.
Fields 2
Channel targeted by the failing post.
message
:
String!
Error message.
Reactions configuration. `restingIcon` is always populated; `supportedReactions`
empty = reacting via Buffer isn't supported, one = single-button liking, multiple
= a reaction set.
Fields 3
requiresAuthorization
:
Boolean!
Whether reacting needs an OAuth scope beyond the ones a base connection
grants. When true, check the channel's `engagementReaction` entry in
`authorizationStatus` before offering the reaction — the channel may need a
reconnect to grant it. On the service-level catalog this is channel-agnostic
and may overstate the requirement, since it can vary with a channel's login
flow; the per-channel configuration resolves it exactly.
The resting-state icon — the pre-reaction icon.
The reactions the user can apply. Empty when reacting via Buffer isn't supported.
Reply configuration for an engagement type. A rich object (not a bare boolean)
so reply metadata can be added later.
Fields 2
prefixReplyWithMention
:
Boolean!
Whether replies should be prefixed with the author's @mention.
supportsReplying
:
Boolean!
Whether replying to this engagement type via Buffer is supported.
TYPE
ScheduleV2
Posting schedule for a specific day of the week
Fields 3
The day of the week: mon, tue, wed, thu, fri, sat, sun
paused
:
Boolean!
Indicates if this day is paused in the posting schedule.
times
:
[String!]!
The times the channel is scheduled to post on the day: HH:MM
Sync configuration for an engagement type — the realTime/polling
`syncDataMechanism` plus optional forced-sync detail.
Fields 2
Forced-sync detail. A forced sync is a user-triggered (manual) refresh that
fetches new items on demand instead of waiting for the next scheduled poll or
push. `null` when this kind's sync mechanism has no forced-sync support.
How this engagement type syncs on this channel: `realTime` (push) or
`polling` (pull).
TYPE
TiktokMetadata
Tiktok metadata
Fields 1
defaultToReminders
:
Boolean!
Indicates if we should default to reminder for Tiktok
TYPE
TwitterMetadata
Twitter metadata
Fields 1
subscriptionType
:
String
Indicates the type of subscription the user has on Twitter
TYPE
YoutubeMetadata
Youtube metadata
Fields 1
defaultToReminders
:
Boolean!
Indicates if we should default to reminder for Youtube
A validation rule constraining how a content property may be used. Each
concrete rule carries only the fields it needs; new constraint kinds are
additive (a new type implementing this interface). Clients switch on
`__typename`.
Fields 1
The content property this rule constrains.
TYPE
ChannelMetadata
Metadata or settings about the channel depending on the service type
Network-specific engagement metadata. Single-member union for now; grows
additively as more networks contribute their own shape.
How to render a reaction. The client switches on `__typename` purely as a
render strategy (built-in icon vs network image) — never on the network or the
reaction identity.
Inputs 5
INPUT
ChannelsFiltersInput
Filter to pass when fetching channels.
Fields 2
isLocked
:
Boolean
If not defined, it returns all channels
Else,
if true, it only returns locked channels
if false, it only returns not locked channels
If not passed, it return all channels
Else, it filters the channels based on what the product supports.
INPUT
ChannelsInput
Input to pass when fetching channels.
Fields 2
A list of option filters - passing null means we don't want to filter
The Organization id to fetch channels for
INPUT
IdeaMediaInput
Fields 6
url
:
String!
The URL of the media
alt
:
String
Alternative text for the media
thumbnailUrl
:
String
Thumbnail URL for the media
The type of media (image, gif, video, link, document, unsupported). Note: 'video' is not supported via public API
size
:
Int
The size of the media in bytes
Source information for the media
INPUT
IdeaMediaSourceInput
Input type for the source information of media attached to an idea
Fields 5
name
:
String!
id
:
String
trigger
:
String
author
:
String
for unsplash only
authorUrl
:
String
Enums 16
AI features supported for an engagement type. Grows additively.
Represents the authorization evaluation result for a feature.
ENUM
ChannelAction
List of possible actions that can be performed on a Channel
ENUM
ChannelType
Channel is a representation of a social media account or page that can be connected to Buffer.
The kinds of content a channel can compose. Grows additively.
A property a content type can carry. Support is expressed by inclusion in
`supportedProperties` — there are no exclusion lists. Grows additively.
ENUM
DayOfWeek
Day of the week.
Discriminator used in inputs/filters to scope a query to specific types.
A capability a channel can expose, spanning every domain. The shared key for
per-channel `authorizationStatus`. Grows additively.
Media formats a `FormatRule` can allow-list. Grows additively.
ENUM
MediaType
The type of media attached to a post
ENUM
Product
Buffer products, buffer is used as all products
Standard reaction icon set used by `IconVisual`. Grows additively.
Types of reactions that can be applied to a comment.
ENUM
Service
The list of services that can be authorized.
How items of an engagement type are pulled / pushed. `realTime` covers push
(webhook / firehose); `polling` is pull.
Scalars 1
SCALAR
ChannelId
The `ChannelId` scalar represents the MongoDB ObjectId of a Buffer Channel
Posts
Queries 9
Aggregate normalized post metrics across a filtered post set. Useful for yearly summaries, channel-level rollups, and BI exports without paginating through thousands of posts.
For per-post metrics, use posts(input) or post(input) with a
metrics { … } selection — this query is purely for aggregation.
The result always contains a baseline trio of entries: postCount
(number of matched posts in the window), reactions, and comments.
Posts on networks that don't track reactions or comments contribute 0
to those totals.
Beyond the baseline, additional metric types are returned only when every channel in the filter set supports them. A single-network filter surfaces that network's richer metrics (e.g. impressions, reach, engagementRate on LinkedIn); a mixed-network filter trims the extras to those common to every network in the set.
Arguments
| Name | Type | Description |
|---|---|---|
| input Required | AggregatedPostMetricsInput! | Query's input: organization, date range, optional channel and tag filters. Date range is capped to 365 days. |
Example Response
{
"data": {
"aggregatedPostMetrics": {
"metrics": [
{
"description": "...",
"name": "...",
"type": "averageTimeWatched",
"unit": "count"
}
],
"metricsUpdatedAt": "..."
}
}
}Returns daily posting limit status for the given channels on the specified date.
Arguments
| Name | Type | Description |
|---|---|---|
| input Required | DailyPostingLimitsInput! | Query's input. |
Example Response
{
"data": {
"dailyPostingLimits": [
{
"channelId": "...",
"isAtLimit": true,
"limit": 0,
"scheduled": 0
}
]
}
}Refresh metadata and preview availability for one Instagram audio asset. Requires Facebook Login. Instagram Login channels return ChannelRefreshRequired.
Arguments
| Name | Type | Description |
|---|---|---|
| input Required | InstagramAudioInput! | Channel and audio asset used to refresh metadata. |
Example Response
{
"data": {
"instagramAudio": {}
}
}Fetches a post by PostID for the given organization: first and last can be set for forward pagination using Relay convention
Arguments
| Name | Type | Description |
|---|---|---|
| input Required | PostInput! | Query's input. |
Example Response
{
"data": {
"post": {
"id": "...",
"allowedActions": [
"addPostNote"
],
"assets": [
{
"id": "...",
"mimeType": "...",
"source": "...",
"thumbnail": "..."
}
],
"author": {
"id": "...",
"avatar": "...",
"email": "...",
"isDeleted": true
}
}
}
}Fetches posts for the given organization: first and last can be set for forward pagination using Relay convention
Arguments
| Name | Type | Description |
|---|---|---|
| after Optional | String | The cursor of the post to start fetching from |
| first Optional | Int | The number of posts to return |
| input Required | PostsInput! | Query's input. |
Example Response
{
"data": {
"posts": {
"edges": [
{
"cursor": "...",
"node": {}
}
],
"pageInfo": {
"endCursor": "...",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "..."
}
}
}
}Fetch a single post template by ID. Returns null if not found.
Arguments
| Name | Type | Description |
|---|---|---|
| input Required | PostTemplateInput! | Input for fetching a single post template. |
Example Response
{
"data": {
"postTemplate": {
"id": "...",
"body": "...",
"description": "...",
"emoji": "..."
}
}
}
QUERY
postTemplates
(after: String, first: Int, input: PostTemplatesInput!)
:
PostTemplatesConnection!
🧪 Preview
Fetch the templates visible to the current actor for the template
library: public templates, plus internal templates from the supplied
organizationId, plus private templates owned by the actor's
account. The visibility scope is always pinned to the actor and the
supplied organization — the input filter can only narrow within that
scope, never widen it.
Arguments
| Name | Type | Description |
|---|---|---|
| after Optional | String | The cursor after which to return results. |
| first Optional | Int | The number of templates to return. |
| input Required | PostTemplatesInput! | Input containing the organization scope and optional filters. |
Example Response
{
"data": {
"postTemplates": {
"edges": [
{
"cursor": "...",
"node": {}
}
],
"pageInfo": {
"endCursor": "...",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "..."
},
"totalCount": 0
}
}
}
QUERY
searchInstagramAudio
(input: SearchInstagramAudioInput!)
:
SearchInstagramAudioPayload!
⚠️ Experimental
Search Instagram audio for one channel. Requires Facebook Login. Instagram Login channels return ChannelRefreshRequired.
Arguments
| Name | Type | Description |
|---|---|---|
| input Required | SearchInstagramAudioInput! | Channel, catalog type, and search text. |
Example Response
{
"data": {
"searchInstagramAudio": {}
}
}
QUERY
trendingInstagramAudio
(input: TrendingInstagramAudioInput!)
:
SearchInstagramAudioPayload!
⚠️ Experimental
Return Meta trending Instagram audio for one channel. Requires Facebook Login. Instagram Login channels return ChannelRefreshRequired.
Arguments
| Name | Type | Description |
|---|---|---|
| input Required | TrendingInstagramAudioInput! | Channel and catalog type for Meta trending audio. |
Example Response
{
"data": {
"trendingInstagramAudio": {}
}
}Mutations 10
Create post for channel
Arguments
| Name | Type | Description |
|---|---|---|
| input Required | CreatePostInput! | The mutation's input |
Example Response
{
"data": {
"createPost": {}
}
}
MUTATION
createPostTemplate
(input: CreatePostTemplateInput!)
:
CreatePostTemplatePayload!
🧪 Preview
Create a post template visible only to the caller (private) or to
the caller's organization (internal).
Arguments
| Name | Type | Description |
|---|---|---|
| input Required | CreatePostTemplateInput! | Input for creating a post template. |
Example Response
{
"data": {
"createPostTemplate": {}
}
}Delete a post by id.
Arguments
| Name | Type | Description |
|---|---|---|
| input Required | DeletePostInput! | Input for the deletePost mutation. |
Example Response
{
"data": {
"deletePost": {}
}
}
MUTATION
deletePostTemplate
(input: DeletePostTemplateInput!)
:
DeletePostTemplatePayload!
🧪 Preview
Delete a post template owned by the caller (or an internal template in the caller's organization, if the caller is an org admin/owner).
Arguments
| Name | Type | Description |
|---|---|---|
| input Required | DeletePostTemplateInput! | Input for deleting a post template. |
Example Response
{
"data": {
"deletePostTemplate": {}
}
}Edit post for channel
Arguments
| Name | Type | Description |
|---|---|---|
| input Required | EditPostInput! | The mutation's input |
Example Response
{
"data": {
"editPost": {}
}
}Move a queued post to the top or bottom of its channel's queue. Unlike editPost, this is a scheduling-only operation that never re-validates the post's content.
Arguments
| Name | Type | Description |
|---|---|---|
| input Required | MovePostInQueueInput! | The mutation's input |
Example Response
{
"data": {
"movePostInQueue": {}
}
}
MUTATION
promoteContentItemDraftToPosts
(input: PromoteContentItemDraftToPostsInput!)
:
PromoteContentItemDraftToPostsPayload!
⚠️ Experimental
Promote a channel-less draft into channel-specific posts. One-way: once promoted, the content item can no longer be edited as a draft. If any post fails validation, none are created. A failure can also be reported when a post could not be fully processed after the promotion already took effect; re-fetch the content item to check its state before retrying.
This API is an early preview and can change without a deprecation period.
Arguments
| Name | Type | Description |
|---|---|---|
| input Required | PromoteContentItemDraftToPostsInput! | Input for promoteContentItemDraftToPosts. |
Example Response
{
"data": {
"promoteContentItemDraftToPosts": {}
}
}
MUTATION
updateContentItem
(input: UpdateContentItemInput!)
:
UpdateContentItemPayload!
⚠️ Experimental
Update a content item's title or target date. Fields that are omitted keep their current value.
This API is an early preview and can change without a deprecation period.
Arguments
| Name | Type | Description |
|---|---|---|
| input Required | UpdateContentItemInput! | Input for updateContentItem. |
Example Response
{
"data": {
"updateContentItem": {}
}
}
MUTATION
updateContentItemDraft
(input: UpdateContentItemDraftInput!)
:
UpdateContentItemDraftPayload!
⚠️ Experimental
Replace a channel-less draft's content in full, and optionally set the content item's target date in the same write. The draft needs text or at least one asset. Only valid while the content item is still a draft.
This API is an early preview and can change without a deprecation period.
Arguments
| Name | Type | Description |
|---|---|---|
| input Required | UpdateContentItemDraftInput! | Input for updateContentItemDraft. |
Example Response
{
"data": {
"updateContentItemDraft": {}
}
}
MUTATION
updatePostTemplate
(input: UpdatePostTemplateInput!)
:
UpdatePostTemplatePayload!
🧪 Preview
Update a post template owned by the caller (or an internal template in the caller's organization, if the caller is an org admin/owner).
Arguments
| Name | Type | Description |
|---|---|---|
| input Required | UpdatePostTemplateInput! | Input for updating a post template. |
Example Response
{
"data": {
"updatePostTemplate": {}
}
}Outputs 18
OUTPUT
AggregatedPostMetrics
Aggregated post metrics across a filtered post set. Each entry in
`metrics` mirrors the shape of a `Post.metrics` entry; the total number
of matched posts is carried as a regular `PostMetric` entry with
`type: postCount`.
Fields 2
Normalized metric aggregates across the matched posts. Always includes
a baseline trio (`postCount`, `reactions`, `comments`) — posts on
networks that don't track reactions or comments contribute 0 to those
totals. Beyond the baseline, additional metric types are included only
when every channel in the filter set supports them.
The latest `metricsUpdatedAt` across the matched posts, indicating the
freshness of the aggregate. Metrics are refreshed daily, so values can
be up to ~24h behind the source network. Null when no posts matched
the filter.
A piece of content in Buffer. It starts as a channel-less draft and can later
become a set of channel-specific posts, or it can be created with its posts
directly.
This API is an early preview and can change without a deprecation period.
Fields 10
Unique identifier for this content item.
Account that owns this content item.
Actions the calling actor can take on this content item. A client reads this
set instead of deriving the authorization rules itself.
The person who created this content item. Null when that person's account
no longer exists.
The current content of this item: either a channel-less draft or the
channel-specific posts created from it.
Organization that owns this content item.
Tags applied to this content item, in the order they were set. A tag
applies to the item as a whole, so it survives the move from a
channel-less draft to channel-specific posts.
Optional date indicating when this piece of content should go out.
This is a planning aid only and does not schedule any posts.
title
:
String
Optional title describing what this piece of content is about.
When this content item was created.
OUTPUT
DailyPostingLimitStatus
Status of daily posting limits for a channel on a given day.
Fields 5
The channel ID this status refers to.
isAtLimit
:
Boolean!
Whether the channel has reached its daily posting limit.
limit
:
Int
The network daily posting limit. Null means unlimited.
scheduled
:
Int!
Number of posts scheduled for this day.
sent
:
Int!
Number of posts already sent on this day.
OUTPUT
Post
Post entity
Fields 27
ObjectId of the post
Indicates what actions the current account can perform on the post
assets
Represents the user who created the post
channel
channel ID (faster than resolving the channnel.id)
channel service (faster than resolving the channnel.service)
Date when the post is scheduled to be published
error
externalLink
:
String
The external URL of the post at the destination service
Is set when the Post is generated from an Idea
isCustomScheduled
:
Boolean!
Indicates whether time to publish was manually selected by the user
Metadata of the post which differs based on the social network/service
@see post.metadata.graphql
Metrics for the sent post. If post is not yet sent, this field will be null
Timestamp of when `metrics` were last refreshed from the network. Null
until the daily ingestion job has processed the post. Buffer pulls
fresh metrics once per day, so this can lag the network value by ~24h.
notes
notificationStatus: notified or markedAsPublished
How the post publishes: `notification` for a reminder that asks someone to
publish it by hand, `automatic` for one the publishing workers send.
Date when the post is published
sharedNow
:
Boolean!
Indicates whether the post was shared via publish now action
Indicates the share mode of the post (e.g., addToQueue, shareNext, shareNow, customScheduled)
status
tags - sorted by name in ascending order
text
:
String!
Text content of the Post
Indicates if the post is created from Buffer or the API
Date when the post was created
Date when the post was updated
OUTPUT
PostsResults
Results for the posts query.
Fields 2
The list of posts that match the query.
Information to aid in pagination.
OUTPUT
PostTemplate
A post template used for content inspiration.
Fields 9
The unique identifier for the template.
body
:
String!
The main content body of the template, may contain {{placeholders}}.
description
:
String!
A short user-facing description of the template.
emoji
:
String!
The emoji associated with the template.
The organization that owns this template.
title
:
String!
The title of the template.
The visibility level of the template. `public` is returned for
Buffer-managed templates.
The date and time the template was created.
The date and time the template was last updated.
A paginated connection of post templates.
Fields 3
The list of post template edges.
Pagination information for the connection.
totalCount
:
Int!
The total number of templates matching the filters.
Result of an end user creating a post template.
OUTPUT
DeletePostPayload
All possible response types for the deletePost mutation.
Result of an end user deleting a post template.
Payload returned when refreshing Instagram audio metadata
All possible response types that can be returned by movePostInQueue mutation.
OUTPUT
PostActionPayload
Create post's request response payload.
All possible responses for promoteContentItemDraftToPosts.
Payload returned when searching Instagram audio
All possible responses for updateContentItemDraft.
All possible responses for updateContentItem.
Result of an end user updating a post template.
Types 70
TYPE
Annotation
Annotation representing all the entities in the text
Fields 5
content
:
String!
The content of the annotation. Annotations can sometimes be different from the actual text content.
E.g., Mastodon mentions have 'text: @buffer', but includes the server name in the content, 'content: @[email protected]'
indices
:
[Int!]!
The indices of the annotation in the text
text
:
String!
The text representation of the annotation, eg '@buffer'
The type of the annotation
url
:
String!
The URL the annotation points to
TYPE
Author
Represent the author of a post or note.
Fields 6
The unique identifier of the author.
avatar
:
String!
The avatar URL of the author.
email
:
String!
The email address of the author.
isDeleted
:
Boolean!
Indicates whether the author is a deleted.
name
:
String
The name of the author. Null if the user has not yet set a name.
urn
:
String
The Buffer account URN for this author, in the form
`urn:buffer:account:`. Null when the author is deleted or the
account ID is missing or invalid. A URN identifies an account. It does not
prove that the account exists, that the caller has access, or that the
account can be mentioned.
TYPE
BlueskyPostMetadata
Bluesky post metadata
Fields 5
Annotations representing entities in the text
Link attachment
The list of threaded posts (not paginated)
threadCount
:
Int!
The number of threaded posts
The channel-specific type of the post, eg, post, story, reel for Instagram
The content item is not currently a draft: it may already have been
published as channel-specific posts, including concurrently with this
request.
Fields 1
message
:
String!
Error message.
Successful result of an end user creating a post template.
Fields 1
The newly created post template.
TYPE
DeletePostSuccess
deletePost success response returns the post id that was deleted.
Fields 1
Post id that was delete.
A content draft that is not attached to any channel yet. Because no channel
is selected, no network-specific rules apply, including media type
restrictions.
Fields 4
Unique identifier for this draft.
aiAssisted
:
Boolean!
True when the draft content was written with the help of AI.
Images, videos, or documents attached to the draft, in display order.
text
:
String!
The written content of the draft. Empty when the draft holds only assets.
TYPE
EmptySuccess
Empty mutation success response used when client doesn't need any data back
or simply needs to respond to a success or error.
Fields 1
_empty
:
String!
The value is always an empty string ''
Note: GraphQL doesn't allow types with no fields, so we have to add this field
TYPE
FacebookPostMetadata
Facebook post metadata
Fields 5
Annotations representing entities in the text
firstComment
:
String
Facebook post's first comment
Link attachment
title
:
String
Title of Facebook reel
The channel-specific type of the post, eg, post, story, reel for Instagram
Metadata for a GBP post that is an event
Fields 8
Action button
End date of the event
endTime
:
String
End time of the event
isFullDayEvent
:
Boolean!
Indicate whether the event has a start or end time.
link
:
String
Link to the action
Start date of the event
startTime
:
String
Start time of the event
title
:
String!
Title of the event
Metadata for a GBP post that is an offer
Google Business Profile post metadata
@deprecated: pending proposal for specific GBP post types: update, offer and event metadata types
Fields 4
Annotations representing entities in the text
Details of the metadata
title
:
String
Title if available in the given GBP post type: event and offer
The channel-specific type of the post, eg, post, story, reel for Instagram
Metadata for a GBP post of type Whats new
Fields 2
Action button
link
:
String
Link to the action
An Instagram music track or original sound that can be attached to a Reel.
Fields 8
id
:
String!
Meta audio asset ID
Temporary artwork URL from Meta. May be null.
creatorUsername
:
String
Creator username for original sounds
displayArtist
:
String
Artist name for licensed music
duration
:
Int!
Duration of the audio in milliseconds
Temporary preview URL from Meta. May be null.
title
:
String!
Display title for the audio
Whether this asset is licensed music or an original sound
Refreshed metadata for one Instagram audio asset.
Fields 1
Refreshed audio metadata.
TYPE
InstagramGeolocation
Instagram Geolocation
Fields 2
id
:
String
The id of this location
text
:
String
The name of this location
TYPE
InstagramMetadata
Instagram metadata
Fields 1
defaultToReminders
:
Boolean!
Indicates if we should default to reminder for Instagram
Instagram post metadata
Fields 8
Annotations representing entities in the text
firstComment
:
String
Instagram post's first comment
Geolocation of the post
isAiGenerated
:
Boolean!
Whether the post discloses AI-generated content
link
:
String
Shop Grid link for the post
shouldShareToFeed
:
Boolean!
Indicates whether post should be shared to feed
Sticker fields for reminder-based publishing
The channel-specific type of the post, eg, post, story, reel for Instagram
Instagram fields for reminder-based publishing. Upon the reminder for publishing, the user
is prompted to copy and paste these fields into the Instagram app to complete the post.
Fields 5
music
:
String
Placeholder text for the post's music
other
:
String
Additional field for any other post content
products
:
String
Placeholder text for the post's linked products
text
:
String
Text for the Story or Reel
topics
:
String
Placeholder text for the post's topics (Reels only)
TYPE
InvalidInputError
Error returned when the input is invalid
Fields 1
message
:
String!
Error message
TYPE
LinkAttachment
Link attachment
Fields 6
expandedUrl
:
String
Full URL that the link asset has been built from
text
:
String!
Description for the scraped link
thumbnail
:
String
Selected thumbnail for this link preview
thumbnails
:
[String!]!
Thumbnails of media available in the link
title
:
String!
Title for the link attachment
url
:
String!
URL that the link asset has been built from
TYPE
LinkedInPostMetadata
LinkedIn post metadata
Fields 4
Annotations representing entities in the text
firstComment
:
String
LinkedIn post's first comment
Link attachment
The channel-specific type of the post, eg, post, story, reel for Instagram
TYPE
MastodonPostMetadata
Mastodon post metadata
Fields 5
Annotations representing entities in the text
spoilerText
:
String
Spoiler text hiding the root text of this post
The list of threaded posts (not paginated)
threadCount
:
Int!
The number of threaded posts
The channel-specific type of the post, eg, post, story, reel for Instagram
TYPE
Note
Note entity
Fields 7
The unique identifier of the note.
The allowed actions a user can perform on the note.
The author of the note - null if the user is deleted or left the organization.
text
:
String!
The content of the note.
The type of the note.
The date and time when the note was created.
The date and time when the note was last edited.
TYPE
NotFoundError
Error returned when the resource is not found
Fields 1
message
:
String!
Error message
Pinterest post metadata
Fields 5
Annotations representing entities in the text
The board the Pin is saved to
title
:
String
The title of the Pin
The channel-specific type of the post, eg, post, story, reel for Instagram
url
:
String
The Pin destination link
TYPE
PostActionSuccess
Success response returns the full up-to-date post from after the action was performed.
Fields 1
Post on which the action was successfully performed.
The fixed set of channel-specific posts created from a content item. Each
post targets a single channel and follows that channel's network rules.
Fields 1
The posts created for this content item, one per channel. Individual posts
are edited through their own mutations.
TYPE
PostingGoal
Represents a posting goal for a channel, including target, progress, and status information.
Fields 6
goal
:
Int!
The target number of posts for this goal.
The end date of the period for this posting goal.
The start date of the period for this posting goal.
scheduledCount
:
Int!
The number of posts that are scheduled to be sent for this goal.
sentCount
:
Int!
The number of posts that have been sent (published or ingested) for this goal.
The current status of the posting goal.
Invalid input for a single post in the promoteContentItemDraftToPosts input
list.
Fields 2
Channel targeted by the failing post.
message
:
String!
Error message.
Limit reached for a single post in the promoteContentItemDraftToPosts input
list.
Fields 2
Channel targeted by the failing post.
message
:
String!
Error message.
TYPE
PostMetric
A single metric for a post (or an entry in an aggregated metrics response).
Fields 5
description
:
String!
A human-readable description of what the metric represents.
name
:
String!
The human-readable name of the metric (e.g. "Reactions", "Eng. Rate").
The type of metric. Cross-network metrics use unified naming (`reactions`,
`comments`, etc.); network-specific metrics retain their network's
vocabulary (`saves`, `quotes`, etc.). See `PostMetricType` for the full
catalog including deprecated values.
The unit (count vs percentage) of `value`.
value
:
Float!
The metric value. Defaults to 0 when the network did not report the metric.
A post in this content item cannot be deleted, so the item cannot be
deleted either. Either the post is publishing or has already published,
and posts in those states can no longer be deleted, or this account is
not allowed to delete posts on that channel.
Fields 2
Channel targeted by the post that cannot be deleted.
message
:
String!
Error message.
TYPE
PostPublishingError
Post publishing error
Fields 3
message
:
String!
Error message to display
rawError
:
String
The original error from the publishing service (internal use only)
supportUrl
:
String
Link to a help center article to help resolve the error
TYPE
PostsEdge
Represent a node in the pagination result using the Connect Relay convention.
Fields 2
cursor
:
String!
Opaque cursor to be used in pagination to fetch from current node.
Represents the current post in the list.
An edge in a post template connection.
Fields 2
cursor
:
String!
A cursor for pagination.
The post template node at the end of the edge.
promoteContentItemDraftToPosts failure. Every recoverable error is reported
together so the caller can surface them all at once — for example, every
post that failed validation across every targeted channel. A failure does
not always mean nothing changed: post-processing errors are reported after
the promotion has taken effect.
Fields 2
The recoverable errors behind this failure.
message
:
String!
Summary error message.
Successful promoteContentItemDraftToPosts response.
Fields 1
The promoted content item.
TYPE
PublishingTag
Tag snapshot associated with content
Fields 4
id
:
ID!
color
:
String!
Hex color for tag e.g #F523F1
Stable Buffer palette identifier derived from `color`.
Clients should map this value to platform- and theme-specific presentation,
falling back to `color` when this field is null or unsupported.
Returns null for custom or unrecognized colors.
name
:
String!
TYPE
RestProxyError
Error proxied from the REST API response
Fields 3
code
:
Int
Error code from the REST API response - https://buffer.com/developers/api/errors
link
:
String
Link to our Help center from the REST API response
message
:
String!
An error message from the REST API response that we proxied here
TYPE
RetweetMetadata
Information about the initial Tweet that was retweeted
Fields 6
id
:
String!
Retweet ID
text
:
String!
Text of the original tweet
thumbnails
:
[String!]!
Thumbnails to media available in the link
url
:
String!
Link to original tweet
User who created the original tweet
Date when the original tweet was created
TYPE
RetweetUserMetadata
Information about the initial author of the Tweet that was retweeted
Fields 3
avatar
:
String!
Avatar of the user who created the original Tweet
name
:
String!
Name of the user who created the original Tweet
username
:
String!
Username of the user who created the original Tweet
Success response for searching Instagram audio
Fields 1
Matching or trending audio assets
TYPE
SubstackPostMetadata
Substack post metadata
Fields 3
Annotations representing entities in the text
Link attachment
The channel-specific type of the post, eg, post, story, reel for Instagram
TYPE
Tag
Tag entity
Fields 5
ObjectId of the tag
color
:
String!
Hex color for tag e.g '#F523F1'
Stable Buffer palette identifier derived from `color`.
Clients should map this value to platform- and theme-specific presentation,
falling back to `color` when this field is null or unsupported.
Returns null for custom or unrecognized colors.
isLocked
:
Boolean!
Locked tag cannot be assigned to new items in the UI.
A Tag is locked after a customer downgrades and has more tags than the free plan limit allows
name
:
String!
Name of the tag e.g 'Summer sales'
TYPE
ThreadedPost
A post authored by the user which is posted to a thread.
This is commonly used for long-format twitter and meta threads posts to
allow authored content to span multiple threads.
Threads are represented as a list of replies, each replying to the previous one.
Fields 4
Media assets of the threaded post
Use metadata.{service}.linkAttachment on the thread item instead. This field will be removed on December 15, 2026.
Service-specific fields for this threaded post
text
:
String!
The text body content of the threaded post
Bluesky fields on a single item of a thread
Fields 1
Link attachment
TYPE
ThreadItemMetadata
Service-specific fields on a single item of a thread. The populated key matches
the post's service.
Fields 2
Bluesky fields for this thread item
Threads fields for this thread item
Threads fields on a single item of a thread
Fields 1
Link attachment
TYPE
ThreadsPostMetadata
Threads post metadata
Fields 8
Annotations representing entities in the text
Link attachment
locationId
:
String
LocationId associated with the post
locationName
:
String
Location name associated with the post
The list of threaded posts (not paginated)
threadCount
:
Int!
The number of threaded posts
topic
:
String
Topic associated with the post
The channel-specific type of the post, eg, post, story, reel for Instagram
TYPE
TiktokPostMetadata
Tiktok post metadata
Fields 4
Annotations representing entities in the text
isAiGenerated
:
Boolean!
Whether the post discloses AI-generated content (TikTok video only)
title
:
String
The title of the TikTok post (for photo posts)
The channel-specific type of the post, eg, post, story, reel for Instagram
TYPE
TwitterPostMetadata
Twitter post metadata
Fields 6
Annotations representing entities in the text
isAiGenerated
:
Boolean!
Whether the post discloses AI-generated content
The details of the tweet being retweeted
The list of threaded posts (not paginated)
threadCount
:
Int!
The number of threaded posts
The channel-specific type of the post, eg, post, story, reel for Instagram
updateContentItemDraft failure.
Fields 2
The recoverable errors behind this failure.
message
:
String!
Summary error message.
Successful updateContentItemDraft response.
Fields 1
The updated content item.
updateContentItem failure. When any part of the input is invalid, nothing is
changed.
Fields 2
The recoverable errors behind this failure.
message
:
String!
Summary error message.
Successful updateContentItem response.
Fields 1
The content item after the update.
Successful result of an end user updating a post template.
Fields 1
The updated post template.
TYPE
UserTag
User tag in the image
Fields 3
handle
:
String!
The handle (username) of the tagged account, without the leading @.
x
:
Float!
Horizontal position of the tag as a normalized decimal float between 0.0 and 1.0 - the fraction of the image width from the left edge (0.5 is the horizontal center).
y
:
Float!
Vertical position of the tag as a normalized decimal float between 0.0 and 1.0 - the fraction of the image height from the top edge (0.5 is the vertical center).
TYPE
VoidMutationError
Error implementation that allows clients to resolve the MutationError on mutations that do not currently have typed errors.
This allows clients to automatically handle errors that may be added to a mutation in future.
Do not directly throw this error, use a custom typed error instead
Fields 1
message
:
String!
Error message
TYPE
WeeklyPostingLimit
Weekly posting limit for a channel
Fields 3
limit
:
Int!
The weekly posting limit for the channel
scheduled
:
Int!
The number of posts the channel has scheduled for this week
sent
:
Int!
The number of posts the channel has sent this week
TYPE
YoutubeCategory
Fields 2
categoryId
:
String!
title
:
String!
TYPE
YoutubePostMetadata
Youtube post metadata
Fields 10
Annotations representing entities in the text
Post category
embeddable
:
Boolean!
Indicates whether the video allows embedding
isAiGenerated
:
Boolean!
Whether the post discloses AI-generated content
Video license
madeForKids
:
Boolean!
Indicates whether the video is suitable for kids
notifySubscribers
:
Boolean!
Indicates whether to notify subscribers on publish video
Privacy setting for post
title
:
String
Title of the Youtube post
The channel-specific type of the post, eg, post, story, reel for Youtube
TYPE
Asset
Asset interface with common fields
Fields 5
id
:
ID
The ID of the asset in the database
mimeType
:
String!
The MIME type of the asset
source
:
String!
URL to the file source
thumbnail
:
String!
URL to the static thumbnail of the asset
The type of the asset
TYPE
CommonPostMetadata
Common properties for all post metadata types
Fields 2
Annotations representing entities in the text
The channel-specific type of the post, eg, post, story, reel for Instagram
TYPE
ThreadedPostMetadata
Common properties for all posts that support threaded replies.
See ThreadedPost for more details.
Fields 2
The list of threaded posts (not paginated)
threadCount
:
Int!
The number of threaded posts
A content item contains either a channel-less draft or channel-specific
posts, but never both.
GoogleBusiness Metadata details
TYPE
PostMetadata
Post metadata union type. Contains all possible types of post metadata.
A recoverable error that prevented a content item draft from being
promoted. Post errors identify the specific channel they apply to; the
others apply to the request as a whole.
A recoverable error that prevented a content item draft from being updated.
Inputs 62
Input for the `aggregatedPostMetrics` query.
Fields 5
Optional list of channel IDs to filter by. When omitted (null), the
aggregate spans every channel in the organization the actor has
insights access to. When set to an empty array, no channels match and
the result is empty.
End of the aggregation window. Consumers typically pass UTC midnight of
the last calendar day in the window (the backend treats the range as
inclusive of that day), for example `2026-01-31T00:00:00Z`. Date range
is capped to 365 days.
The organization ID
Start of the aggregation window. Consumers typically pass UTC midnight
of the first calendar day in the window, for example
`2026-01-01T00:00:00Z`.
Filter to posts with specific tags.
When omitted, all posts are included regardless of tags.
INPUT
AnnotationInputFacebook
Annotation representing all the entities in the text
Fields 4
content
:
String!
The content of the annotation, e.g. '107509875938399'
indices
:
[Int!]!
The indices of the annotation in the text, e.g. [6, 9] (from 6 to 9 characters in the text)
text
:
String!
The text representation of the annotation, eg 'Buffer'
url
:
String!
The URL the annotation points to, e.g. https://www.facebook.com/107509875938399
INPUT
AnnotationInputLinkedIn
Annotation representing all the entities in the text
Fields 7
id
:
String!
The id of the annotation, e.g. 1521226
entity
:
String!
The entity of the annotation, e.g. urn:li:organization:1521226
length
:
Int!
The length of the annotation, e.g. 6
link
:
String!
The link of the annotation, e.g. https://www.linkedin.com/company/bufferapp
localizedName
:
String!
The localized name of the annotation, e.g. Buffer
start
:
Int!
The start of the annotation, e.g. 5
vanityName
:
String!
The vanity name of the annotation, e.g. bufferapp
INPUT
AssetInput
A single entity's asset. Exactly one variant must be provided.
Fields 4
Document asset
Image asset
Use metadata.{service}.linkAttachment instead. This field will be removed on December 15, 2026.
Video asset
INPUT
BlueskyPostMetadataInput
Bluesky post metadata
Fields 2
Link attachment. Mutually exclusive with a non-empty `assets` array — input providing both is rejected.
The ordered list of posts that make up the thread (not paginated). This
array is the source of truth for what gets published: every post in the
thread, including the root post, must be provided here. Posts are
published in order, each replying to the previous one. The first item is
the root post and should match the top-level `text` on the post input.
INPUT
CreatePostInput
Create post's request input.
Note: `metadata.{service}.linkAttachment` is mutually exclusive with a non-empty `assets`
array. Input providing both is rejected.
Fields 14
aiAssisted
:
Boolean
If this post was created with the help of AI
Ordered list of assets on this post.
Channel's Id for which we want to create the post
Is set when the Post is generated from a Draft
Date when the post is scheduled to be published
Is set when the Post is generated from an Idea
Metadata of the post which differs based on the social network/service
How the post is being scheduled.
needsApproval
:
Boolean!
Submit the post for approval instead of scheduling it. A post submitted for
approval is always a draft, so this conflicts with turning `saveToDraft` off.
Only valid when your posting policy on the target channel requires approval.
saveToDraft
:
Boolean
If true, saves the post as a draft instead of scheduling it.
When saving as draft:
- Post status will be 'draft' instead of 'buffer'
- Posting limits are not checked
- The post will not be published until explicitly scheduled
Scheduling type to indicate notification publishing or automatic publishing
source
:
String
source where the composer was initiated from, used for tracking.
List of tag IDs
text
:
String
Text content of the Post.
Note: for threaded posts, this needs to match the first item in the `thread` array.
INPUT
CreatePostTemplateInput
Input for an end user creating a post template. Buffer-curated
taxonomy fields are server-defaulted; setting them is only available
to official Buffer clients.
Fields 6
body
:
String!
The main content body of the template, may contain {{placeholders}}.
description
:
String
A short user-facing description of the template. Nullable for
backwards-compat at the GraphQL boundary — the resolver rejects
null/empty values with a clear input error so the underlying
storage contract (non-empty string) is still honored.
emoji
:
String
The emoji associated with the template.
Organization the template belongs to. The caller must be a member of
this organization. For `internal` visibility this is the team scope;
for `private` it's recorded on the template but does not affect
visibility.
title
:
String!
The title of the template.
Defaults to `private` if omitted. `public` is rejected — it is only
available to official Buffer clients.
INPUT
DailyPostingLimitsInput
Input for the dailyPostingLimits query.
INPUT
DateTimeComparator
Comparator for filtering by date
Input for an end user deleting a post template.
Fields 1
The ID of the template to delete.
INPUT
DocumentAssetInput
Document asset
Fields 3
thumbnailUrl
:
String!
Document thumbnail URL
title
:
String!
Document title
url
:
String!
Document URL
A channel-less draft to save on a content item.
Fields 3
aiAssisted
:
Boolean!
Set to true when the draft content was written with the help of AI.
Images, videos, or documents to attach to the draft, in display order.
text
:
String!
The written content of the draft. Can be empty when the draft holds at
least one asset.
INPUT
EditPostInput
Edit post's request input.
Note: `metadata.{service}.linkAttachment` is mutually exclusive with a non-empty `assets`
array. Input providing both is rejected.
Fields 14
ID of the post to edit
aiAssisted
:
Boolean
If this post was edited with the help of AI
Change the post's approval state alongside this edit. Leave unset to keep the
post's current approval state.
Only valid when your posting policy on the post's channel requires approval,
and only on your own drafts. Asking for the state the post is already in does
nothing.
Ordered list of assets on this post. Omit to preserve the existing list,
pass an empty array to clear it
Is set when the Post is generated from a Draft
Date when the post is scheduled to be published
Is set when the Post is generated from an Idea
Metadata of the post which differs based on the social network/service
How the post is being scheduled. Omit the field or pass null to make no
scheduling change — null does not clear or reset the schedule: a scheduled post
keeps its current share mode, queue slot, and any custom time, and the edit
applies only the other provided fields. Pass a non-null ShareMode to apply that
mode.
saveToDraft
:
Boolean
If true, saves the post as a draft instead of keeping it scheduled.
When saving as draft:
- Post status will be 'draft' instead of 'buffer'
- The post will not be published until explicitly scheduled
Scheduling type to indicate notification publishing or automatic publishing.
Omit it, or send null, to leave the post publishing the way it already does.
source
:
String
source where the composer was initiated from, used for tracking.
tags
text
:
String
Text content of the Post. Omit the field to keep the current text; pass an
empty string or null to clear it.
Note: for threaded posts, this needs to match the first item in the `thread` array.
Facebook post metadata
Fields 4
Annotations representing entities in the text
firstComment
:
String
Facebook post's first comment
Link attachment. Mutually exclusive with a non-empty `assets` array — input providing both is rejected.
The channel-specific type of the post, eg, post, story, reel for Facebook
Metadata for a GBP post that is an event
Fields 6
Action button. Optional: a post with no button, or `none`, publishes without a call-to-action. On edit, omitting it preserves the existing value.
End date of the event. Required on create; optional on edit (omitted preserves existing value).
isFullDayEvent
:
Boolean!
Indicate whether the event has a start or end time.
link
:
String
Link to the action
Start date of the event. Required on create; optional on edit (omitted preserves existing value).
title
:
String
Title of the event. Required on create; optional on edit (omitted preserves existing value).
Metadata for a GBP post that is an offer
Fields 6
code
:
String
Coupon code for the offer
End date of the offer. Required on create; optional on edit (omitted preserves existing value).
link
:
String
Link to the offer
Start date of the offer. Required on create; optional on edit (omitted preserves existing value).
terms
:
String
Terms and Conditions
title
:
String
Title of the offer. Required on create; optional on edit (omitted preserves existing value).
Google Business Profile post metadata
@deprecated: pending proposal for specific GBP post types: update, offer and event metadata types
Fields 5
Details of the Event metadata
Details of the Offer metadata
Details of the Whats new metadata
title
:
String
Title if available in the given GBP post type: event and offer
The channel-specific type of the post, eg, post, offer, event for Google Business Profile
Metadata for a GBP post of type Whats new
Fields 2
Action button. Optional: a post with no button, or `none`, publishes without a call-to-action. On edit, omitting it preserves the existing value.
link
:
String
Link to the action
INPUT
ImageAssetInput
Image asset
Fields 3
Image specific metadata
thumbnailUrl
:
String
URL to the static thumbnail of the asset
url
:
String!
URL to the file source
INPUT
ImageDimensionsInput
Image dimensions
Fields 2
height
:
Int!
Image height in pixels
width
:
Int!
Image width in pixels
INPUT
ImageMetadataInput
Image metadata
Fields 4
altText
:
String!
Alternative text for accessibility
animatedThumbnail
:
String
Animated thumbnail URL
Ignored — the API resolves image dimensions itself.
Accounts to tag at specific points on the image. Each tag's x/y position uses normalized 0.0-1.0 coordinates - see UserTagInput.
Input for refreshing a single Instagram audio asset
Fields 2
audioId
:
String!
Meta audio asset ID
Instagram channel used to authorize the refresh
Instagram Geolocation
Fields 2
id
:
String
The id of this location
text
:
String
The name of this location
Instagram post metadata
Fields 7
firstComment
:
String
Instagram post's first comment
Geolocation of the post
isAiGenerated
:
Boolean
Whether the post discloses AI-generated content
link
:
String
Shop Grid link for the post
shouldShareToFeed
:
Boolean!
Indicates whether post should be shared to feed
Sticker fields for reminder-based publishing
The channel-specific type of the post, eg, post, story, reel for Instagram
Instagram fields for reminder-based publishing. Upon the reminder for publishing, the user
is prompted to copy and paste these fields into the Instagram app to complete the post.
Fields 5
music
:
String
Placeholder text for the post's music
other
:
String
Additional field for any other post content
products
:
String
Placeholder text for the post's linked products
text
:
String
Text for the Story or Reel
topics
:
String
Placeholder text for the post's topics (Reels only)
INPUT
LinkAssetInput
Link attached to the post
Fields 4
description
:
String
Description of the link
thumbnailUrl
:
String
Thumbnail URL of the link
title
:
String
Title of the link
url
:
String!
URL to the link
INPUT
LinkAttachmentInput
Link attachment
Fields 4
description
:
String
Description shown on the link card
Thumbnail shown on the link card
title
:
String
Title shown on the link card
url
:
String!
URL that the link asset has been built from
Thumbnail of a link attachment
Fields 1
url
:
String!
URL of the thumbnail image
LinkedIn post metadata
Fields 3
Annotations representing entities in the text
firstComment
:
String
LinkedIn post's first comment
Link attachment. Mutually exclusive with a non-empty `assets` array — input providing both is rejected.
Mastodon post metadata
Fields 2
spoilerText
:
String
Spoiler text hiding the root text of this post
The ordered list of posts that make up the thread (not paginated). This
array is the source of truth for what gets published: every post in the
thread, including the root post, must be provided here. Posts are
published in order, each replying to the previous one. The first item is
the root post and should match the top-level `text` on the post input.
movePostInQueue mutation moves a queued post to the top or bottom of its channel's queue.
Fields 2
ID of the post to move.
Target position within the channel's queue.
Pinterest post metadata
Fields 3
boardServiceId
:
String
The board ID of the Pin, can be obtained when fetching the channel details with the following query:
```
query GetChannelWithSubprofiles {
channel(input: { id: "[CHANNEL_ID_HERE]" }) {
metadata {
... on PinterestMetadata {
boards {
serviceId
}
}
}
}
}
```
Required on create; optional on edit (omitted preserves existing board).
title
:
String
The title of the Pin
url
:
String
The Pin destination link
INPUT
PostInputMetaData
Metadata of the post which differs based on the social network/service
Fields 12
Metadata for Bluesky post
Metadata for Facebook post
Metadata for Google Business Profile post
Metadata for Instagram post
Metadata for LinkedIn post
Metadata for Mastodon post
Metadata for Pinterest post
Metadata for Substack post
Metadata for Threads post
Metadata for TikTok post
Metadata for Twitter post
Metadata for Youtube post
INPUT
PostsFiltersInput
Filter to apply to the posts query
Fields 10
When set, it will filter posts by channel
When set, it will filter posts by their scheduled posting date
When set, it will filter posts by whether their scheduled posting date exists.
`absent` cannot be combined with `dueAt`, because absent dates cannot also match a date range.
When set, it will return posts with createdAt or dueAt date before endDate
When set, it will filter posts by format.
`post` is a fallback bucket rather than one stored format: it matches every
post the other formats do not claim, which is what `Post.metadata.type`
reports for the same post. `carousel` and `thread` are rejected, because no
stored value resolves to them.
When set, it will return posts with createdAt or dueAt date after startDate
When set, it will filter posts by status
When set, it will filter posts by tag
Filter posts by tags. Supports specific tags, untagged posts, or union of both.
When set, it will filter posts by the date they were created
INPUT
PostsInput
Input for the posts query
Fields 3
The filters to apply to the posts query
The Organization id to fetch posts for
The sort to apply to the posts results
INPUT
PostSortInput
Sort order of post results. List multiple to create tie-breaking order.
Fields 2
The direction to sort by.
The field to sort by.
Input for fetching a single post template by ID.
Fields 1
The unique identifier of the template to fetch.
INPUT
PostTemplatesFilterInput
Filters for the template library. Visibility narrows the actor-scoped
result set; it can never widen it.
Fields 1
Narrow the result to a single visibility scope. Omit to receive the
union of: public templates, internal templates from the supplied
organization, and private templates from the actor's account.
Input for fetching templates accessible to the current actor for the
template library. A caller can never reach templates outside their own
scope — the server pins `private` to the actor's account and `internal`
to the supplied `organizationId` regardless of input.
Fields 2
Optional filters to narrow the template list.
Organization to scope `internal`-visibility templates to. The caller
must be a member of this organization.
Input for promoteContentItemDraftToPosts.
Fields 3
The content item to promote.
The channel-specific posts to create, one per channel. Provide at least
one post, and at most one post per channel.
Tags to apply to this content item. Omit to keep the current tags. An
empty list or null removes them all.
INPUT
RetweetMetadataInput
Information about the initial Tweet that was retweeted
Fields 2
id
:
String!
Retweet ID
comment
:
String
Optional user comment shown above the embedded retweet
Input for searching Instagram audio for one channel.
Fields 3
Music or original sound catalog
Instagram channel to search audio for
query
:
String!
Search text. Required. Use trendingInstagramAudio for trending results.
Substack post metadata
Fields 1
Link attachment. Mutually exclusive with a non-empty `assets` array — input providing both is rejected.
INPUT
TagComparator
Comparator for filtering by tags
Fields 2
Include results that have any of the specified tags (union/OR).
isEmpty
:
Boolean!
When true, include results that have no tags assigned.
Can be combined with 'in' for union filtering.
Defaults to false if not specified.
INPUT
TagInput
Input type for tag information used in idea creation
Fields 3
id
:
ID!
name
:
String!
color
:
String!
INPUT
ThreadedPostInput
A post authored by the user which is posted to a thread.
This is commonly used for long-format twitter and meta threads posts to
allow authored content to span multiple threads.
Threads are represented as a list of replies, each replying to the previous one.
The first item in the list is the root post of the thread and should match the
top-level `text` on the post input; the remaining items are replies.
Fields 3
Ordered list of assets on this threaded post
Service-specific fields for this threaded post
text
:
String
The text body content of the threaded post
Bluesky fields on a single item of a thread
Fields 1
Link attachment. Mutually exclusive with a non-empty `assets` array — input providing both is rejected.
INPUT
ThreadItemMetadataInput
Service-specific fields on a single item of a thread. The key must match the
channel's service; input under any other key is rejected.
Fields 2
Bluesky fields for this thread item
Threads fields for this thread item
Threads fields on a single item of a thread
Fields 1
Link attachment. Mutually exclusive with a non-empty `assets` array — input providing both is rejected.
INPUT
ThreadsPostMetadataInput
Threads post metadata
Fields 6
Link attachment. Mutually exclusive with a non-empty `assets` array — input providing both is rejected.
locationId
:
String
LocationId associated with the post
locationName
:
String
Location name associated with the post
The ordered list of posts that make up the thread (not paginated). This
array is the source of truth for what gets published: every post in the
thread, including the root post, must be provided here. Posts are
published in order, each replying to the previous one. The first item is
the root post and should match the top-level `text` on the post input.
topic
:
String
Topic associated with the post
The type of the post
INPUT
TikTokPostMetadataInput
TikTok post metadata
Fields 2
isAiGenerated
:
Boolean
Whether the post discloses AI-generated content (TikTok video only)
title
:
String
The title of the TikTok post (for photo posts)
Input for trending Instagram audio for one channel.
Fields 2
Music or original sound catalog
Instagram channel to load trending audio for
INPUT
TwitterPostMetadataInput
Twitter post metadata
Fields 3
isAiGenerated
:
Boolean
Whether the post discloses AI-generated content (original tweets only, never retweets)
The details of the tweet being retweeted
The ordered list of posts that make up the thread (not paginated). This
array is the source of truth for what gets published: every post in the
thread, including the root post, must be provided here. Posts are
published in order, each replying to the previous one. The first item is
the root post and should match the top-level `text` on the post input.
Input for updateContentItemDraft.
Fields 4
The content item whose channel-less draft is replaced.
The new draft content. Replaces the current draft in full.
Tags to apply to this content item. Omit to keep the current tags. An
empty list or null removes them all.
Date indicating when this piece of content should go out. This is a
planning aid only and does not schedule any posts. Omit to preserve the
existing target date. Null clears it.
Input for updateContentItem. Only the fields provided are changed. Omitted
fields keep their current value.
Fields 3
The content item to update.
Omit to preserve the existing target date. Null clears it.
title
:
String
Omit to preserve the existing title. Null clears it.
INPUT
UpdatePostTemplateInput
Input for an end user updating a post template. Buffer-curated
taxonomy fields are ignored; setting them is only available to
official Buffer clients.
Fields 6
The ID of the template to update.
body
:
String
The main content body of the template, may contain {{placeholders}}.
description
:
String
A short user-facing description of the template.
emoji
:
String
The emoji associated with the template.
title
:
String
The title of the template.
`public` is rejected — it is only available to official Buffer
clients.
INPUT
UserTagInput
User tag in the image
Fields 3
handle
:
String!
The handle (username) of the account to tag, without the leading @.
x
:
Float!
Horizontal position of the tag as a normalized decimal float between 0.0 and 1.0 - the fraction of the image width from the left edge (0.5 is the horizontal center). Pass a number, not a string, and do not use pixel coordinates; to convert, divide the pixel X by the image width.
y
:
Float!
Vertical position of the tag as a normalized decimal float between 0.0 and 1.0 - the fraction of the image height from the top edge (0.5 is the vertical center). Pass a number, not a string, and do not use pixel coordinates; to convert, divide the pixel Y by the image height.
INPUT
VideoAssetInput
Video asset
Fields 3
Video specific metadata
thumbnailUrl
:
String
Do not use: social networks do not accept custom video thumbnail images, and
the API rejects video assets that set this field. To choose the video
thumbnail, set `metadata.thumbnailOffset` to select a frame from the video
(supported for Instagram, TikTok, and Pinterest only).
url
:
String!
URL to the file source
INPUT
VideoMetadataInput
Video metadata
Fields 2
thumbnailOffset
:
Int
Offset of the thumbnail chosen for the video, in ms
title
:
String
Video title
INPUT
YoutubePostMetadataInput
Youtube post metadata
Fields 8
categoryId
:
String
Youtube Category ID, one ID of this list:
ID: 1 -> Film & Animation
ID: 2 -> Autos & Vehicles
ID: 10 -> Music
ID: 15 -> Pets & Animals
ID: 17 -> Sports
ID: 19 -> Travel & Events
ID: 20 -> Gaming
ID: 22 -> People & Blogs
ID: 23 -> Comedy
ID: 24 -> Entertainment
ID: 25 -> News & Politics
ID: 26 -> Howto & Style
ID: 27 -> Education
ID: 28 -> Science & Technology
ID: 29 -> Nonprofits & Activism
Required on create; optional on edit (omitted preserves existing value).
embeddable
:
Boolean
Indicates whether the video allows embedding (default: true)
isAiGenerated
:
Boolean
Whether the post discloses AI-generated content
Video license (default: youtube)
madeForKids
:
Boolean
Indicates whether the video is suitable for kids (default: false)
notifySubscribers
:
Boolean
Indicates whether to notify subscribers on publish video (default: true)
Privacy setting for post (default: public)
title
:
String
Title of the Youtube post. Required on create; optional on edit (omitted preserves existing value).
Enums 28
ENUM
AnnotationType
List of possible types for an annotation
ENUM
AssetType
Asset types
Actions the calling actor can take on a `ContentItem`. The server computes
this set from the same rules the content item mutations enforce. A client
reads it to drive UI affordances instead of deriving the rules itself.
The set carries an action only when a client can offer it on this one item.
An action whose answer is the same for every item in a response drives no
affordance, so it stays out. Read access is one of those: the API returns
only a content item the actor may read.
ENUM
DateTimePresence
Presence filter for nullable date fields.
When filtering the same field, absent dates cannot also match a date comparator range.
List of possible types for GBP cta
Instagram audio catalog type from Meta's Audio API.
ENUM
NoteAction
List of possible actions that can be performed on a note
ENUM
NoteType
The type of a note.
ENUM
NotificationStatus
List of possible statuses for a notification
ENUM
PostAction
List of possible actions that can be performed on a Post
ENUM
PostApprovalChange
A change to a post's approval state, for a post that is already a draft.
ENUM
PostingGoalStatus
PostingGoalStatus is used to track the status of a posting goal.
ENUM
PostMetricType
List of possible metrics available for a Post.
Values fall into three groups:
- **Cross-network normalized** (reactions, comments, shares, reposts, reach, impressions, views, clicks, engagementRate): Used wherever a concept maps cleanly across networks. Per-network adapters normalize their native names (e.g., Instagram `likes` → `reactions`, Twitter `retweets` → `reposts`).
- **Network-specific** (saves, follows, quotes, viewers, totalTimeWatched, averageTimeWatched, likes, freeSubscriptions, paidSubscriptions): Real metrics that don't have a cross-network equivalent. `likes` is intentionally distinct from `reactions` on Facebook — Facebook's Graph API surfaces them separately. `freeSubscriptions` and `paidSubscriptions` are Substack's per-Note subscription attribution; no other network reports it.
- **Aggregation-only** (postCount): Meaningful only on aggregate endpoints; never emitted per-post.
Deprecated values are pre-normalization legacy or tied to features being removed. They're kept in the enum for backwards compatibility until clients migrate.
ENUM
PostMetricUnit
The unit representing the value of a PostMetric.
ENUM
PostSortableKey
Key of collection to use for sorting
ENUM
PostStatus
List of possible statuses for a Post
The visibility level of a post template. `public` is reserved for
Buffer-curated templates; setting it is only available to official
Buffer clients.
ENUM
PostType
List of possible types for a Post. Some services may have different types (e.g., Instagram has story, reel, post but Twitter has only post)
ENUM
PostTypeFacebook
List of specific post types available for Facebook
List of specific post types available for Google Business profiles
ENUM
PostVia
List of possible ways to create a Post
Target position within a channel's queue that a post can be moved to.
ENUM
SchedulingType
Indicates whether the post was scheduled for notification publishing or automatic publishing
ENUM
SortDirection
Direction to sort the results by.
ENUM
TagColorName
Stable Buffer identifiers for the supported tag color palette.
Clients map these values to platform- and theme-specific presentation.
Values ending in `Light` are lighter palette variants, not UI theme modes.
ENUM
YoutubeLicense
List of license types
ENUM
YoutubePrivacy
List of privacy types
Scalars 8
A unique identifier for a content item.
A unique identifier for a channel-less draft's content.
SCALAR
DraftId
The `DraftId` scalar represents the MongoDB ObjectId of a Buffer Draft
SCALAR
NoteId
The `NoteId` scalar represents the MongoDB ObjectId of a Buffer Note
SCALAR
PostId
The `PostId` scalar represents the MongoDB ObjectId of a Buffer Post
SCALAR
PostTemplateId
The `PostTemplateId` scalar represents the MongoDB ObjectId of a Post Template.
SCALAR
TagId
The `TagId` scalar represents the MongoDB ObjectId of a Buffer Tag
SCALAR
URL
The `URL` scalar represents a valid URL
Ideas
Queries 2
Retrieves idea groups based on the provided input parameters.
Arguments
| Name | Type | Description |
|---|---|---|
| input Required | IdeaGroupsInput! | Input for retrieving idea groups. |
Example Response
{
"data": {
"ideaGroups": [
{
"id": "...",
"isLocked": true,
"name": "..."
}
]
}
}Fetch a paginated list of ideas with optional filtering
Arguments
| Name | Type | Description |
|---|---|---|
| after Optional | String | Cursor for pagination, marks where to start fetching from |
| first Optional | Int | Maximum number of items to return |
| input Required | IdeasInput! | Filtering criteria for the ideas list |
Example Response
{
"data": {
"ideas": {
"edges": [
{
"cursor": "...",
"node": {}
}
],
"pageInfo": {
"endCursor": "...",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "..."
}
}
}
}Mutations 1
Create a new idea with the given content and metadata
Arguments
| Name | Type | Description |
|---|---|---|
| input Required | CreateIdeaInput! | Input to create an idea |
Example Response
{
"data": {
"createIdea": {}
}
}Outputs 3
OUTPUT
IdeaGroup
Idea groups are used to organize ideas in the board
Fields 3
id
:
ID!
Unique identifier for the idea group.
isLocked
:
Boolean!
Whether the idea group is locked.
name
:
String!
The name of the idea group.
OUTPUT
IdeasConnection
Relay connection for paginated ideas.
Fields 2
List of idea edges containing the ideas and their cursors
Pagination metadata including hasNextPage and endCursor
OUTPUT
CreateIdeaPayload
createIdea response (including errors)
Types 8
TYPE
Idea
Ideas are the main entity in the create space
Fields 7
id
:
ID!
Unique identifier for the idea
The actual content and metadata of the idea
groupId
:
ID
ID of the group this idea belongs to (if any)
organizationId
:
ID!
ID of the organization that owns this idea
position
:
Float
Numerical position for ordering within a group
createdAt
:
Int!
Unix timestamp of when the idea was created
updatedAt
:
Int!
Unix timestamp of when the idea was last modified
TYPE
IdeaContent
Content of an idea
Fields 7
aiAssisted
:
Boolean!
Indicates whether AI tools were used in creating this idea
DateTime set by user associated with the idea - this often reflects a target publish date.
List of media items attached to the idea
Services tagged by the user - this is typically used to annotate ideas with their target services
Tags used to categorize and organize the idea
text
:
String
Main body text or description of the idea
title
:
String
Title or headline of the idea
TYPE
IdeaEdge
Pagination type for Ideas
Fields 2
cursor
:
String!
Opaque cursor for pagination, used to fetch subsequent pages
The idea object
TYPE
IdeaResponse
createIdea response type
Fields 2
The affected idea
refreshIdeas
:
Boolean!
If true, the client should refresh the ideas list because other ideas might have been moved
TYPE
LimitReachedError
Error returned when the limit is reached
Fields 1
message
:
String!
Error message
TYPE
PaginationPageInfo
Information to aid in pagination.
Fields 4
endCursor
:
String
The last cursor in the list. It can be used to fetch the next page.
hasNextPage
:
Boolean!
When set to true, it means there is a next page available.
hasPreviousPage
:
Boolean!
When set to true, it means there is a previous page available. Will always return false for now as we only support forward pagination.
startCursor
:
String
The first cursor in the list. It can be used to fetch the previous page.
TYPE
UnauthorizedError
Error returned when the user is not authorized to perform the action
Fields 1
message
:
String!
Error message
TYPE
UnexpectedError
Error returned when unexpected error occurs
Fields 1
message
:
String!
Error message
Inputs 6
INPUT
CreateIdeaInput
createIdea input type
Fields 5
Content and metadata for the new idea
cta
:
String
Call-to-action identifier for analytics tracking
Group placement (null for unassigned group)
organizationId
:
ID!
Organization ID that will own the idea
templateId
:
String
Template ID used to create the idea
INPUT
IdeaContentInput
content input for creating/updating an idea
Fields 7
aiAssisted
:
Boolean
Whether AI tools were used in creation
Target date for the idea, often used for planning publish schedules
List of media items to attach
Services associated with the idea for targeting specific platforms
Tags to categorize the idea
text
:
String
Main body text or description
title
:
String
Title or headline of the idea
INPUT
IdeaGroupInput
idea group input for create/update
Fields 2
groupId
:
ID
Target group ID (null for unassigned group)
placeAfterId
:
ID
ID of idea to place after (null for top position)
INPUT
IdeaGroupsInput
Input type for retrieving idea groups by organization ID.
Fields 1
organizationId
:
ID!
Unique identifier for the organization.
INPUT
IdeasGroupFilter
Selects which ideas to return by group membership. Exactly one field must be
provided (enforced by @oneOf). To return ideas from all groups, omit
`groupFilter` on IdeasInput rather than setting a field here.
Fields 2
groups
:
[ID!]
Return only ideas that belong to these specific groups (union/OR).
Return ideas by a group-membership bucket rather than by specific group IDs.
INPUT
IdeasInput
Filtering criteria for the ideas list.
Fields 3
Filter ideas by group membership. Omit this field entirely to return ideas
across all groups.
The organization to fetch ideas from.
Filter ideas by tags using TagComparator.
Enums 1
ENUM
IdeaGroupMembership
Named buckets for filtering ideas by their group membership.
Scalars 1
SCALAR
IdeaId
The `IdeaId` scalar represents the MongoDB ObjectId of a Buffer Idea
Organizations
Types 3
TYPE
MemberConnection
Represents the members connection edge. Later, we can add the list of members with the page info to follow our connection edge pattern.
Fields 1
totalCount
:
Int!
The total count of team members counting the org owner and team members from the Publish DB.
TYPE
Organization
Organization is a representation of a Buffer Organization.
Fields 7
The ID of the organization.
channelCount
:
Int!
The total number of channels connected to the organization.
The limits of the organization. Can be used to check if the organization has reached the limit of channels, members, etc.
The members of the organization. Can be used to check the total number of members in the organization. In the future, it might contain more information about the members.
name
:
String!
The name of the organization.
ownerEmail
:
String!
The owner email of the organization.
shouldEnforce2FASetup
:
Boolean!
Whether the requesting actor should be sent through 2FA setup before they
can use this organization. Derived: true only when the org has
`settings.enforce2FA` ON, the `organization-enforced-2fa` rollout Split is
ON for the org, and the actor has no 2FA configured on their own account.
This is the single source of truth for the forced-2FA gate; app-shell and
publish-frontend redirect to the setup flow when it's true. Exposed to the
API gateway so any stitched consumer reads the same value.
TYPE
OrganizationLimits
Resource limits for an organization including channels, members, and content limits
Fields 11
channels
:
Int!
The maximum number of channels allowed for the organization.
generateContent
:
Int!
The maximum number of content generations allowed for the organization.
ideaGroups
:
Int!
The maximum number of idea groups allowed for the organization.
ideas
:
Int!
The maximum number of ideas allowed for the organization.
members
:
Int!
The maximum number of members allowed for the organization.
postTemplates
:
Int!
The maximum number of post templates allowed for the organization.
savedReplies
:
Int!
The maximum number of saved replies allowed for the organization.
scheduledPosts
:
Int!
The maximum number of scheduled posts allowed for the organization.
scheduledStoriesPerChannel
:
Int!
The maximum number of scheduled stories allowed per channel.
scheduledThreadsPerChannel
:
Int!
The maximum number of scheduled threads allowed per channel.
tags
:
Int!
The maximum number of tags allowed for the organization.
Inputs 1
INPUT
OrganizationFilterInput
Allow retrieving a specific Organization
Fields 1
organizationId
:
String!
Scalars 1
SCALAR
OrganizationId
The `OrganizationId` scalar represents the MongoDB ObjectId of a Buffer Organization
Other
Queries 3
Global, per-organization configuration: the connected channels the actor can
view (with per-feature authorization) plus the service-level capability
catalog (services). One round trip for every capability domain; clients
select only what they need.
Arguments
| Name | Type | Description |
|---|---|---|
| input Required | ConfigurationInput! | Input for the configuration query. |
Example Response
{
"data": {
"configuration": {
"channels": [
{
"authorizationStatus": [
{}
],
"channelId": "...",
"channelType": "account",
"content": [
{}
]
}
],
"services": [
{
"channelType": "account",
"content": [
{}
],
"engagement": [
{}
],
"service": "bluesky"
}
]
}
}
}Fetch a single content item by id. Errors if no content item with that id exists.
This API is an early preview and can change without a deprecation period.
Arguments
| Name | Type | Description |
|---|---|---|
| input Required | ContentItemInput! | Input for fetching a single content item. |
Example Response
{
"data": {
"contentItem": {
"id": "...",
"accountId": "...",
"allowedActions": [
"deleteContentItem"
],
"author": {
"id": "...",
"avatar": "...",
"email": "...",
"isDeleted": true
}
}
}
}
QUERY
contentItems
(after: String, first: Int, input: ContentItemsInput!)
:
ContentItemsConnection!
⚠️ Experimental
Fetch an organization's content items in the requested order, newest first
by default. Uses standard cursor pagination: pass the previous page's
pageInfo.endCursor as after to fetch the next page. Requesting more than
100 items in a single page is rejected.
This API is an early preview and can change without a deprecation period.
Arguments
| Name | Type | Description |
|---|---|---|
| after Optional | String | The cursor after which to return results. Cursors are opaque: treat them as a black box and reset to null when the input changes, since a cursor from a different result set produces undefined behavior. |
| first Optional | Int | The number of content items to return, up to 100. |
| input Required | ContentItemsInput! | Input for listing content items. |
Example Response
{
"data": {
"contentItems": {
"edges": [
{
"cursor": "...",
"node": {}
}
],
"pageInfo": {
"endCursor": "...",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "..."
},
"totalCount": 0
}
}
}Mutations 3
MUTATION
createContentItem
(input: CreateContentItemInput!)
:
CreateContentItemPayload!
⚠️ Experimental
Create a content item together with all of its channel-specific post variants in a single operation. Validation is all-or-nothing: if any variant fails validation, no content item and no variants are created. Variants that fail while being processed after creation are reported per channel in the failure payload; the content item and its variants are still created in that case.
This API is an early preview and can change without a deprecation period.
Arguments
| Name | Type | Description |
|---|---|---|
| input Required | CreateContentItemInput! | Input for createContentItem. |
Example Response
{
"data": {
"createContentItem": {}
}
}
MUTATION
createContentItemDraft
(input: CreateContentItemDraftInput!)
:
CreateContentItemDraftPayload!
⚠️ Experimental
Create a content item holding a channel-less draft, before any channels are selected. No network-specific validation applies to the draft content. The draft needs text or at least one asset.
This API is an early preview and can change without a deprecation period.
Arguments
| Name | Type | Description |
|---|---|---|
| input Required | CreateContentItemDraftInput! | Input for createContentItemDraft. |
Example Response
{
"data": {
"createContentItemDraft": {}
}
}
MUTATION
deleteContentItem
(input: DeleteContentItemInput!)
:
DeleteContentItemPayload!
⚠️ Experimental
Delete a content item: the item itself and any posts created from it. Deletion is all-or-nothing. Every post must be deletable on its own, or nothing is deleted and every blocked post is reported at once. A post can only be deleted while it is a draft, awaiting approval, scheduled, or failed, so an item cannot be deleted while any of its posts is publishing or already published. An item still holding a channel-less draft has no posts, so nothing blocks it. An error can also be reported when a post could not be fully processed after the deletion already took effect; re-fetch before retrying.
This API is an early preview and can change without a deprecation period.
Arguments
| Name | Type | Description |
|---|---|---|
| input Required | DeleteContentItemInput! | Input for deleteContentItem. |
Example Response
{
"data": {
"deleteContentItem": {}
}
}Outputs 5
Organization configuration. `channels` carries the per-connected-channel config
the actor can view (including per-`Feature` `authorizationStatus`); `services`
carries the service-level capability catalog — the engagement and content config
for every supported `service` + `channelType`, independent of which channels are
connected (e.g. for composing before a channel is connected).
Fields 2
Per-connected-channel config for every channel the actor can view.
Service-level capability catalog for every supported service + channel type.
A paginated connection of content items.
Fields 3
The list of content item edges.
Pagination information for the connection.
totalCount
:
Int!
The total number of content items matching the request.
All possible responses for createContentItemDraft.
All possible responses for createContentItem.
All possible responses for deleteContentItem.
Types 27
An edge in a content item connection.
Fields 2
cursor
:
String!
A cursor for pagination.
The content item node at the end of the edge.
Bounds how many of a property are allowed. `min` null/absent = no lower bound
(optional); `min: 1` = required. `max` null = unlimited. At least one of `min`
or `max` is always present — a rule that bounds neither is never emitted.
Fields 3
max
:
Int
Maximum allowed count. Null = unlimited.
min
:
Int
Minimum allowed count. Null = no lower bound (optional).
The content property this rule constrains.
createContentItemDraft failure. When any part of the input is invalid,
nothing is created.
Fields 2
The recoverable errors behind this failure.
message
:
String!
Summary error message.
Successful createContentItemDraft response.
Fields 1
The content item first created for this request, including its current state.
createContentItem failure. Every recoverable error is reported together so the
caller can surface them all at once. When the input fails validation, no
content item and no variants are created. When one or more variants fail while
being processed after creation, the content item and all of its variants
already exist; the per-channel errors identify the variants that need
attention.
Fields 2
The recoverable errors behind this failure.
message
:
String!
Summary error message.
Successful createContentItem response.
Fields 1
The content item created by this mutation.
Invalid input for a single post variant in the createContentItem input list.
Fields 2
Channel targeted by the failing variant.
message
:
String!
Error message.
Limit reached for a single post variant in the createContentItem input list.
Fields 2
Channel targeted by the failing variant.
message
:
String!
Error message.
The channel targeted by a single post variant in the createContentItem input
list was not found or is not accessible.
Fields 2
Channel targeted by the failing variant.
message
:
String!
Error message.
deleteContentItem failure. When any post cannot be deleted, nothing is
deleted: the content item and all of its posts remain unchanged. Every
blocked post is reported together so the caller can surface them all at
once.
Fields 2
The recoverable errors behind this failure.
message
:
String!
Summary error message.
TYPE
DocumentAsset
Document asset
Fields 6
id
:
ID
The ID of the asset in the database
Document specific metadata
mimeType
:
String!
The MIME type of the asset
source
:
String!
URL to the file source
thumbnail
:
String!
URL to the static thumbnail of the asset
The type of the asset
TYPE
DocumentMetadata
Document metadata
Fields 4
filesize
:
Int
Document fileSize in bytes
numPages
:
Int!
Number of pages in the document
thumbnails
:
[String!]!
URLs to the static thumbnails of the document pages
title
:
String
Document title
Caps the duration of a time-based media property.
Fields 2
maxDurationSeconds
:
Int!
Maximum allowed duration in seconds.
The content property this rule constrains.
`property` cannot be combined with any of `conflictsWith`.
Fields 2
Properties that `property` cannot be combined with.
The content property this rule constrains.
Caps the byte size of a media property.
Fields 2
maxMegabytes
:
Int!
Maximum allowed size in megabytes (MB).
The content property this rule constrains.
Restricts a media property to specific formats (allow-list).
Fields 2
The formats `property` is allowed to use.
The content property this rule constrains.
TYPE
ImageAsset
Image asset
Fields 6
id
:
ID
The ID of the asset in the database
Image specific metadata
mimeType
:
String!
The MIME type of the asset
source
:
String!
URL to the file source
thumbnail
:
String!
URL to the static thumbnail of the asset
The type of the asset
TYPE
ImageMetadata
Image metadata
Fields 6
altText
:
String!
Alternative text for accessibility
animatedThumbnail
:
String
Animated thumbnail URL
height
:
Int!
Image height in pixels
isAnimated
:
Boolean!
Is the image animated?
User tags in the image
width
:
Int!
Image width in pixels
Caps the character length of a text-like property (e.g. 280 for X post text).
Fields 2
maxLength
:
Int!
Maximum allowed character length.
The content property this rule constrains.
`property` requires all of `requires` to also be present.
Fields 2
The content property this rule constrains.
Properties that must also be present when `property` is used.
Service-level configuration for one supported `service` + `channelType`: its
engagement capabilities and `content`. The channel-agnostic baseline — today
the same fields as `ChannelConfiguration` minus `channelId` and the per-channel
`authorizationStatus`. This overlap is incidental, not a contract: it is a
distinct type so the service-level catalog can evolve independently of the
per-channel config (either side may add fields the other doesn't share).
Fields 4
The channel type within the service (e.g. profile, page, business).
Content config — one entry per content type, or a single entry
grouping several types that share identical rules. Empty when none is exposed.
Engagement capabilities — one entry per engagement type. Empty when
engagement isn't supported for this service + channel type.
The social service this config describes (e.g. twitter, instagram).
TYPE
VideoAsset
Video asset
Fields 6
id
:
ID
The ID of the asset in the database
mimeType
:
String!
The MIME type of the asset
source
:
String!
URL to the file source
thumbnail
:
String!
URL to the static thumbnail of the asset
The type of the asset
Video specific metadata
TYPE
VideoMetadata
Video metadata
Fields 14
audioCodec
:
String
Audio codec
containerFormat
:
String
Video container format
durationMs
:
Int!
Video duration in seconds
fileSize
:
Int
Video fileSize in bytes
frameRate
:
Int
Video framerate
height
:
Int!
Video height in pixels
isTranscodingRequired
:
Boolean!
Whether the video needs to be transcoded before it can be broadcasted
isVideoProcessing
:
Boolean!
Whether the video is currently being processed (transcoding in progress)
rotationDegree
:
Int
Rotation degree
thumbnailOffset
:
Int
Offset of the thumbnail chosen for the video, in ms
title
:
String
Video title
videoBitRate
:
Int
Video bitrate in kbps
videoCodec
:
String
Video codec
width
:
Int!
Video width in pixels
TYPE
MutationSuccess
Base Mutation Success type
Used when we have a success response with no data, we return this type with empty string
Fields 1
_empty
:
String!
The value is alwaus an empty string ''
Note: GraphQL doesn't allow types with no fields, so we have to add this field
TYPE
ScrapedLink
Link data for link preview
Fields 3
text
:
String!
Description for the scraped link
thumbnails
:
[String!]!
Thumbnails of media available in the link
url
:
String!
URL that the link asset has been built from
A recoverable error that prevented a content item from being created. Variant
errors identify the specific channel they apply to; the others apply to the
request as a whole.
Inputs 9
Input for the configuration query.
Fields 1
The organization to return configuration for.
Input for fetching a single content item by id.
Fields 1
The unique identifier of the content item to fetch.
Filters for listing content items. Omitted fields do not filter.
Fields 3
Only return content items with this content status. When omitted, content
items in every status are returned.
Only return content items carrying one of these tags, or, with `isEmpty`,
content items with no tags at all. Matches the tags applied to the content
item itself, not tags applied later to an individual post.
Only return content items matching this target date filter.
Input for listing an organization's content items.
Fields 3
Filters to apply. When omitted, all of the organization's content items
are returned.
Organization to list content items for. The caller must be a member of
this organization.
Sorting to apply, each entry breaking ties in the one before it. Defaults to
newest first. A pagination cursor is only valid for the sort that produced
it, so reset `after` to null whenever the sort changes.
One sorting criterion for the content items query. List several to break ties.
Fields 2
The direction to sort by.
The field to sort by.
Filter for a content item's target date. Provide exactly one field
(enforced by @oneOf).
Fields 2
Only return content items by whether a target date is set: `present`
returns only dated items, `absent` only undated ones.
Only return content items whose target date falls within this range.
A range with no bounds returns every content item that has a target date.
Input for createContentItemDraft.
Fields 6
Client-generated UUID that makes draft creation idempotent. A retry with the
same UUID in the same organization returns the first content item in its
current state.
The channel-less draft content to start with.
Organization that will own the content item.
Tags to apply to this content item. Omit to create it with no tags.
Optional date indicating when this piece of content should go out. This is
a planning aid only and does not schedule any posts.
title
:
String
Optional title describing what this piece of content is about.
Input for createContentItem.
Fields 5
Organization that owns the content item and all variants created in it.
The channel-specific post variants to create, one per channel. Provide at
least one variant, and at most one variant per channel.
Tags to apply to this content item. Omit to create it with no tags.
Optional date indicating when this piece of content should go out. This is
a planning aid only and does not schedule any posts.
title
:
String
Optional title describing what this piece of content is about.
Input for deleteContentItem.
Fields 1
The content item to delete.
Enums 2
Field to sort content items by.
The status of a content item's body.
Scalars 3
SCALAR
Email
The `Email` scalar represents a valid, normalized email address.
Input is trimmed and lowercased before validation.
SCALAR
InvitationId
The `InvitationId` scalar represents the MongoDB ObjectId of a pending team invitation
SCALAR
Uuid
The `Uuid` scalar represents an RFC 4122 v4 UUID,
e.g. `550e8400-e29b-41d4-a716-446655440000`.
Directives 1
@oneOf
Indicates exactly one field must be supplied and this field must not be null.
Locations: INPUT_OBJECT