Envia convite para área privada
Permite enviar um convite para uma entidade de forma a que esta tenha acesso à sua área privada no Libax Pages.
Para utilizar esta funcionalidade é necessário ter um perfil no Libax Pages e ter associado o serviço do Libax Seguros ao perfil.
Conheça o Libax Pages
POST https://segurosapi.libax.com/v1/{token}/SendPagesInvite
Permissão requerida: leitura
Parâmetro
|
|
Descrição
|
ProfileID *
|
int
|
Id do perfil no Libax Pages. Pode obter este Id nas configurações do perfil.
|
SatelliteID *
|
int
|
Id do serviço associao ao perfil no Libax Pages. Pode obter este Id nas configurações da associação do serviço.
|
Email *
|
string
|
E-mail para onde será enviado o convite. Deve ser o e-mail de quem vai ter acesso à área privada.
|
EntitiesIds *
|
int
|
Ids da entidades a mostrar na área privada separados por virgula. Ex: 1,2,3,4
|
CanPrint
|
bool
|
True se pretende conceder permissão de impressão à entidade. Se não enviado é assumido true.
|
CanViewInvoices
|
bool
|
True se pretende conceder permissão para ver faturas. Se não enviado é assumido true.
|
CanEditAddressAndContact
|
bool
|
True se entidade pode alterar a morada e contactos. Se não enviado é assumido true.
|
CanViewContracts
|
bool
|
True se entidade pode ver apólices. Se não enviado é assumido true.
|
CanViewDocuments
|
bool
|
True se entidade pode ver recibos. Se não enviado é assumido true.
|
CanViewParticipations
|
bool
|
True se entidade pode ver participações. Se não enviado é assumido true.
|
CanViewVault
|
bool
|
True se entidade pode ver funcionalidade seguros vault. Se não enviado é assumido true.
|
* obrigatório
Respostas
HTTP: 201
{ "Message": "Invitation sent" }
HTTP: 200
{ "Message": "Invitation resent" }
HTTP: 400
{ "Message": "There are errors in the model: ..." }
HTTP: 403
{ "Message": "Forbidden, profile or satellite not exists" }
{ "Message": "Invitation already sent and no longer pending" }
{ "Message": "Invitation not sent. Maximum invitation limit reached" }
{ "Message": "Invitation service temporarily unavailable" }
HTTP: 404
{ "Message": "Entity not found" }