Configuration
Configure and manage services, integrations, organizations, users, and core platform functionality.
The Concierge configuration API lets you programmatically govern the foundational elements of your Concierge environment. This suite provides administrative control over your services, organizations, user roles, integrations, and communication channels.
Base URL — https://api.zingle.me/v2/services
| Endpoint | Usage | Method |
|---|---|---|
| / | Retrieve a list of services based on your permissions. | GET |
| /{serviceId}/channels | Add a new communication channel to a service. | POST |
| /{serviceId}/features/{featureCode} | Activate or remove specific features for a service. | POST / DELETE |
| /{serviceId}/integrations | Retrieve a list of all active integrations for a service. | GET |
| /{serviceId}/integrations/{integration} | Retrieve, update, or disable a specific integration. | GET / PUT / DELETE |
| /{serviceId}/integrations/{integration}/field-mapping | View, create, update, or delete the data field mappings for a specific integration. | GET / PUT / DELETE |
| /{serviceId}/integrations/mindbody/activation-link | Generate a dedicated activation link for the MindBody integration. | GET |
| /{serviceId}/users | Retrieve a list of all users assigned to a service. | GET |
| /{serviceId}/analytics/sign-url | Securely sign a Mode Analytics URL. | POST |
| /{serviceId}/analytics/report-list | Retrieve a list of available Mode Analytics reports. | GET |
| /{serviceId}/usage | Retrieve the current billing usage for a service. | GET |
| /{serviceId}/calendar/templates/type | Create an event type with a template. | POST |
| /{serviceId}/blocked-channels | Review contact import logs, or block and unblock specific channels. | GET / PUT / DELETE |
| /{serviceId}/contact-fields | List or create custom contact fields. | GET / POST |
| /{serviceId}/contact-fields/{contactFieldId} | Retrieve, update, or delete a specific contact field. | GET / PUT / DELETE |
| /{serviceId}/contacts | Create a new contact. | POST |
| /{serviceId}/contacts/{contactUuid} | Update, retrieve, or delete a specific contact. | PATCH / GET / DELETE |
| /{serviceId}/message-categories | List or create message categories. | GET / POST |
| /{serviceId}/message-categories/{messageCategoryId} | Retrieve, update, or delete a message category. | GET / PUT / DELETE |
| /{serviceId}/segments | List or create dynamic user segments. | GET / POST |
| /{serviceId}/segments/{segmentId} | Retrieve, update, or delete a specific segment. | GET / PUT / DELETE |
| /{serviceId}/tags | List or create custom tags. | GET / POST |
| /{serviceId}/tags/{tagId} | Retrieve, update, or delete a specific tag. | GET / PUT / DELETE |
| /{serviceId}/templates | List or create text templates. | GET / POST |
| /{serviceId}/templates/{templateId} | Retrieve, update, or delete a text template. | GET / PUT / DELETE |
| /{serviceUuid}/users/{userId} | List users or create a new user and define their UI role. | GET / POST |
| /{serviceId}/users/{userId} | Update a service user's details or remove their service role. | PUT / DELETE |
| /{serviceId}/webhooks | List, create, or update all webhooks. | GET / POST / PUT |
| /{serviceId}/webhooks/{webhookId} | Retrieve, update, or delete a specific webhook. | GET / PUT / DELETE |
Base URL — https://api.zingle.me/v2/organizations/{organizationId}
| Endpoint | Usage | Method |
|---|---|---|
| /contact-import-configurations/{integration} | Get, add, update, or enable contact import mapping configurations for an integration. | GET / PUT / POST |
| /services | Retrieve a list of services within an organization. | GET |
| /services/{serviceId} | Add or remove a service from an organization. | POST / DELETE |
| /users | Search for users or add a new user to an organization. | GET / POST |
| /users/{userId} | Update a user's organizational role or remove them from the organization. | PUT / DELETE |
Base URL — https://api.zingle.me/v2/orgs/{organizationId}
| Endpoint | Usage | Method |
|---|---|---|
| /contact-log | Retrieve contact import logs for services within an organization. | GET |
Base URL — https://api.zingle.me/v2/organizations
| Endpoint | Usage | Method |
|---|---|---|
| / | Page through existing organizations or create a new one. | GET / POST |
| /{organizationId} | Retrieve, update, or delete a specific organization. | GET / PUT / DELETE |
Base URL — https://api.zingle.me/v2/service-collections
| Endpoint | Usage | Method |
|---|---|---|
| / | List or create service collections. | GET / POST |
| /all | Retrieve a list of all service collections. | GET |
| /{serviceCollectionId} | Update or delete a service collection. | PUT / DELETE |
| /{serviceCollectionId}/services | List services within a specific collection. | GET |
| /{serviceCollectionId}/services/{serviceId} | Add, update, or remove a service within a collection. | POST / PUT / DELETE |
| /{serviceCollectionId}/fields | Create a new field for a service collection. | POST |
| /{serviceCollectionId}/fields/{fieldId} | Update or delete a field from a service collection. | PUT / DELETE |
Base URL — https://api.zingle.me/v2
| Endpoint | Usage | Method |
|---|---|---|
| /notification/{userId}/preferences | Update a user's desktop, mobile, and email notification preferences. | PUT |
| /phone-numbers/provision | Provision and assign a new phone number. | POST |
| /plans | Retrieve a list of available plans. | GET |
| /calendar/templates | Retrieve a list of all available calendar templates. | GET |
