# Bright Pattern Users API

**Canonical:** https://apis.io/apis/bright-pattern/bright-pattern-users-api/  
**Provider:** Bright Pattern — https://apis.io/providers/bright-pattern/  
**Base URL:** https://{tenant}.brightpattern.com/configapi/v2  
**Documentation:** https://help.brightpattern.com/latest:Api

Bright Pattern Users API is one of 14 APIs that [Bright Pattern](https://apis.io/providers/bright-pattern/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification.

With the https://:tenant_url/configapi/v2/user endpoint you can: Create new users and define most of their attributes Update existing users Check and clear user lockout state Manage agents' skills Delete existing users Below is a brief description of all user attributes that can be accessed via this API. More detailed descriptions of these attributes can be found here. All attributes are strings unless otherwise noted. All attributes are optional unless otherwise noted. Attribute Description loginId Username. Required to create user. Used to identify the user in all subsequent User Management API operations. password Password. Format must comply with security policy. changePassword Indicates whether user must change password on next login. Boolean. Default is false. firstName First name. Required to create user. lastName Last name. Required to create user. team Team that the user is assigned to. Required to create user. extension User's extension number. If not specified, an extension will be created and assigned automatically. workPhone User's work phone number. mobilePhone User's mobile phone number. email User's email address. disabled Indication whether the user account is disabled or enabled. Boolean (true/flase). skills For agents an array of skills with levels (e.g., "Support": 75). roles An array of user's roles (e.g., Agent).

## Machine-readable artifacts (12)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/bright-pattern/refs/heads/main/openapi/bright-pattern-users-api-openapi.yml
- **Postman** — https://documenter.getpostman.com/view/6711197/S1EUtanN
- **Postman** — https://documenter.getpostman.com/view/8336025/SVYwJbLw
- **Postman** — https://documenter.getpostman.com/view/8336025/2sB3WmV3UC
- **Postman** — https://documenter.getpostman.com/view/8336025/2sA3Qy5U4z
- **Postman** — https://documenter.getpostman.com/view/6735878/T1DtdFDu
- **Postman** — https://documenter.getpostman.com/view/31590362/2sA3XTfLhk
- **Postman** — https://documenter.getpostman.com/view/6711197/S1ETRbny
- **Postman** — https://documenter.getpostman.com/view/6711197/S1EUtb1f
- **Postman** — https://documenter.getpostman.com/view/6735878/T1DwbtSk
- **Postman** — https://documenter.getpostman.com/view/6735878/TzXwFJFP
- **Postman** — https://documenter.getpostman.com/view/6735877/T1LHGpBY

## Other Bright Pattern APIs (12)

- [Bright Pattern Authentication API](https://apis.io/apis/bright-pattern/bright-pattern-authentication-api/)
- [Bright Pattern Calling List API](https://apis.io/apis/bright-pattern/bright-pattern-calling-list-api/)
- [Bright Pattern Campaigns API](https://apis.io/apis/bright-pattern/bright-pattern-campaigns-api/)
- [Bright Pattern DNC Lists API](https://apis.io/apis/bright-pattern/bright-pattern-dnc-lists-api/)
- [Bright Pattern Do Not Call List API](https://apis.io/apis/bright-pattern/bright-pattern-do-not-call-list-api/)
- [Bright Pattern Link Groups API](https://apis.io/apis/bright-pattern/bright-pattern-link-groups-api/)
- [Bright Pattern Lists API](https://apis.io/apis/bright-pattern/bright-pattern-lists-api/)
- [Bright Pattern Methods API](https://apis.io/apis/bright-pattern/bright-pattern-methods-api/)
- [Bright Pattern Multichannel Call Recordings API](https://apis.io/apis/bright-pattern/bright-pattern-multichannel-call-recordings-api/)
- [Bright Pattern Phones API](https://apis.io/apis/bright-pattern/bright-pattern-phones-api/)
- [Bright Pattern Regular Call Recordings API](https://apis.io/apis/bright-pattern/bright-pattern-regular-call-recordings-api/)
- [Bright Pattern SMS/MMS Messaging API](https://apis.io/apis/bright-pattern/bright-pattern-sms-mms-messaging-api/)

## Tags

User

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/bright-pattern/bright-pattern-users-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/bright-pattern/.