API de PagosUsers

Create and send an organization invitation

Create an invitation to join an existing organization. The organization ID is specified in the URL.

Path parameters

organizationIdstringRequired
Organization ID to invite the user to

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

Organization invitation data with email and roles
emailstringRequiredformat: "email"
Email address of the user to invite
roleslist of stringsRequired

Array of role IDs to assign to the user for the organization. Must contain at least 1 role. Available organization roles: k3r_user_org_inviter, k3r_user_org_viewer, k3r_user_org_manager, k3r_user_org_operator, k3r_user_org_merchant_admin

Response

Organization invitation created and sent successfully.
successboolean
Indicates whether the operation was successful
messagestring
Message describing the invitation result
organizationIdstring
ID of the organization for this invitation
userExistsboolean
Indicates whether the invited user already exists in the system

Errors