openapi: 3.0.3 info: title: ActiveCampaign SMS Broadcast Accounts Users API description: API for managing SMS broadcasts, lists, metrics, and AI-powered content generation in ActiveCampaign version: 3.0.0 contact: name: ActiveCampaign Support url: https://www.activecampaign.com x-generated-from: documentation servers: - url: https://{yourAccountName}.api-us1.com/api/3 description: US-based Users variables: yourAccountName: default: yourAccountName security: - ApiToken: [] tags: - name: Users paths: /users: post: summary: ActiveCampaign Create a User description: Create a new user operationId: create-user requestBody: content: application/json: schema: type: object properties: user: properties: username: type: string description: Username email: type: string description: Email address firstName: type: string description: First name lastName: type: string description: Last name group: type: integer description: Group ID default: null format: int32 password: type: string description: Plain text password required: [] type: object examples: Request Example: value: user: username: jdoe firstName: John lastName: Doe email: johndoe@example.com password: myPa$$w0rd group: 4 responses: '201': description: '201' content: application/json: examples: Result: value: "{\n \"user\": {\n \"username\": \"jdoe\",\n \"email\": \"johndoe@example.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"lang\": \"english\",\n \"localZoneid\": \"America/New_York\",\n \"cdate\": \"2022-02-02T16:01:44-06:00\",\n \"udate\": \"2022-02-02T16:01:44-06:00\",\n \"links\": {\n \"lists\": \"https://:account.api-us1.com/api/3/users/3/lists\",\n \"userGroup\": \"https://:account.api-us1.com/api/3/users/3/userGroup\",\n \"dealGroupTotals\": \"https://:account.api-us1.com/api/3/users/3/dealGroupTotals\",\n \"dealGroupUsers\": \"https://:account.api-us1.com/api/3/users/3/dealGroupUsers\",\n \"configs\": \"https://:account.api-us1.com/api/3/users/3/configs\",\n \"dealConnection\": \"https://:account.api-us1.com/api/3/users/3/dealConnection\",\n \"userConversationsPermission\": \"https://:account.api-us1.com/api/3/users/3/userConversationsPermission\",\n \"seatUser\": \"https://:account.api-us1.com/api/3/users/3/seatUser\"\n },\n \"id\": \"3\"\n }\n}" schema: type: object properties: user: type: object properties: username: type: string example: jdoe email: type: string example: johndoe@example.com firstName: type: string example: John lastName: type: string example: Doe lang: type: string example: english localZoneid: type: string example: America/New_York cdate: type: string example: '2022-02-02T16:01:44-06:00' udate: type: string example: '2022-02-02T16:01:44-06:00' links: type: object properties: lists: type: string example: https://:account.api-us1.com/api/3/users/3/lists userGroup: type: string example: https://:account.api-us1.com/api/3/users/3/userGroup dealGroupTotals: type: string example: https://:account.api-us1.com/api/3/users/3/dealGroupTotals dealGroupUsers: type: string example: https://:account.api-us1.com/api/3/users/3/dealGroupUsers configs: type: string example: https://:account.api-us1.com/api/3/users/3/configs dealConnection: type: string example: https://:account.api-us1.com/api/3/users/3/dealConnection userConversationsPermission: type: string example: https://:account.api-us1.com/api/3/users/3/userConversationsPermission seatUser: type: string example: https://:account.api-us1.com/api/3/users/3/seatUser id: type: string example: '3' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Users x-microcks-operation: delay: 0 dispatcher: FALLBACK get: summary: ActiveCampaign List All Users description: List all existing users operationId: list-all-users responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"users\": [\n {\n \"username\": \"admin\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"johndoe@activecampaign.com\",\n \"phone\": \"\",\n \"signature\": null,\n \"links\": {\n \"lists\": \"https://:account.api-us1.com/api/3/users/1/lists\",\n \"userGroup\": \"https://:account.api-us1.com/api/3/users/1/userGroup\",\n \"dealGroupTotals\": \"https://:account.api-us1.com/api/3/users/1/dealGroupTotals\",\n \"dealGroupUsers\": \"https://:account.api-us1.com/api/3/users/1/dealGroupUsers\",\n \"configs\": \"https://:account.api-us1.com/api/3/users/1/configs\"\n },\n \"id\": \"1\"\n },\n {\n \"username\": \"janedoe\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"email\": \"janedoe@activecampaign.com\",\n \"phone\": \"\",\n \"signature\": null,\n \"links\": {\n \"lists\": \"https://:account.api-us1.com/api/3/users/5/lists\",\n \"userGroup\": \"https://:account.api-us1.com/api/3/users/5/userGroup\",\n \"dealGroupTotals\": \"https://:account.api-us1.com/api/3/users/5/dealGroupTotals\",\n \"dealGroupUsers\": \"https://:account.api-us1.com/api/3/users/5/dealGroupUsers\",\n \"configs\": \"https://:account.api-us1.com/api/3/users/5/configs\"\n },\n \"id\": \"5\"\n }\n ],\n \"meta\": {\n \"total\": \"2\"\n }\n}" schema: type: object properties: users: type: array items: type: object properties: username: type: string example: admin firstName: type: string example: John lastName: type: string example: Doe email: type: string example: johndoe@activecampaign.com phone: type: string example: '' signature: {} links: type: object properties: lists: type: string example: https://:account.api-us1.com/api/3/users/1/lists userGroup: type: string example: https://:account.api-us1.com/api/3/users/1/userGroup dealGroupTotals: type: string example: https://:account.api-us1.com/api/3/users/1/dealGroupTotals dealGroupUsers: type: string example: https://:account.api-us1.com/api/3/users/1/dealGroupUsers configs: type: string example: https://:account.api-us1.com/api/3/users/1/configs id: type: string example: '1' meta: type: object properties: total: type: string example: '2' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Users x-microcks-operation: delay: 0 dispatcher: FALLBACK /users/{id}: get: summary: ActiveCampaign Retrieve a User description: Retrieve an existing user operationId: get-user parameters: - name: id in: path description: ID of the user you want to view schema: type: integer format: int32 required: true responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"user\": {\n \"username\": \"admin\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"johndoe@example.com\",\n \"phone\": \"\",\n \"signature\": null,\n \"links\": {\n \"lists\": \"https://:account.api-us1.com/api/3/users/1/lists\",\n \"userGroup\": \"https://:account.api-us1.com/api/3/users/1/userGroup\",\n \"dealGroupTotals\": \"https://:account.api-us1.com/api/3/users/1/dealGroupTotals\",\n \"dealGroupUsers\": \"https://:account.api-us1.com/api/3/users/1/dealGroupUsers\",\n \"configs\": \"https://:account.api-us1.com/api/3/users/1/configs\"\n },\n \"id\": \"1\"\n }\n}" schema: type: object properties: user: type: object properties: username: type: string example: admin firstName: type: string example: John lastName: type: string example: Doe email: type: string example: johndoe@example.com phone: type: string example: '' signature: {} links: type: object properties: lists: type: string example: https://:account.api-us1.com/api/3/users/1/lists userGroup: type: string example: https://:account.api-us1.com/api/3/users/1/userGroup dealGroupTotals: type: string example: https://:account.api-us1.com/api/3/users/1/dealGroupTotals dealGroupUsers: type: string example: https://:account.api-us1.com/api/3/users/1/dealGroupUsers configs: type: string example: https://:account.api-us1.com/api/3/users/1/configs id: type: string example: '1' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Users x-microcks-operation: delay: 0 dispatcher: FALLBACK put: summary: ActiveCampaign Update a User description: Update an existing user operationId: update-user parameters: - name: id in: path description: ID of the user schema: type: integer format: int32 required: true requestBody: content: application/json: schema: type: object properties: user: properties: username: type: string description: Username. Username cannot be changed! password: type: string description: 'Password. Example: ''newpassword''' email: type: string description: 'Email address of the user. Example: ''test@example.com''' firstName: type: string description: 'First name of the user. Example: ''FirstName''' lastName: type: string description: 'Last name of the user. Example: ''LastName''' group: type: integer description: Assign to Groups format: int32 required: [] type: object responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"userGroups\": [\n {\n \"userid\": \"3\",\n \"groupid\": \"3\",\n \"links\": {\n \"group\": \"https://:account.api-us1.com/api/3/userGroups/3/group\",\n \"user\": \"https://:account.api-us1.com/api/3/userGroups/3/user\"\n },\n \"id\": \"3\",\n \"group\": \"3\",\n \"user\": \"3\"\n }\n ],\n \"user\": {\n \"username\": \"user\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"johndoe@example.com\",\n \"phone\": \"\",\n \"signature\": \"\",\n \"userGroup\": \"3\",\n \"links\": {\n \"lists\": \"https://:account.api-us1.com/api/3/users/3/lists\",\n \"userGroup\": \"https://:account.api-us1.com/api/3/users/3/userGroup\",\n \"dealGroupTotals\": \"https://:account.api-us1.com/api/3/users/3/dealGroupTotals\",\n \"dealGroupUsers\": \"https://:account.api-us1.com/api/3/users/3/dealGroupUsers\",\n \"configs\": \"https://:account.api-us1.com/api/3/users/3/configs\"\n },\n \"id\": \"3\"\n }\n}" schema: type: object properties: userGroups: type: array items: type: object properties: userid: type: string example: '3' groupid: type: string example: '3' links: type: object properties: group: type: string example: https://:account.api-us1.com/api/3/userGroups/3/group user: type: string example: https://:account.api-us1.com/api/3/userGroups/3/user id: type: string example: '3' group: type: string example: '3' user: type: string example: '3' user: type: object properties: username: type: string example: user firstName: type: string example: John lastName: type: string example: Doe email: type: string example: johndoe@example.com phone: type: string example: '' signature: type: string example: '' userGroup: type: string example: '3' links: type: object properties: lists: type: string example: https://:account.api-us1.com/api/3/users/3/lists userGroup: type: string example: https://:account.api-us1.com/api/3/users/3/userGroup dealGroupTotals: type: string example: https://:account.api-us1.com/api/3/users/3/dealGroupTotals dealGroupUsers: type: string example: https://:account.api-us1.com/api/3/users/3/dealGroupUsers configs: type: string example: https://:account.api-us1.com/api/3/users/3/configs id: type: string example: '3' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Users x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: ActiveCampaign Delete a User description: Delete an existing user operationId: delete-user parameters: - name: id in: path description: ID of the user you wish to delete schema: type: integer format: int32 required: true responses: '200': description: '200' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Users x-microcks-operation: delay: 0 dispatcher: FALLBACK /users/email/{email}: get: summary: ActiveCampaign Retrieve a User by Email description: Retrieve an existing user by looking up their email address operationId: get-user-email parameters: - name: email in: path description: Email address of the user you want to view schema: type: string required: true responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"user\": {\n \"username\": \"somebody\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"johndoe@example.com\",\n \"phone\": \"\",\n \"signature\": null,\n \"links\": {\n \"lists\": \"https://:account.api-us1.com/api/3/users/1/lists\",\n \"userGroup\": \"https://:account.api-us1.com/api/3/users/1/userGroup\",\n \"dealGroupTotals\": \"https://:account.api-us1.com/api/3/users/1/dealGroupTotals\",\n \"dealGroupUsers\": \"https://:account.api-us1.com/api/3/users/1/dealGroupUsers\",\n \"configs\": \"https://:account.api-us1.com/api/3/users/1/configs\"\n },\n \"id\": \"1\"\n }\n}" schema: type: object properties: user: type: object properties: username: type: string example: somebody firstName: type: string example: John lastName: type: string example: Doe email: type: string example: johndoe@example.com phone: type: string example: '' signature: {} links: type: object properties: lists: type: string example: https://:account.api-us1.com/api/3/users/1/lists userGroup: type: string example: https://:account.api-us1.com/api/3/users/1/userGroup dealGroupTotals: type: string example: https://:account.api-us1.com/api/3/users/1/dealGroupTotals dealGroupUsers: type: string example: https://:account.api-us1.com/api/3/users/1/dealGroupUsers configs: type: string example: https://:account.api-us1.com/api/3/users/1/configs id: type: string example: '1' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Users x-microcks-operation: delay: 0 dispatcher: FALLBACK /users/username/{username}: get: summary: ActiveCampaign Retrieve a User by Username description: Retrieve an existing user by looking up their username operationId: get-user-username parameters: - name: username in: path description: Username of the user you want to view schema: type: string required: true responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"user\": {\n \"username\": \"admin\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"johndoe@example.com\",\n \"phone\": \"\",\n \"signature\": null,\n \"links\": {\n \"lists\": \"https://:account.api-us1.com/api/3/users/1/lists\",\n \"userGroup\": \"https://:account.api-us1.com/api/3/users/1/userGroup\",\n \"dealGroupTotals\": \"https://:account.api-us1.com/api/3/users/1/dealGroupTotals\",\n \"dealGroupUsers\": \"https://:account.api-us1.com/api/3/users/1/dealGroupUsers\",\n \"configs\": \"https://:account.api-us1.com/api/3/users/1/configs\"\n },\n \"id\": \"1\"\n }\n}" schema: type: object properties: user: type: object properties: username: type: string example: admin firstName: type: string example: John lastName: type: string example: Doe email: type: string example: johndoe@example.com phone: type: string example: '' signature: {} links: type: object properties: lists: type: string example: https://:account.api-us1.com/api/3/users/1/lists userGroup: type: string example: https://:account.api-us1.com/api/3/users/1/userGroup dealGroupTotals: type: string example: https://:account.api-us1.com/api/3/users/1/dealGroupTotals dealGroupUsers: type: string example: https://:account.api-us1.com/api/3/users/1/dealGroupUsers configs: type: string example: https://:account.api-us1.com/api/3/users/1/configs id: type: string example: '1' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Users x-microcks-operation: delay: 0 dispatcher: FALLBACK /users/me: get: summary: ActiveCampaign Retrieve Logged-in User description: Retrieve the logged-in user operationId: get-user-loggedin responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"user\": {\n \"username\": \"jdoe\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"johndoe@example.com\",\n \"phone\": \"\",\n \"signature\": null,\n \"links\": {\n \"lists\": \"https://:account.api-us1.com/api/3/users/1/lists\",\n \"userGroup\": \"https://:account.api-us1.com/api/3/users/1/userGroup\",\n \"dealGroupTotals\": \"https://:account.api-us1.com/api/3/users/1/dealGroupTotals\",\n \"dealGroupUsers\": \"https://:account.api-us1.com/api/3/users/1/dealGroupUsers\",\n \"configs\": \"https://:account.api-us1.com/api/3/users/1/configs\"\n },\n \"id\": \"1\"\n }\n}" schema: type: object properties: user: type: object properties: username: type: string example: jdoe firstName: type: string example: John lastName: type: string example: Doe email: type: string example: johndoe@example.com phone: type: string example: '' signature: {} links: type: object properties: lists: type: string example: https://:account.api-us1.com/api/3/users/1/lists userGroup: type: string example: https://:account.api-us1.com/api/3/users/1/userGroup dealGroupTotals: type: string example: https://:account.api-us1.com/api/3/users/1/dealGroupTotals dealGroupUsers: type: string example: https://:account.api-us1.com/api/3/users/1/dealGroupUsers configs: type: string example: https://:account.api-us1.com/api/3/users/1/configs id: type: string example: '1' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Users x-microcks-operation: delay: 0 dispatcher: FALLBACK components: securitySchemes: ApiToken: type: apiKey name: Api-Token in: header description: Your ActiveCampaign API token