client_roles

Invite an user to a client role

Invite an user to a client role by the email. The user will recieve an invitation to the email

post/clients/{id_client}/roles/{id_rol}/invite

Request

  • Base URL: https://api.planvortex.com/v1.0.0
  • URL: https://api.planvortex.com/v1.0.0/clients/{id_client}/roles/{id_rol}/invite
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (client credentials, token URL https://api.planvortex.com/v1.0.0/oauth/token)

Path parameters

id_clientstring required

Client the role belongs to

id_rolstring required

Role the invited user will be assigned

Request body

emailstring email required

Email address to invite. Returns error 609 if it is not a valid address. If no user exists with that address, a disabled one is created and an invitation email is sent with a temporary token; the account is enabled when the invitation is accepted.

Response

Successful operation

successboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.