POST
/
profiles
curl \
-H "Authorization: Bearer API_KEY" \
-H 'Content-Type: application/json' \
-d '{"title": "ACME Profile"}' \
-X POST https://api.ayrshare.com/api/profiles

{
    "status": "success",
    "title": "Digg It",
    "refId": "140b8709bd6ade099b242d895e268fb886130c53",
    "profileKey": "7TVRLEZ-24A43C0-NJW0Z82-F11984N",
    "messagingActive": true // true if messaging for this user profile is active
}
Available on Business, Enterprise plans.
Create a new profile under your Primary Profile. Upon successful creation of the User Profile, the API response will include the Profile Key associated with the newly created profile. Securely store the Profile Key in your system, as it will be required to make API calls on behalf of your user. Please note that for security reasons, the Profile Keys are only returned in two specific cases:
  1. User Profile Creation: When a new User Profile is created.
  2. In the Ayrshare Dashboard: You can find the Profile Key for each profile within the Ayrshare Dashboard. Switch to the User Profile and then navigate to the Profile Key page.
We recommend you securely store the Profile Key in your system.

​
Manage Social Networks

Use the disableSocial field to manage (add/remove) social networks from display. Please see Manage Social Accounts for more information.

​
Manage Active User Profiles

Please see here for some recommendations on managing active User Profiles.

​
Important Security Considerations

  • Avoid sharing Profile Keys publicly or exposing them in client-side code or public repositories.
  • Profile Keys are sensitive credentials used to authenticate and authorize access to User Profiles.
  • It is crucial to store Profile Keys securely in your system with appropriate access controls to maintain the integrity and confidentiality of your users’ data.
  • For security reasons, the Profile Key can’t be retrieved again using the API. However, you can retrieve the Profile Key from the dashboard.
  • The refId should also be stored to associate a profile to an endpoint return.

​
Header Parameters

​
Authorization
string
required
API Key of the Primary Profile.

Format: Authorization: Bearer API_KEY

​
Body Parameters

​
title
string
required
Title of the new 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.
​
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 enable or disable social networks for more information.
​
team
boolean
default:false
Create a new user profile as a team member by setting team: true. The email field will be used to send an invite email. See inviting a team member for details on the requirements.
​
email
string
A valid email address where the team member invite will be sent. Required if team: true
​
subHeader
string
Change the sub header on the social accounts linkage page. Currently displays “Click an icon to link a social network”. Set to an empty string to remove.See how to change the help link.
​
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.
curl \
-H "Authorization: Bearer API_KEY" \
-H 'Content-Type: application/json' \
-d '{"title": "ACME Profile"}' \
-X POST https://api.ayrshare.com/api/profiles

{
    "status": "success",
    "title": "Digg It",
    "refId": "140b8709bd6ade099b242d895e268fb886130c53",
    "profileKey": "7TVRLEZ-24A43C0-NJW0Z82-F11984N",
    "messagingActive": true // true if messaging for this user profile is active
}