Zenler (Independent Publisher) (Preview)
Zenler is an all-in-one course creation, delivery, and marketing platform.
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Contact | |
---|---|
Name | Troy Taylor |
URL | https://www.hitachisolutions.com |
[email protected] |
Connector Metadata | |
---|---|
Publisher | Troy Taylor |
Website | https://www.newzenler.com/ |
Privacy policy | https://www.newzenler.com/privacy-policy |
Categories | Business Management |
Creating a connection
The connector supports the following authentication types:
Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Name | Type | Description | Required |
---|---|---|---|
API Key | securestring | The API Key for this api | True |
Account Name | securestring | The account name for this api | True |
Throttling Limits
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Actions
Add user |
Creates a new user. |
Delete a user |
Remove a user from your account. |
Enroll a user |
Enrolls a user to a course. |
Get brief affiliates report |
Retrieves a brief report of affiliates. |
Get brief course progress report |
Retrieves a brief report of course progress. |
Get brief enrollments report |
Retrieves a brief list of enrollments. |
Get brief sales report |
Retrieves a brief report of sales. |
Get course |
Retrieves a course by course identifier. |
Get detailed affiliates report |
Retrieves a detailed report of affiliates. |
Get detailed course progress report |
Retrieves a detailed report of course progress. |
Get detailed enrollments report |
Retrieves a detailed list of enrollments. |
Get detailed sales report |
Retrieves a detailed sales report. |
Get enrollments for a funnel |
Retrieves a list of enrollments for a funnel. |
Get funnels |
Retrieves a list of funnels. |
Get list of courses |
Retrieves a list of courses. |
Get upcoming classes |
Retrieves a list of upcoming live classes. |
Get upcoming webinars |
Retrieve a list of upcoming live webinars. |
Get user details |
Retrieve information about a user. |
Get user list |
Retrieves a list of users. |
Register for class |
Register a user for a live class. |
Register for webinar |
Register a user for a live webinar. |
Subscribe to funnel |
Subscribe a user to a funnel. |
Unenroll a user |
Unenrolls a user from a course. |
Unregister for class |
Unregister a user for a live class. |
Unregister for webinar |
Unregister a user for a live webinar. |
Unsubscribe from funnel |
Unsubscribes a user from a funnel. |
Update user |
Updates a user's information. |
Add user
Creates a new user.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
First Name
|
first_name | True | string |
The first name. |
Last Name
|
last_name | True | string |
The last name. |
Email
|
True | string |
The email address. |
|
Password
|
password | True | string |
The password. |
Commission
|
commission | True | integer |
The commission. |
Roles
|
roles | True | string |
The roles. |
Address
|
address | string |
The address. |
|
City
|
city | string |
The city. |
|
State
|
state | string |
The state. |
|
Phone
|
phone | string |
The phone number. |
|
Zip Code
|
zip_code | integer |
The zip code. |
|
Country
|
country | string |
The country. |
|
GDPR Consent Status
|
gdpr_consent_status | integer |
The GDPR consent status. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Response Code
|
response_code | integer |
The response code. |
Message
|
message | string |
The response message. |
ID
|
data.id | string |
The identifier. |
First Name
|
data.first_name | string |
The first name. |
Last Name
|
data.last_name | string |
The last name. |
Email
|
data.email | string |
The email address. |
Delete a user
Remove a user from your account.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
User ID
|
user_id | True | string |
The user identifier. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Response Code
|
response_code | integer |
The response code. |
Message
|
message | string |
The response message. |
Data
|
data | string |
The data. |
Enroll a user
Enrolls a user to a course.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
User ID
|
user_id | True | string |
The user identifier. |
Course ID
|
course_id | True | string |
The course identifier. |
Plan ID
|
plan_id | string |
The plan identifier. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Response Code
|
response_code | integer |
The response code. |
Message
|
message | string |
The response message. |
Data
|
data | string |
The data. |
Get brief affiliates report
Retrieves a brief report of affiliates.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Start Date
|
start_date | string |
The start date. |
|
End Date
|
end_date | string |
The end date. |
|
Limit
|
limit | integer |
The limit. |
|
Page
|
page | integer |
The page number. |
|
Course IDs
|
course_ids[] | string |
The course identifiers. |
|
Affiliate IDs
|
affiliate_ids[] | string |
The affiliate identifiers. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Response Code
|
response_code | integer |
The response code. |
Message
|
message | string |
The response message. |
Items
|
data.items | array of object | |
Currency
|
data.items.currency | string |
The currency. |
Aff ID
|
data.items.aff_id | string |
The affiliate identifier. |
Aff Name
|
data.items.aff_name | string |
The affiliate name. |
Aff Email
|
data.items.aff_email | string |
The affiliate's email address. |
Total Sales Count
|
data.items.total_sales_count | integer |
The total sales count. |
Total Commission
|
data.items.total_commission | string |
The total commission. |
Pending Commission
|
data.items.pending_commission | string |
The pending commission. |
Paid Commission
|
data.items.paid_commission | string |
The paid commission. |
Total Items
|
data.pagination.total_items | integer |
The total items number. |
Items Per Page
|
data.pagination.items_per_page | string |
The items per page. |
Page Index
|
data.pagination.page_index | string |
The page index. |
Total Pages
|
data.pagination.total_pages | integer |
The total pages number. |
Get brief course progress report
Retrieves a brief report of course progress.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Start Date
|
start_date | string |
The start date. |
|
End Date
|
end_date | string |
The end date. |
|
Limit
|
limit | integer |
The limit. |
|
Page
|
page | integer |
The page number. |
|
Course IDs
|
course_ids[] | string |
The course identifiers. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Response Code
|
response_code | integer |
The response code. |
Message
|
message | string |
The response message. |
Course ID
|
data.items.course_number.courseId | integer |
The course identifier. |
Start Date
|
data.items.course_number.start_date | string |
The start date. |
Last Date
|
data.items.course_number.last_date | string |
The last date. |
Course Name
|
data.items.course_number.courseName | string |
The course name. |
Total Students
|
data.items.course_number.total_students | integer |
The total number of students. |
Not Started
|
data.items.course_number.not_started | integer |
Whether started. |
In Progress
|
data.items.course_number.in_progress | integer |
Whether in progress. |
Completed
|
data.items.course_number.completed | integer |
Whether completed. |
Pass Rate
|
data.items.course_number.pass_rate | integer |
The pass rate. |
Total Items
|
data.pagination.total_items | integer |
The total items number. |
Items Per Page
|
data.pagination.items_per_page | string |
The items per page. |
Page Index
|
data.pagination.page_index | string |
The page index. |
Total Pages
|
data.pagination.total_pages | integer |
The total pages number. |
Get brief enrollments report
Retrieves a brief list of enrollments.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Start Date
|
start_date | string |
The start date. |
|
End Date
|
end_date | string |
The end date. |
|
Course ID
|
course_id | string |
The course identifier. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Response Code
|
response_code | integer |
The response code. |
Message
|
message | string |
The response message. |
Items
|
data.items | array of object | |
Course ID
|
data.items.course_id | integer |
The course identifier. |
Course Name
|
data.items.course_name | string |
The course name. |
Number Of Enrollments
|
data.items.no_of_enrollments | integer |
The number of enrollments. |
Total Items
|
data.pagination.total_items | integer |
The total items number. |
Items Per Page
|
data.pagination.items_per_page | integer |
The items per page. |
Page Index
|
data.pagination.page_index | integer |
The page index. |
Total Pages
|
data.pagination.total_pages | integer |
The total pages number. |
Get brief sales report
Retrieves a brief report of sales.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Start Date
|
start_date | string |
The start date. |
|
End Date
|
end_date | string |
The end date. |
|
Limit
|
limit | integer |
The limit. |
|
Page
|
page | integer |
The page number. |
|
Group By
|
groupby | string |
The group by. |
|
Course IDs
|
course_ids | string |
The course identifiers. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Response Code
|
response_code | integer |
The response code. |
Message
|
message | string |
The response message. |
Items
|
data.items | array of object | |
Total Sales
|
data.items.total_sales | integer |
The total sales. |
Course ID
|
data.items.course_id | integer |
The course identifier. |
Earnings Total
|
data.items.earnings_total | string |
The earnings total. |
Sales Total
|
data.items.sales_total | string |
The sales total. |
Aff Fee
|
data.items.aff_fee | string |
The affiliate fee. |
Name
|
data.items.name | string |
The name. |
Day
|
data.items.day | string |
The day. |
Month
|
data.items.month | string |
The month. |
Currency
|
data.items.currency | string |
The currency. |
Total Items
|
data.pagination.total_items | integer |
The total items number. |
Items Per Page
|
data.pagination.items_per_page | integer |
The items per page. |
Page Index
|
data.pagination.page_index | integer |
The page index. |
Total Pages
|
data.pagination.total_pages | integer |
The total pages number. |
Get course
Retrieves a course by course identifier.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Course ID
|
course_id | True | string |
The course identifier. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Response Code
|
response_code | integer |
The response code. |
Message
|
message | string |
The response message. |
ID
|
data.items.id | integer |
The identifier. |
Name
|
data.items.name | string |
The name. |
Subtitle
|
data.items.subtitle | string |
The subtitle. |
Thumbnail
|
data.items.thumbnail | string |
The thumbnail. |
Course Type
|
data.items.course_type | integer |
The course type. |
Owner
|
data.items.owner | string |
The owner. |
School ID
|
data.items.school_id | integer |
The school identifier. |
Public
|
data.items.public | integer |
Whether public. |
Featured
|
data.items.featured | integer |
Whether featured . |
Hidden
|
data.items.hidden | integer |
Whether hidden. |
Private
|
data.items.private | integer |
Whether private. |
Get detailed affiliates report
Retrieves a detailed report of affiliates.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Start Date
|
start_date | string |
The start date. |
|
End Date
|
end_date | string |
The end date. |
|
Limit
|
limit | integer |
The limit. |
|
Page
|
page | integer |
The page number. |
|
Course IDs
|
course_ids[] | string |
The course identifiers. |
|
Affiliate IDs
|
affiliate_ids[] | string |
The affiliate identifiers. |
|
Advanced Filter
|
af_v | string |
The advanced filter. |
|
Coupon Is
|
coupon_is[] | string |
The coupon is. |
|
Coupon Like
|
coupon_like[] | string |
The coupon is like. |
|
Name Is
|
name_is[] | string |
The name is. |
|
Name Like
|
name_like[] | string |
The name is like. |
|
Email Is
|
email_is[] | string |
The email is. |
|
Email Like
|
email_like[] | string |
The email is like. |
|
Affiliate Is
|
affiliate_is[] | string |
The affiliate is. |
|
Payment Type
|
payment_type | string |
The payment type. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Response Code
|
response_code | integer |
The response code. |
Message
|
message | string |
The response message. |
Items
|
data.items | array of object | |
Course
|
data.items.course | string |
The course. |
Created At
|
data.items.created_at | string |
When created at. |
Sales Price
|
data.items.sales_price | string |
The sales price. |
Coupon Discount
|
data.items.coupon_discount | string |
The coupon discount. |
Commission
|
data.items.commission | string |
The commission. |
Payout Status
|
data.items.payout_status | string |
The payout status. |
Total Items
|
data.pagination.total_items | integer |
The total items number. |
Items Per Page
|
data.pagination.items_per_page | integer |
The items per page. |
Page Index
|
data.pagination.page_index | integer |
The page index. |
Total Pages
|
data.pagination.total_pages | integer |
The total pages number. |
Get detailed course progress report
Retrieves a detailed report of course progress.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Start Date
|
start_date | string |
The start date. |
|
End Date
|
end_date | string |
The end date. |
|
Limit
|
limit | integer |
The limit. |
|
Page
|
page | integer |
The page number. |
|
Course IDs
|
course_ids[] | string |
The course identifiers. |
|
Advanced Filter
|
af_v | string |
The advanced filter. |
|
Coupon Is
|
coupon_is[] | string |
The coupon is. |
|
Coupon Like
|
coupon_like[] | string |
The coupon is like. |
|
Name Is
|
name_is[] | string |
The name is. |
|
Name Like
|
name_like[] | string |
The name is like. |
|
Email Is
|
email_is[] | string |
The email is. |
|
Email Like
|
email_like[] | string |
The email is like. |
|
Affiliate Is
|
affiliate_is[] | string |
The affiliate is. |
|
Payment Type
|
payment_type | integer |
The payment type. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Response Code
|
response_code | integer |
The response code. |
Message
|
message | string |
The response message. |
UID
|
data.items.course_number.uid | string |
The unique identifier. |
Course ID
|
data.items.course_number.courseId | string |
The course identifier. |
Name
|
data.items.course_number.name | string |
The name. |
Email
|
data.items.course_number.email | string |
The email address. |
Enrollment Date
|
data.items.course_number.enrollment_date | string |
The enrollment date. |
Start Date
|
data.items.course_number.start_date | string |
The start date. |
Completed Date
|
data.items.course_number.completed_date | string |
The completed date. |
Status
|
data.items.course_number.status | string |
The status. |
Last Attended
|
data.items.course_number.last_attended | string |
When last attended. |
Completion Percentage
|
data.items.course_number.completion_percentage | integer |
The completion percentage. |
Total Items
|
data.pagination.total_items | integer |
The total items number. |
Items Per Page
|
data.pagination.items_per_page | string |
The items per page. |
Page Index
|
data.pagination.page_index | string |
The page index. |
Total Pages
|
data.pagination.total_pages | integer |
The total pages number. |
Get detailed enrollments report
Retrieves a detailed list of enrollments.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Start Date
|
start_date | string |
The start date. |
|
End Date
|
end_date | string |
The end date. |
|
Course ID
|
course_id | string |
The course identifier. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Response Code
|
response_code | integer |
The response code. |
Message
|
message | string |
The response message. |
Items
|
data.items | array of object | |
Course ID
|
data.items.course_id | integer |
The course identifier. |
User ID
|
data.items.user_id | string |
The user identifier. |
Course Name
|
data.items.course_name | string |
The course name. |
First Name
|
data.items.first_name | string |
The first name. |
Last Name
|
data.items.last_name | string |
The last name. |
Email
|
data.items.email | string |
The email address. |
Enrollment Date
|
data.items.enrollment_date | string |
The enrollment date. |
Get detailed sales report
Retrieves a detailed sales report.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Start Date
|
start_date | string |
The start date. |
|
End Date
|
end_date | string |
The end date. |
|
Limit
|
limit | integer |
The limit. |
|
Page
|
page | integer |
The page number. |
|
Course IDs
|
course_ids | string |
The course identifiers. |
|
Payment Type
|
payment_type | integer |
The payment type. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Response Code
|
response_code | integer |
The response code. |
Message
|
message | string |
The response message. |
Items
|
data.items | array of object | |
Created At
|
data.items.created_at | string |
When created at. |
Transaction ID
|
data.items.transaction_id | string |
The transaction identifier. |
Sales Price
|
data.items.sales_price | string |
The sales price. |
Earn Price
|
data.items.earn_price | string |
The earn price. |
Student Name
|
data.items.student_name | string |
The student's name. |
Student Email
|
data.items.student_email | string |
The student's email address. |
Course
|
data.items.course | string |
The course. |
Course ID
|
data.items.course_id | integer |
The course identifier. |
Coupon Code
|
data.items.coupon_code | string |
The coupon code. |
Payment Gateway
|
data.items.payment_gateway | string |
The payment gateway. |
Total Items
|
data.pagination.total_items | integer |
The total items number. |
Items Per Page
|
data.pagination.items_per_page | integer |
The items per page. |
Page Index
|
data.pagination.page_index | integer |
The page index. |
Total Pages
|
data.pagination.total_pages | integer |
The total pages number. |
Get enrollments for a funnel
Retrieves a list of enrollments for a funnel.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Funnel ID
|
funnel_id | True | string |
The funnel identifier. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Response Code
|
response_code | integer |
The response code. |
Message
|
message | string |
The response message. |
Items
|
data.items | array of object | |
ID
|
data.items.id | string |
The identifier. |
First Name
|
data.items.first_name | string |
The first name. |
Last Name
|
data.items.last_name | string |
The last name. |
Email
|
data.items.email | string |
The email address. |
Enrolled On
|
data.items.enrolled_on | string |
When enrolled on. |
Get funnels
Retrieves a list of funnels.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Limit
|
limit | integer |
The limit. |
|
Page
|
page | integer |
The page number. |
|
Order By
|
orderby | string |
The order by field. |
|
Order
|
order | string |
The order. |
|
Search
|
search | string |
The search term. |
|
Status
|
status | integer |
The status. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Response Code
|
response_code | integer |
The response code. |
Message
|
message | string |
The response message. |
Items
|
data.items | array of object | |
ID
|
data.items.id | integer |
The identifier. |
Name
|
data.items.name | string |
The name. |
Type
|
data.items.type | string |
The type. |
URL
|
data.items.url | string |
The URL address. |
Total Leads
|
data.items.total_leads | integer |
The total number of leads. |
Thumbnail
|
data.items.thumbnail | string |
The thumbnail. |
Total Items
|
data.pagination.total_items | integer |
The total items number. |
Items Per Page
|
data.pagination.items_per_page | integer |
The items per page. |
Page Index
|
data.pagination.page_index | integer |
The page index. |
Total Pages
|
data.pagination.total_pages | integer |
The total pages number. |
Get list of courses
Retrieves a list of courses.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Limit
|
limit | integer |
The limit. |
|
Page
|
page | integer |
The page number. |
|
Order By
|
orderby | string |
The order by field. |
|
Order
|
order | string |
The order. |
|
Search
|
search | string |
The search term. |
|
Type
|
type | integer |
The type. |
|
Status
|
status | integer |
The status. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Response Code
|
response_code | integer |
The response code. |
Message
|
message | string |
The response message. |
Items
|
data.items | array of object | |
ID
|
data.items.id | integer |
The identifier. |
Name
|
data.items.name | string |
The name. |
Subtitle
|
data.items.subtitle | string |
The subtitle. |
Thumbnail
|
data.items.thumbnail | string |
The thumbnail. |
URL
|
data.items.url | string |
The URL address. |
Total Items
|
data.pagination.total_items | integer |
The total items number. |
Items Per Page
|
data.pagination.items_per_page | integer |
The items per page. |
Page Index
|
data.pagination.page_index | integer |
The page index. |
Total Pages
|
data.pagination.total_pages | integer |
The total pages number. |
Get upcoming classes
Retrieves a list of upcoming live classes.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Limit
|
limit | integer |
The limit. |
|
Page
|
page | integer |
The page number. |
|
Order By
|
orderby | string |
The order by field. |
|
Order
|
order | string |
The order. |
|
Search
|
search | string |
The search term. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Response Code
|
response_code | integer |
The response code. |
Message
|
message | string |
The response message. |
Items
|
data.items | array of object | |
ID
|
data.items.id | integer |
The identifier. |
Topic
|
data.items.topic | string |
The topic. |
Schedule Date
|
data.items.schedule_date | string |
The schedule date. |
Timezone
|
data.items.timezone | string |
The timezone. |
Duration
|
data.items.duration | integer |
The duration. |
Register URL
|
data.items.register_url | string |
The register URL address. |
Recurring
|
data.items.recurring | boolean |
Whether recurring. |
Recent Recurring Schedule
|
data.items.recent_recurring_schedule | string |
The recent recurring schedule. |
Total Items
|
data.pagination.total_items | integer |
The total items number. |
Items Per Page
|
data.pagination.items_per_page | integer |
The items per page. |
Page Index
|
data.pagination.page_index | integer |
The page index. |
Total Pages
|
data.pagination.total_pages | integer |
The total pages number. |
Get upcoming webinars
Retrieve a list of upcoming live webinars.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Limit
|
limit | integer |
The limit. |
|
Page
|
page | integer |
The page number. |
|
Order By
|
orderby | string |
The order by field. |
|
Order
|
order | string |
The order. |
|
Search
|
search | string |
The search term. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Response Code
|
response_code | integer |
The response code. |
Message
|
message | string |
The response message. |
Items
|
data.items | array of object | |
ID
|
data.items.id | integer |
The identifier. |
Topic
|
data.items.topic | string |
The topic. |
Schedule Date
|
data.items.schedule_date | string |
The schedule date. |
Timezone
|
data.items.timezone | string |
The timezone. |
Duration
|
data.items.duration | integer |
The duration. |
Register URL
|
data.items.register_url | string |
The register URL address. |
Recurring
|
data.items.recurring | boolean |
Whether recurring. |
Recent Recurring Schedule
|
data.items.recent_recurring_schedule | string |
The recent recurring schedule. |
Total Items
|
data.pagination.total_items | integer |
The total items number. |
Items Per Page
|
data.pagination.items_per_page | integer |
The items per page. |
Page Index
|
data.pagination.page_index | integer |
The page index. |
Total Pages
|
data.pagination.total_pages | integer |
The total pages number. |
Get user details
Retrieve information about a user.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
User ID
|
user_id | True | string |
The user identifier. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Response Code
|
response_code | integer |
The response code. |
Message
|
message | string |
The response message. |
ID
|
data.id | string |
The identifier. |
First Name
|
data.first_name | string |
The first name. |
Last Name
|
data.last_name | string |
The last name. |
Email
|
data.email | string |
The email address. |
Bio
|
data.bio | string |
The biography. |
Address
|
data.address | string |
The address. |
City
|
data.city | string |
The city. |
State
|
data.state | string |
The State. |
Zip Code
|
data.zip_code | string |
The zip code. |
Roles
|
data.roles | array of integer | |
Phone
|
data.phone | string |
The phone number. |
Get user list
Retrieves a list of users.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Limit
|
limit | integer |
The limit. |
|
Page
|
page | integer |
The page number. |
|
Order By
|
orderby | string |
The order by field. |
|
Order
|
order | string |
The order. |
|
Search
|
search | string |
The search term. |
|
Role
|
role | integer |
The role. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Response Code
|
response_code | integer |
The response code. |
Message
|
message | string |
The response message. |
Items
|
data.items | array of object | |
ID
|
data.items.id | string |
The identifier. |
First Name
|
data.items.first_name | string |
The first name. |
Last Name
|
data.items.last_name | string |
The last name. |
Email
|
data.items.email | string |
The email address. |
Roles
|
data.items.roles | array of integer |
The roles. |
Total Items
|
data.pagination.total_items | integer |
The total items number. |
Items Per Page
|
data.pagination.items_per_page | integer |
The items per page. |
Page Index
|
data.pagination.page_index | integer |
The page index. |
Total Pages
|
data.pagination.total_pages | integer |
The total pages number. |
Register for class
Register a user for a live class.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Live Class ID
|
liveclass_id | True | string |
The live class identifier. |
Name
|
name | True | string |
The name. |
Email
|
True | string |
The email address. |
|
Last Name
|
last_name | string |
The last name. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Response Code
|
response_code | integer |
The response code. |
Message
|
message | string |
The response message. |
Name
|
data.name | string |
The name. |
Email
|
data.email | string |
The email address. |
Live Class
|
data.live class | string |
The live class. |
Message
|
data.message | string |
The message. |
Register for webinar
Register a user for a live webinar.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Webinar ID
|
webinar_id | True | string |
The webinar identifier. |
Name
|
name | True | string |
The name. |
Email
|
True | string |
The email address. |
|
Last Name
|
last_name | string |
The last name. |
|
Address
|
address | string |
The address. |
|
City
|
city | string |
The city. |
|
State
|
state | string |
The state. |
|
Phone
|
phone | string |
The phone number. |
|
Zip Code
|
zip_code | integer |
The zip code. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Response Code
|
response_code | integer |
The response code. |
Message
|
message | string |
The response message. |
Name
|
data.name | string |
The name. |
Email
|
data.email | string |
The email address. |
Live Webinar
|
data.live webinar | string |
The live webinar. |
Message
|
data.message | string |
The message. |
Subscribe to funnel
Subscribe a user to a funnel.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Funnel ID
|
funnel_id | True | string |
The funnel identifier. |
Name
|
name | True | string |
The name. |
Email
|
True | string |
The email address. |
|
Last Name
|
last_name | string |
The last name. |
|
Address
|
address | string |
The address. |
|
City
|
city | string |
The city. |
|
State
|
state | string |
The state. |
|
Phone
|
phone | string |
The phone number. |
|
Zip Code
|
zip_code | integer |
The zip code. |
|
Country
|
country | string |
The country. |
|
GDPR Consent Status
|
gdpr_consent_status | integer |
The GDPR consent status. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Response Code
|
response_code | integer |
The response code. |
Message
|
message | string |
The response message. |
Name
|
data.name | string |
The name. |
Email
|
data.email | string |
The email address. |
Funnel
|
data.funnel | string |
The funnel. |
Unenroll a user
Unenrolls a user from a course.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
User ID
|
user_id | True | string |
The user identifier. |
Course ID
|
course_id | True | string |
The course identifier. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Response Code
|
response_code | integer |
The response code. |
Message
|
message | string |
The response message. |
Message
|
data.message | string |
The message. |
Unregister for class
Unregister a user for a live class.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Live Class ID
|
liveclass_id | True | string |
The live class identifier. |
Email
|
string |
The email. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Response Code
|
response_code | integer |
The response code. |
Message
|
message | string |
The response message. |
Data
|
data | string |
The data. |
Unregister for webinar
Unregister a user for a live webinar.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Webinar ID
|
webinar_id | True | string |
The webinar identifier. |
Email
|
True | string |
The email address. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Response Code
|
response_code | integer |
The response code. |
Message
|
message | string |
The response message. |
Data
|
data | string |
The data. |
Unsubscribe from funnel
Unsubscribes a user from a funnel.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Funnel ID
|
funnel_id | True | string |
The funnel identifier. |
Email
|
string |
The email. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Response Code
|
response_code | integer |
The response code. |
Message
|
message | string |
The response message. |
Data
|
data | string |
The data. |
Update user
Updates a user's information.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
User ID
|
user_id | True | string |
The user identifier. |
First Name
|
first_name | True | string |
The first name. |
Last Name
|
last_name | True | string |
The last name. |
Email
|
True | string |
The email address. |
|
Password
|
password | True | string |
The password. |
Commission
|
commission | True | integer |
The commission. |
Roles
|
roles | True | string |
The roles. |
Address
|
address | string |
The address. |
|
City
|
city | string |
The city. |
|
State
|
state | string |
The state. |
|
Phone
|
phone | string |
The phone number. |
|
Zip Code
|
zip_code | integer |
The zip code. |
|
Country
|
country | string |
The country. |
|
GDPR Consent Status
|
gdpr_consent_status | integer |
The GDPR consent status. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Response Code
|
response_code | integer |
The response code. |
Message
|
message | string |
The response message. |
Message
|
data.message | string |
The message. |