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.

Authentication

AuthorizationBearer

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

Path parameters

organizationIdstringRequired
Organization ID to invite the user to

Request

This endpoint expects an object.
emailstringRequired

Email address or API username (api_<uuid> format) 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. For immediate assignments: “Roles assigned immediately…”. For traditional flow: “Invitation sent to…”

organizationIdstring
ID of the organization for this invitation
userExistsboolean
Indicates whether the invited user already exists in the system
rolesAssignedImmediatelyboolean
Indicates whether roles were assigned immediately without requiring invitation redemption

Errors

400
Create Organization Invitation Request Bad Request Error
401
Create Organization Invitation Request Unauthorized Error
403
Create Organization Invitation Request Forbidden Error
409
Create Organization Invitation Request Conflict Error
422
Create Organization Invitation Request Unprocessable Entity Error
500
Create Organization Invitation Request Internal Server Error