Pular para o conteúdo principal
POST
Crie um novo profile dentro do seu Primary Profile. Após a criação bem-sucedida do User Profile, a resposta da API incluirá o Profile Key associado ao profile recém-criado. Armazene o Profile Key com segurança em seu sistema, pois ele será necessário para fazer chamadas de API em nome do seu usuário. Observe que, por questões de segurança, os Profile Keys são retornados apenas em dois casos específicos:
  1. Criação do User Profile: quando um novo User Profile é criado.
  2. No Painel do Ayrshare: você pode encontrar o Profile Key de cada profile no Painel do Ayrshare. Alterne para o User Profile e, em seguida, navegue até a página Profile Key.
Recomendamos que você armazene o Profile Key com segurança em seu sistema.

Gerenciar redes sociais

Use o campo disableSocial para gerenciar (adicionar/remover) redes sociais da exibição. Consulte Gerenciar contas sociais para mais informações.

Gerenciar User Profiles ativos

Consulte aqui algumas recomendações sobre como gerenciar User Profiles ativos.

Considerações importantes de segurança

  • Evite compartilhar Profile Keys publicamente ou expô-los em código do lado do cliente ou em repositórios públicos.
  • Profile Keys são credenciais sensíveis usadas para autenticar e autorizar o acesso aos User Profiles.
  • É fundamental armazenar os Profile Keys com segurança em seu sistema, com controles de acesso adequados para manter a integridade e a confidencialidade dos dados dos seus usuários.
  • Por questões de segurança, o Profile Key não pode ser recuperado novamente pela API. No entanto, você pode obter o Profile Key pelo painel.
  • O refId também deve ser armazenado para associar um profile a um retorno de endpoint.

Parâmetros do cabeçalho

Parâmetros do corpo

title
string
obrigatório
Título do novo profile. Deve ser único. Este título será exibido na página de vinculação de contas sociais.
messagingActive
boolean
padrão:false
Defina como true para ativar mensagens para este user profile. As mensagens devem estar habilitadas primeiro para a sua conta Ayrshare.
hideTopHeader
boolean
padrão:false
Oculta o cabeçalho superior na página de vinculação de contas sociais.
Oculta o logotipo da empresa na página de vinculação de contas sociais apenas para este user profile. O logotipo em nível de conta nos demais profiles não é afetado. Útil para white-label de profiles de parceiros individuais, mantendo a marca no restante.
topHeader
string
Altera o cabeçalho na página de vinculação de contas sociais. Se não for definido, exibe: “Social Accounts for “title”, onde “title” é o título do profile.
disableSocial
array
Matriz de redes sociais que estão desativadas para o profile deste usuário. A lista de redes sociais desativadas do primary profile tem precedência.Redes disponíveis: bluesky, facebook, gmb, instagram, linkedin, pinterest, reddit, snapchat, telegram, threads, tiktok, twitter e youtube.Consulte ativar ou desativar redes sociais para mais informações.
team
boolean
padrão:false
Crie um novo user profile como membro de equipe definindo team: true. O campo email será usado para enviar um e-mail de convite. Consulte convidar um membro da equipe para detalhes sobre os requisitos.
email
string
Um endereço de e-mail válido para o qual o convite do membro da equipe será enviado. Obrigatório se team: true.
subHeader
string
Altera o subcabeçalho na página de vinculação de contas sociais. Atualmente exibe “Click an icon to link a social network”. Defina como uma string vazia para remover.Veja como alterar o link de ajuda.
tags
array
Marque user profiles usando uma matriz de strings. Essas tags servem como uma ferramenta organizacional interna para categorizar e gerenciar seus user profiles de forma eficaz.