PATCH
/
profiles

Update an existing profile’s title, hide title, list of disabled social platforms, or display the title. The Profile Key in the header parameter is the User Profile to be updated.

Header Parameters

Authorization
string
required
Format: Authorization: Bearer API_KEY. See API overview for more information.
Profile-Key
string
Profile Key of a user profile.

Request Body

disableSocial
array

Array of social networks that are disabled for this user’s profile. The primary profile’s list of disabled social networks takes precedence.

Available networks: twitter, facebook, instagram, linkedin, telegram, gmb, youtube, tiktok, pinterest, and reddit.

See here for more information.

title
string
required

Title of the profile. Must be unique. This title will be displayed on the social account linking page.

messagingActive
boolean
default: false

Set to true to active messaging for this user profile. Messaging must first be enabled for your Ayrshare account.

hideTopHeader
boolean

Hide the top header on the social accounts linkage page.

topHeader
string

Change the header on the social accounts linkage page. If not set, then displays: “Social Accounts for “title” where “title” is the profile title.

tags
array

Tag user profiles using an array of strings. These tags serve as an internal organizational tool to categorize and manage your user profiles effectively.