helpjuice.api.settings
Helpjuice Settings API.
https://help.helpjuice.com/en_US/api-v3/api-v3#settings
Module Contents
Classes
Settings resource. |
- class helpjuice.api.settings.Settings
Bases:
helpjuice.api.schema.ResourceSettings resource.
- name
Name of your account.
- Type
str
- subdomain
Name of your account in snake_case.
- Type
str
- top_questions_count
The number of articles that will be shown in your kb.
- Type
int
- internal_kb
Use your kb internally only.
- Type
bool
- expire_password_after_days
Password expiration for new users, number of days.
- Type
int
- contact_us_email
Support Email address.
- Type
str
- contact_us_subject
Contact us emails, subject line.
- Type
str
- contact_us_single_sender
Send all contact us emails asset in contact_us_email field.
- Type
bool
- only_internal_article_requests
Character encoding for requests and reports.
- Type
bool
- created_at
Account creation timestamp.
- Type
str
- get()
Retrieve account settings.
https://help.helpjuice.com/en_US/api-v3/api-v3#retrieve-account-settings
- Returns
Account settings.
- Return type
- put()
Update account settings.
https://help.helpjuice.com/en_US/api-v3/api-v3#update-account-settings
- Returns
Account settings.
- Return type