Skip to main content
PATCH
Change custom name

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

socialAccount
string
required

The social account ID

Body

application/json
custom_name
string | null
Maximum string length: 100

Response

SocialAccountData

id
string
required
socialNetwork
enum<string>
required
Available options:
twitter,
linkedin,
linkedin_page,
facebook,
instagram,
tiktok,
bluesky,
pinterest,
google_business_profile,
youtube,
threads,
snapchat,
dribbble,
tumblr
organization_id
string
required
user_id
string | null
required

ID of user who connected social account

group_id
string | null
required

The ID of the group to which the social account belongs

name
string | null
required

Display name of the social media account

custom_name
string | null
required

Custom name to easily recognize this account in PostFlow

username
string | null
required

Username for the social media account

headline
string | null
required

Headline / bio of the social media account

followers_count
integer | null
required

Number of followers, updated once a day

verified
boolean
required

Checks whether the account is verified on the network

URL to the profile

URL to the profile picture of the social account

social_id
string | null
required

Unique identifier for the account on the social network

pi_boards
PinterestBoardData · object[]
required

Pinterest boards for this account

pi_default_board_id
string | null
required

Default Pinterest board ID

pi_default_section_id
string | null
required

Default Pinterest board section ID

ig_shopping_product_tag_eligibility
boolean
required

Determines whether an Instagram account is eligible to tag products from the catalog

yt_playlists
string[] | null
required

YouTube playlists for this account

yt_categories
string[] | null
required

YouTube categories for this account

connection_expired_at
string<date-time> | null
required

The date on which the access token expired. If this value is not null, you must manually refresh the connection for the account

external_sync_enabled
boolean
required

Automatically sync posts that were published on this account outside of PostFlow

created_at
string<date-time>
required

The date the account was first connected to PostFlow

user
UserData · object | null
required

User who connected social account. This data is not always available, depends on the endpoint and the include parameter