Custom Roles API reference
Reference map for Custom Roles API operations.
- Updated
- Apr 26, 2026
Custom Roles
Use this reference map to choose the operation group before opening an endpoint page for exact request and response details.
Use Custom Roles when the job is trusted administration of merchant role records.
Custom role operations own paginated listing, reads, creation, updates, and deletion. Use Merchant Users when the job is assigning or managing the merchant-facing user account rather than changing the role record.
For workflow guidance across custom roles, third-party links, scheduling, logs, and shareable links, see Operational controls and external handoffs.
Read and inspect
| Operation | API |
|---|---|
| List all custom roles within pagination | Management API |
| Get a custom role | Management API |
Create or attach
| Operation | API |
|---|---|
| Create a custom role | Management API |
Update or repair
| Operation | API |
|---|---|
| Update a custom role | Management API |
Remove or deactivate
| Operation | API |
|---|---|
| Delete a custom role | Management API |