Skip to main content
PATCH
https://api.ayrshare.com/api
/
profiles
curl \
-H "Authorization: Bearer API_KEY" \
-H 'Content-Type: application/json' \
-d '{"profileKey": "Jokdf-903Js-j9sd0-Pow02-QS9n3", "title": "ACME Profile"}' \
-X PATCH https://api.ayrshare.com/api/profiles

{
    "status": "success",
    "refId": "b1eb30ce50607a40000b220c01c20a88a49fe76f"
}
Available on Business, Enterprise plans.
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
API Key of the Primary Profile.

Format: Authorization: Bearer API_KEY
​
Profile-Key
string
required
Profile Key of a User Profile.

Format: Profile-Key: PROFILE_KEY

​
Body Parameters

​
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: bluesky, facebook, gmb, instagram, linkedin, pinterest, reddit, snapchat, telegram, threads, tiktok, twitter, and youtube.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 activate messaging for this user profile. Messaging must first be enabled for your Ayrshare account.
​
hideTopHeader
boolean
default:false
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.
​
xAccountActivityActive
boolean
default:false
The X Account Activity allows you to receive webhook updates for all events on this user’s X account. For example, when a new tweet is posted, a like or mention occurs, a new DM is received, or a new reply is received.You must first register an Account Activity webhook with the accountActivity action before enabling this feature.Please contact your account representative to enable this feature.
curl \
-H "Authorization: Bearer API_KEY" \
-H 'Content-Type: application/json' \
-d '{"profileKey": "Jokdf-903Js-j9sd0-Pow02-QS9n3", "title": "ACME Profile"}' \
-X PATCH https://api.ayrshare.com/api/profiles

{
    "status": "success",
    "refId": "b1eb30ce50607a40000b220c01c20a88a49fe76f"
}