User Management

Manage who on your team can access the Apara Checkout dashboard and what they can do.

Where to find it: Dashboard → Settings → Teams

Only Admin users can invite, edit roles, or remove team members.

Roles & Team Management

There are 4 roles available in the Apara Dashboard. Each role has a fixed set of permissions — custom roles are not supported.

Available Roles

Permission Breakdown

How to Invite a Team Member

From Dashboard

1. Go to Settings → Teams
2. Click + Invite User
3. Enter the user's email address
4. Select a role
5. Click Send Invite

The user will receive an email invitation. The invite appears as pending in the Teams table until accepted.

Via API

POST /checkout/user-management/invite

{
  "email": "developer@yourcompany.com",
  "roleId": "developer"
}

Tip: Only Admin users can call this endpoint. Requests from non-admin roles will be rejected.

How to Edit a Team Member's Role

From Dashboard

1. Go to Settings → Teams
2. Click the edit (pencil) icon next to the user
3. Select the new role from the dropdown
4. Click Update Role

Via API

PUT /checkout/user-management/users/{cxId}/role

{
  "roleId": "operations"
}

Note: Admin users cannot have their role changed or be removed. The edit and delete actions are disabled for Admin accounts.

How to Remove a Team Member

From Dashboard

1. Go to Settings → Teams
2. Click the delete (trash) icon next to the user
3. Confirm the removal

Via API

DELETE /checkout/user-management/users/{cxId}

Managing Pending Invites

Invites that haven't been accepted yet can be revoked.

List Pending Invites

GET /checkout/user-management/invites

Revoke an Invite

DELETE /checkout/user-management/invites/{inviteId}

In the dashboard, pending invites appear in the Teams table. Clicking the delete icon on a pending invite revokes the invite rather than removing a user.

Accepting an Invite

When a user receives an invite email, they click the invite link which calls:

POST /checkout/user-management/accept-invite

This completes onboarding and grants dashboard access with the assigned role.

Other Endpoints