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 | List the communication channels configured for a service. | GET |
| /{serviceId}/channels/{serviceChannelUuid} | Retrieve a service channel, set its display name, or delete it. | GET / POST / DELETE |
| /{serviceId}/channels/{channelId}/{method} | Block or unblock the inbound direction of an existing channel. | POST |
| /{serviceId}/integrations | Retrieve a list of all active integrations for a service. | GET |
| /{serviceId}/integrations/{integration} | Retrieve, update, enable, or disable a specific integration. | GET / PUT / POST / 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 |
| /{service_uuid}/contacts/ref/{external_id} | Retrieve a contact by its external identifier. | GET |
| /{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} | List, create, update, or delete contact import configurations for an integration. | GET / POST / PUT / DELETE |
| /contact-import-configurations/{integration}/{configUuid} | Retrieve, update, or delete one contact import configuration. | GET / PUT / DELETE |
| /bulk-import/{integration} | Import contacts in bulk for an integration. | POST |
| /bulk-import/{integration}/{configUuid} | Import contacts in bulk using one import configuration. | POST |
| /sftp/ingest | Ingest a contact-import file from SFTP. | POST |
| /sftp/{configUuid}/ingest | Ingest a contact-import file from SFTP using one import configuration. | POST |
| /services | Retrieve a list of services within an organization. | GET |
| /services/{serviceId} | Retrieve, update, assign, or remove a service in an organization. | GET / PUT / POST / DELETE |
| /users | Search for users or add a new user to an organization. | GET / POST |
| /users/{userUuid} | Update a user's organizational role or remove them from the organization. | PUT / DELETE |
| /api-keys | List organization API keys or create one. | GET / POST |
| /api-keys/{tokenUuid} | Revoke an organization API key. | DELETE |
| /inboxes | List inboxes or create an inbox. | GET / POST |
| /inboxes/{organizationInboxUuid} | Retrieve, update, or delete an inbox. | GET / PUT / DELETE |
Base URL — https://api.zingle.me/v2/orgs/{org_uuid}
| 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 |
|---|---|---|
| /{organizationId} | Retrieve or update a specific organization. | GET / PUT |
Base URL — https://api.zingle.me/v2/organizations/inbox
| Endpoint | Usage | Method |
|---|---|---|
| /{organizationInboxUuid}/groups | List groups in an inbox, or create a group. | GET / POST |
| /groups/{groupUuid} | Retrieve, update, or delete an inbox group. | GET / PUT / DELETE |
| /groups/{groupUuid}/userlist | List users assigned to a group's services. | GET |
| /group/{groupUuid}/services | List services in an inbox group, or assign a service. | GET / POST |
| /group/{groupUuid}/services/{serviceUuid} | Retrieve, update, or remove a service assignment in an inbox group. | GET / PUT / DELETE |
| /{organizationInboxUuid}/invite | Invite a user and assign inbox groups. | POST |
| /{organizationInboxUuid}/invite/{userId} | Update an existing user and assign inbox groups. | PUT |
| /{organizationInboxUuid}/team-members | List users assigned to an inbox. | GET |
| /{organizationInboxUuid}/delete/{userId} | Remove a user from an inbox. | DELETE |
| /{organizationInboxUuid}/groupuserroles/list | List group roles for an inbox. | GET |
| /{organizationInboxUuid}/groupuserroles | List your group roles for an inbox. | GET |
| /{organizationInboxUuid}/groupuserroles/assign | Assign inbox groups and roles to a user. | POST |
| /{organizationInboxUuid}/groupuserroles/{userId} | Replace or remove a user's group roles in an inbox. | PUT / DELETE |
| /{organizationInboxUuid}/user-inbox-groups | List the groups in an inbox. | GET |
Base URL — https://api.zingle.me/v2/service-collections
| Endpoint | Usage | Method |
|---|---|---|
| / | List the service collections that contain a service you can access. | GET |
Base URL — https://api.zingle.me/v2
| Endpoint | Usage | Method |
|---|---|---|
| /notification/{userId}/preferences | Update a user's desktop, mobile, and email notification preferences. | PUT |
| /contacts/{contactUuid}/channel/{channel} | Update the value or country of a contact channel. | PUT |
| /organizations/{organizationUuid}/user-inboxes | List the inboxes in which you have a role. | GET |
| /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 |
