Перейти до основного вмісту
POST
Створіть новий профіль під вашим Primary Profile. Після успішного створення User Profile API-відповідь буде включати Profile Key, пов’язаний із новоствореним профілем. Надійно зберігайте Profile Key у вашій системі, оскільки він знадобиться для виконання API-викликів від імені вашого користувача. Зверніть увагу, що з міркувань безпеки Profile Keys повертаються лише у двох конкретних випадках:
  1. Створення User Profile: коли створюється новий User Profile.
  2. У Ayrshare Dashboard: ви можете знайти Profile Key для кожного профілю в Ayrshare Dashboard. Переключіться на User Profile і потім перейдіть на сторінку Profile Key.
Ми рекомендуємо надійно зберігати Profile Key у вашій системі.

Керування соціальними мережами

Використовуйте поле disableSocial, щоб керувати (додавати/видаляти) соціальними мережами при відображенні. Див. Manage Social Accounts для отримання додаткової інформації.

Керування активними User Profiles

Див. деякі рекомендації щодо керування активними User Profiles.

Важливі міркування безпеки

  • Уникайте публічного розкриття Profile Keys або їхнього використання у клієнтському коді чи публічних репозиторіях.
  • Profile Keys — це чутливі credentials, які використовуються для автентифікації та авторизації доступу до User Profiles.
  • Дуже важливо зберігати Profile Keys надійно у вашій системі з відповідним контролем доступу, щоб підтримувати цілісність і конфіденційність даних ваших користувачів.
  • З міркувань безпеки Profile Key не можна отримати знову через API. Однак ви можете отримати Profile Key з dashboard.
  • refId також слід зберігати, щоб пов’язати профіль із поверненням endpoint.

Header Parameters

Body Parameters

title
string
обов'язково
Назва нового профілю. Має бути унікальною. Ця назва відображатиметься на сторінці прив’язки соціальних облікових записів.
messagingActive
boolean
за замовчуванням:false
Встановіть true, щоб активувати messaging для цього user profile. Спочатку messaging має бути ввімкнено для вашого облікового запису Ayrshare.
hideTopHeader
boolean
за замовчуванням:false
Приховати верхній заголовок на сторінці прив’язки соціальних облікових записів.
Приховати логотип компанії на сторінці прив’язки соціальних облікових записів лише для цього user profile. Логотип на рівні облікового запису для інших профілів не змінюється. Корисно для white-labeling окремих партнерських профілів, зберігаючи брендинг на решті.
topHeader
string
Змінити заголовок на сторінці прив’язки соціальних облікових записів. Якщо не встановлено, відображається: “Social Accounts for “title"", де “title” — це назва профілю.
disableSocial
array
Масив соціальних мереж, які вимкнено для профілю цього користувача. Список вимкнених соціальних мереж primary profile має перевагу.Доступні мережі: bluesky, facebook, gmb, instagram, linkedin, pinterest, reddit, snapchat, telegram, threads, tiktok, twitter та youtube.Див. enable or disable social networks для отримання додаткової інформації.
team
boolean
за замовчуванням:false
Створити новий user profile як team member, встановивши team: true. Поле email буде використано для надсилання листа-запрошення. Див. інструкції з запрошення team member для деталей щодо вимог.
email
string
Дійсна адреса електронної пошти, на яку буде надіслано запрошення team member. Обов’язкова, якщо team: true
subHeader
string
Змінити підзаголовок на сторінці прив’язки соціальних облікових записів. Наразі відображається “Click an icon to link a social network”. Встановіть порожній рядок, щоб видалити.Див., як змінити help link.
tags
array
Позначайте user profiles за допомогою масиву рядків. Ці теги слугують внутрішнім інструментом організації для ефективної категоризації та керування вашими user profiles.