Admin

class Admin(session_kwargs, client, return_type='raw')

Examples

>>> import civis
>>> client = civis.APIClient()
>>> client.admin.list_announcements(...)

Methods

`delete_announcements`(id)	Delete an announcement
`get_announcements`(id)	Get a particular announcement
`list_announcements`(*[, limit, page_num, ...])	List announcements
`list_organizations`(*[, status, org_type])	List organizations
`patch_announcements`(id, *[, subject, body, ...])	Edit an announcement
`patch_themes`(id, *[, name, ...])	Edit a theme
`post_announcements`(subject, body, *[, ...])	Post an announcement
`post_themes`(name, settings_json, *[, ...])	Create a theme

delete_announcements(id: int)

Delete an announcement

Parameters:

idint: The ID of this announcement

Returns:

None: Response code 204: success

get_announcements(id: int)

Get a particular announcement

Parameters:

idint: The ID of this announcement

Returns:

civis.response.Response

idint
The ID of this announcement
subjectstr
The subject of this announcement.
bodystr
The body of this announcement.
released_atstr (date-time)
The date and time this announcement was released.
created_at : str (date-time)
updated_at : str (date-time)

list_announcements(*, limit: int = None, page_num: int = None, order: str = None, order_dir: str = None, iterator: bool = None)

List announcements

Parameters:

limitint, optional: Number of results to return. Defaults to 10. Maximum allowed is 50.
page_numint, optional: Page number of the results to return. Defaults to the first page, 1.
orderstr, optional: The field on which to order the result set. Defaults to released_at. Must be one of: released_at.
order_dirstr, optional: Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iteratorbool, optional: If True, return a generator to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.

Returns:

civis.response.PaginatedResponse

idint
The ID of this announcement
subjectstr
The subject of this announcement.
bodystr
The body of this announcement.
released_atstr (date-time)
The date and time this announcement was released.
created_at : str (date-time)
updated_at : str (date-time)

list_organizations(*, status: list[str] = None, org_type: list[str] = None)

List organizations

Parameters:

statuslist[str], optional: The status of the organization (active/trial/inactive).
org_typelist[str], optional: The organization type (platform/ads/survey_vendor/other).

Returns:

civis.response.Response

idint
The ID of this organization.
namestr
The name of this organization.
slugstr
The slug of this organization.
account_manager_idint
The user ID of the Account Manager.
cs_specialist_idint
The user ID of the Client Success Specialist.
statusstr
The status of the organization (active/trial/inactive).
org_typestr
The organization type (platform/ads/survey_vendor/other).
custom_brandingstr
The custom branding settings.
contract_sizeint
The monthly contract size.
max_analyst_usersint
The max number of full platform users for the org.
max_report_usersint
The max number of report-only platform users for the org.
verticalstr
The business vertical that the organization belongs to.
cs_metadatastr
Additional metadata about the organization in JSON format.
remove_footer_in_emailsbool
If true, emails sent by platform will not include Civis text.
salesforce_account_idstr
The Salesforce Account ID for this organization.
tableau_site_idstr
The Tableau Site ID for this organization.
fedramp_enabledbool
Flag denoting whether this organization is FedRAMP compliant.
created_by_idint
The ID of the user who created this organization
last_updated_by_idint
The ID of the user who last updated this organization
advanced_settingsdict
- dedicated_dj_pool_enabledbool
  If true, the Organization has a dedicated delayed jobs pool. Defaults to false.
tableau_refresh_historylist[dict]
The number of tableau refreshes used this month.

patch_announcements(id: int, *, subject: str = None, body: str = None, released_at: str = None)

Edit an announcement

Parameters:

idint: The ID of this announcement
subjectstr, optional: The subject of this announcement.
bodystr, optional: The body of this announcement.
released_atstr (date-time), optional: The date and time this announcement was released.

Returns:

civis.response.Response

idint
The ID of this announcement
subjectstr
The subject of this announcement.
bodystr
The body of this announcement.
released_atstr (date-time)
The date and time this announcement was released.
created_at : str (date-time)
updated_at : str (date-time)

patch_themes(id: int, *, name: str = None, organization_ids: list[int] = None, settings_json: str = None, logo_file_id: str = None)

Edit a theme

Parameters:

idint: The ID of this theme.
namestr, optional: The name of this theme.
organization_idslist[int], optional: List of organization ID’s allowed to see this theme.
settings_jsonstr, optional: The JSON-encoded theme configuration.
logo_file_idstr, optional: The ID of the logo image file.

Returns:

civis.response.Response

idint
The ID of this theme.
namestr
The name of this theme.
organization_idslist[int]
List of organization ID’s allowed to use this theme.
settingsstr
The theme configuration object.
logo_filedict
- idint
  The ID of the logo image file.
- download_urlstr
  The URL of the logo image file.
created_at : str (date-time)
updated_at : str (date-time)

post_announcements(subject: str, body: str, *, released_at: str = None)

Post an announcement

Parameters:

subjectstr: The subject of this announcement.
bodystr: The body of this announcement.
released_atstr (date-time), optional: The date and time this announcement was released.

Returns:

civis.response.Response

idint
The ID of this announcement
subjectstr
The subject of this announcement.
bodystr
The body of this announcement.
released_atstr (date-time)
The date and time this announcement was released.
created_at : str (date-time)
updated_at : str (date-time)

post_themes(name: str, settings_json: str, *, organization_ids: list[int] = None, logo_file_id: str = None)

Create a theme

Parameters:

namestr: The name of this theme.
settings_jsonstr: The JSON-encoded theme configuration.
organization_idslist[int], optional: List of organization ID’s allowed to see this theme.
logo_file_idstr, optional: The ID of the logo image file.

Returns:

civis.response.Response

idint
The ID of this theme.
namestr
The name of this theme.
organization_idslist[int]
List of organization ID’s allowed to use this theme.
settingsstr
The theme configuration object.
logo_filedict
- idint
  The ID of the logo image file.
- download_urlstr
  The URL of the logo image file.
created_at : str (date-time)
updated_at : str (date-time)