General settings
Organization details and lookup lists: categories, tags, industries, ethnicities, identities, communication modes, consumer types, relationships, statuses, time zones, travel radius.
77 operations in 13 areas · Download the OpenAPI document
Categories 7
- GETRetrieve all Categories or filter by tenant ID
/categories - POSTCreate a new category
/categories - PUTUpdate an category
/categories/{category} - PATCHUpdate an category
/categories/{category} - DELETEDelete a category by id alone (always 422)
/categories/{category} - DELETEDelete category
/categories/{id}/{label} - GETRetrieve a list of categories and tags
/settings/categories-tags
Communication modes 7
- GETRetrieve all communication modes or filter by tenant ID
/communication-modes - POSTCreate a new communication mode
/communication-modes - GETRetrieve a single communication mode (not implemented)
/communication-modes/{communication_mode} - PUTUpdate an existing communication mode
/communication-modes/{communication_mode} - PATCHUpdate an existing communication mode
/communication-modes/{communication_mode} - DELETEDelete a communication mode by id alone (always 422)
/communication-modes/{communication_mode} - DELETEDelete a communication mode
/communication-modes/{id}/{label}
Consumer types 7
- GETRetrieve all consumer types or filter by tenant ID
/consumer-types - POSTCreate a new consumer type
/consumer-types - GETRetrieve a single consumer type (not implemented)
/consumer-types/{consumer_type} - PUTUpdate an existing consumer type
/consumer-types/{consumer_type} - PATCHUpdate an existing consumer type
/consumer-types/{consumer_type} - DELETEDelete a consumer type by id alone (always 422)
/consumer-types/{consumer_type} - DELETEDelete a consumer type
/consumer-types/{id}/{label}
Industries 7
- GETRetrieve all industries or filter by tenant ID
/industries - POSTCreate a new industry
/industries - DELETEDelete an industry
/industries/{id}/{label} - GETRetrieve a single industry (not implemented)
/industries/{industry} - PUTUpdate an industry
/industries/{industry} - PATCHUpdate an industry
/industries/{industry} - DELETEDelete an industry by id alone (always 422)
/industries/{industry}
Statuses 7
- GETRetrieve all statuses or filter by tenant ID
/status - POSTCreate a new status
/status - DELETEDelete a status
/status/{id}/{label} - GETRetrieve a single status (not implemented)
/status/{status} - PUTUpdate an existing status
/status/{status} - PATCHUpdate an existing status
/status/{status} - DELETEDelete a status by id alone (always 422)
/status/{status}
Ethnicities 6
- GETRetrieve paginated ethnicities with optional filters
/ethnicities - POSTCreate one or more ethnicities
/ethnicities - GETRetrieve an ethnicity by ID
/ethnicities/{ethnicity} - PUTRename a custom ethnicity
/ethnicities/{ethnicity} - PATCHRename a custom ethnicity
/ethnicities/{ethnicity} - DELETEDelete a custom ethnicity
/ethnicities/{ethnicity}
Identities 6
- GETRetrieve paginated identities with optional filters
/identities - POSTCreate one or more identities
/identities - GETRetrieve an identity by ID
/identities/{identity} - PUTRename a custom identity
/identities/{identity} - PATCHRename a custom identity
/identities/{identity} - DELETEDelete a custom identity
/identities/{identity}
Relationships 6
- GETRetrieve paginated relationship with optional filters
/relationships - POSTCreate a new relationship
/relationships - GETRetrieve a relationship by ID
/relationships/{relationship} - PUTUpdate an existing relationship
/relationships/{relationship} - PATCHUpdate an existing relationship
/relationships/{relationship} - DELETEDelete a relationship
/relationships/{relationship}
Tags 6
Travel radius 6
- GETRetrieve all travel radii
/travel-radius - POSTCreate a new travel radius
/travel-radius - GETRetrieve a travel radius by ID
/travel-radius/{travel_radiu} - PUTUpdate a travel radius
/travel-radius/{travel_radiu} - PATCHUpdate a travel radius
/travel-radius/{travel_radiu} - DELETEDelete a travel radius
/travel-radius/{travel_radiu}
Requirements and preferences 5
- GETRetrieve a list of requirement preferences
/requirement-preferences - DELETEDelete a Requirement and Preference entry
/settings/delete-requirements/{id} - GETList the organization's requirements and preferences
/settings/list-requirements - GETGet paginated client requirements
/settings/portal/client-portal/requirements - PUTUpdate a specific field in requirement and preferences
/settings/update-requirement-field/{id}