Preference categories mAPI reference
Complete reference documentation for the Preference categories resource.
Preference categories
#Preference categories are named groupings in your project's catalog that you can use to organize preferences. Preference categories are project-scoped and are not tied to an environment.
List preference categories
#Returns all preference categories in the project's catalog, ordered by name. Preference categories are project-scoped and not tied to an environment.
Endpoint
Returns
A list of preference categories in the project's catalog.
Preference categories, ordered by name.
The timestamp of when the preference category was archived.
The timestamp of when the preference category was created.
The unique name of the preference category within a project.
The timestamp of when the preference category was last updated.
Delete a preference category
#Archives a preference category by name.
Endpoint
Path parameters
The name of the preference category to delete.
Returns
Upsert a preference category
#Creates a preference category by name. If a non-archived category with the same name already exists, returns the existing category.
Endpoint
Path parameters
The name of the preference category to upsert.
Returns
Wraps the PreferenceCategory response under the preference_category key.
A named preference category in a project's catalog.
The timestamp of when the preference category was archived.
The timestamp of when the preference category was created.
The unique name of the preference category within a project.
The timestamp of when the preference category was last updated.
PreferenceCategory
#A named preference category in a project's catalog.
Attributes
The timestamp of when the preference category was archived.
The timestamp of when the preference category was created.
The unique name of the preference category within a project.
The timestamp of when the preference category was last updated.