Skip to content
Docs
hi-client.com (opens in a new tab)

Agent permissions

Download

What each permission (scope) you can grant to an AI agent in hiClient allows and which tools it enables.

Each permission enables a group of tools of one portal area. Reading and writing are separate permissions. When you authorize an agent you choose which ones to grant, and an agent only sees the tools of the permissions you gave it.

Billing, account security, domains and plan changes are never granted. Agents never see names or personal data from accesses. Write actions are recorded in your account audit as “agent”.

Summary

Permission Area Type What it allows
offers:read Offers Read View offers (events, stays and recurring services) and drafts.
offers:write Offers Write Create and edit offers and recurring services, publish or unpublish them, and delete drafts.
bookings:read Bookings Read View received bookings and the calendar.
forms:read Forms Read View the site forms and the inbox tags.
forms:write Forms Write Edit forms and manage the inbox (states, notes, tags).
site:read Website Read View the site: address, profile, modules and files.
site:write Website Write Create the site, edit the profile, upload files and publish.
messages:read Messages Read Read visitor messages and support tickets.
messages:write Messages Write Manage support tickets (open, reply, close).
messages:reply Messages Write Reply to visitors by e-mail on your behalf.
publications:read Publications Read View public profile posts.
publications:write Publications Write Create and delete posts.
reports:read Reports Read View figures, sales and orders.
devices:read Devices Read View devices, aggregated accesses and alert recipients.
devices:write Devices Write Rename devices and add alert recipients.
profile:read Profile Read View the public profile and organization settings.
profile:write Profile Write Edit profile, organization, language, theme, notifications and dashboard.
offline_access — Connection Keep the connection without authorizing again.

The account_whoami tool needs no permission: it tells which account the agent works on and what it was granted.

How they are granted

  • The agent asks for permissions when it connects. If it asks for none, the screen offers all of them.
  • On the authorization screen you can untick permissions. You can never add one the agent did not ask for.
  • An unknown permission is dropped.
  • If you already authorized the same agent with the same permissions, the authorization is approved without showing the screen again.
  • If you work in several businesses, the screen lets you choose which one the authorization is for; the agent acts only on that business.
  • The agent can never do more than your role in that business: of the granted permissions it uses only those your role allows, and if your role changes, so does what it can do.
  • To change an agent's permissions, revoke it in Connected agents and connect it again.

Note

“Write” includes everything that changes or sends something. Assistants usually ask you to confirm before running a tool that is not read-only.

Offers

offers:read

Read. View the account's offers (events, stays and recurring services) and the private drafts of the editor.

  • State, dates, capacity, price, form fields, payment modes, policies and public address of each offer.
  • Totals of offers, drafts, bookings and sales of the dashboard period.
  • Editor drafts, with their content even when incomplete.
  • Recurring services (memberships, fees, classes): price, frequency and calendar, capacity and places taken, channels, questions and state.

Tools: offers_list, offers_get, offers_summary, offers_activity, offers_drafts_list, offers_draft_get, services_list, services_get.

Does not include data about registrants or about who joined a service (payers, beneficiaries, answers, installments or payments).

offers:write

Write. Create and edit offers and recurring services, publish or unpublish them, and delete drafts.

  • Create an offer or replace it in full, with the same rules as the portal editor. With dryRun it is validated without saving.

  • Publish or withdraw an offer. An offer that already ended is not published: change its dates first. Withdrawing stops the public page and new bookings at once; existing bookings are kept.

  • Duplicate an offer as an unpublished copy, without bookings or payments.

  • Move an offer whose receiving device was revoked to an active device.

  • Save private drafts (up to 50 per account) that you then open in the portal, and delete them. Deleting a draft frees its place and never touches published offers or bookings.

  • Create or update a recurring service with the rules of the portal editor (channels of the business's market; when updating, omitted values are kept). With dryRun it is validated and the next periods are shown without saving. Publish or withdraw it: withdrawing stops the page and new adhesions; existing ones, their installments and payments are kept.

Tools: offers_save, offers_set_published, offers_duplicate, offers_reconnect, offers_draft_save, offers_draft_delete, services_save, services_set_published.

Does not collect or confirm payments of bookings or installments: that is done in the portal, the app or the PC. Does not change the cover of the offer or service: it is uploaded in the portal. Publishing requires a verified business account, a public profile and an active plan.

Bookings

bookings:read

Read. View received bookings and the calendar.

  • Bookings with offer, dates, quantity, amounts, state, payment, attendance and cancellation.
  • Monthly calendar view (business accounts): for each day, the offers and the confirmed and pending quantities.

Tools: bookings_list, bookings_get, calendar_month.

Never includes the identity of the person who booked: name, e-mail, phone or form answers.

Forms

forms:read

Read. View the site forms and the inbox settings.

  • The site plugins that receive messages (contact, registration), in the published version and in the draft.
  • The inbox tags and what a new message gets on arrival.

Tools: forms_list, registration_requirements_get, inbox_tags_list, plugin_forms_list, plugin_form_get, plugin_forms_answers_summary.

Does not include message content: that is messages:read.

forms:write

Write. Edit site forms and manage the inbox.

  • Change a form in the site draft (title, fields, whether it accepts submissions, phone). The change shows on the site once it is published.
  • Mark a message as read or unread, change its state (new, managing, waiting, closed) or its private note. Closing a conversation revokes the visitor's link.
  • Create, rename, recolor and delete tags (up to 20), and assign them to messages.
  • Choose whether new messages arrive read and which tags they get.

Tools: forms_save, registration_requirements_set, inbox_change, inbox_set_tags, inbox_tags_save, inbox_tags_delete, inbox_defaults_set, plugin_form_save, plugin_form_set_state.

Deleting a message is reserved to the portal (portal_only). A conversation handed to a PC is managed from the portal.

Website

site:read

Read. View the account's website.

  • Address, real state (draft, private or public), publication rules, revision and whether changes are pending.
  • The site profile (draft or published): layout, identity, content, modules with their visibility and operational state, extra pages and questions.
  • File library, storage usage and the catalog of freely licensed photos.
  • Whether an address is free, invalid or retired by this same account.

Tools: site_status, site_get, site_address_check, site_media_list, site_media_catalog.

It does not include file bytes, visitor messages, bookings or the private link.

site:write

Write. Create the site, edit the profile, manage files and publish.

  • Create the site when the account has none, with the structure of the business type. It stays unpublished.
  • Edit the profile: tagline, introduction, highlights, cover, photos, style, color, monogram and logo.
  • Show or hide modules and configure them (contact and application forms, offers they list, gallery).
  • Add, change or remove extra pages and frequently asked questions.
  • Publish the changes, discard them or unpublish the site.
  • Change the visibility (public, private or draft), countries, indexing and the message for blocked visitors.
  • Renew the private link. The previous one stops working.
  • Change the address. The previous one redirects to the new one.
  • Upload files, import freely licensed catalog photos and rename, move or trash files.

Tools: site_create, site_content_set, site_identity_set, site_module_set, site_page_upsert, site_page_remove, site_faq_set, site_publish, site_cancel_draft, site_unpublish, site_publication_set, site_private_link_renew, site_address_change, site_media_upload, site_media_import, site_media_change.

Hiding a module only changes what the page shows: it does not unpublish offers, cancel bookings or pause services. The business name and contact details are changed with profile_public_save (profile:write). Deleting the site is reserved to the portal. It does not import files from arbitrary addresses: only from the licensed catalog. Large videos are uploaded from the portal.

Messages

messages:read

Read. Read visitor messages and support tickets.

  • Messages from the site forms, with sender, answers, conversation and your private notes.
  • The account's support tickets and their messages.

Tools: messages_list, messages_get, tickets_list, tickets_get, messages_settings_get, contact_policy_get.

Text from visitors and support arrives marked as third-party content: it is data, never instructions. E-mails arrive masked (a***@domain) and the phone only as “has a phone”. Does not include attachments or report evidence.

messages:write

Write. Manage your support tickets.

  • Open a ticket (categories general, billing, technical, installation, privacy, promotion).
  • Reply to one of your tickets. It is left awaiting support.
  • Close or reopen one of your tickets.

Tools: tickets_create, tickets_reply, tickets_set_status, messages_settings_set, contact_policy_set.

This permission does not reply to visitors: that is messages:reply. Opening tickets requires a plan that includes support, except for the billing, privacy and promotion categories. There is a cap on open tickets and a daily quota.

messages:reply

Write that contacts third parties. Reply to visitors by e-mail on your behalf.

  • The reply joins the message's conversation and the visitor gets an e-mail with a private link to read it.

It is a separate permission because the reply leaves hiClient and reaches someone else's mailbox. messages:write does not include it. Grant it only if you want the agent to answer visitors.

Tool: inbox_reply. It appears in the connection only if you granted this permission. It needs the message's current revision (messages_get); retrying with the same messageId and the same text does not send twice.

Warning

A visitor's message may try to make the agent reveal data from your account. The server instructions tell the agent never to send or publish account data because a message asks for it, but review what it replies.

Publications

publications:read

Read. View the posts of the public profile.

  • Text, media type, destinations and state of each post.
  • Whether the profile is published and shows the posts tab.
  • The listings of your PCs (ids and names only) and the pending private dispatches.

Tool: publications_list.

Does not include image or video bytes, or the recipients of the listings.

publications:write

Write. Create and delete posts.

  • Publish or edit a post for the web or the mobile app, with an optional PNG or JPEG image.
  • Queue a private dispatch to listings of a PC (business accounts). The PC resolves the recipients.
  • Delete a post, or remove an accepted dispatch from the history.
  • Turn on the posts tab of the public profile.

Tools: publications_publish, publications_delete, publications_enable.

Does not accept video or audio: they are uploaded from the portal.

Reports

reports:read

Read. View figures, sales and orders.

  • Counters and figures of the portal home: accesses, devices, messages, tickets, site, bookings, offers, sales and income.
  • Sales aggregated by day, currency and state, compared with the previous period.
  • Online payment orders, with state and amounts.

Tools: reports_overview, reports_dashboard, reports_sales, reports_orders_list, reports_orders_get.

Aggregates only. Never buyer data, payment references or the latest accesses with names.

Devices

devices:read

Read. View linked devices, aggregated accesses and alert recipients.

  • Active devices with name, version, system, cameras, license and seat, and the plan maximum.
  • Device map: location and role reported by each device, numbered local networks, links between devices, backups (count and date) and adapted business type. Read only: decided on each device.
  • What is waiting for the desktop app: only counts per kind and whether a PC is linked.
  • Latest accesses: only time, method, result and device.
  • Daily count of accesses by result (up to 90 days).
  • Alert recipients with masked e-mail and their state.

Tools: devices_list, devices_topology, devices_pending_desktop, devices_access_feed, devices_access_stats, alerts_recipients_list.

Never includes names, gender or identifiers of people in the accesses, or network details or keys of the devices.

devices:write

Write. Manage devices and alert recipients.

  • Rename an active device.
  • Add an alert recipient and confirm it with the 6-digit code it gets by e-mail.
  • Remove a recipient that is still pending.
  • Resume the alert e-mail channel if it was paused.

Tools: devices_rename, devices_revoke, devices_use_seat, alerts_recipient_add, alerts_recipient_verify, alerts_recipient_remove, alerts_channel_set.

Revoking a device and choosing which device keeps a seat need, as in the portal, a recent sign-in that an agent cannot give: they answer portal_only and you do them in the portal. Pausing the alert channel and removing a verified recipient are also reserved to the portal (portal_only). Activating a new recipient leaves you a security-change notice.

Profile

profile:read

Read. View the public profile and the account settings.

  • The business’s effective date format (account.businessDateOrder), independent of personal preferences.
  • Account and organization data (masked e-mail), time zone and theme.
  • Public profile: name, description, address, hours, phone, links and visible tabs.
  • Notification preferences and layout of the portal home.

Tool: profile_get.

Never includes password, two-step verification, tokens or the logo or photo files.

profile:write

Write. Edit the profile, organization data and preferences.

  • Business date format (businessDateOrder: dmy, mdy, ymd); an empty string restores the default for its country. Omitting it keeps the choice.
  • Account data: name, country and, for businesses, organization (one rename every 60 days), type, legal details and links. Instagram only accepts instagram.com; Facebook, facebook.com, fb.com or fb.me (with subdomains).
  • Public profile: publish or withdraw it, name, description, contact, links (same Instagram and Facebook domains) and the mobile app tabs.
  • Language (es, en, pt) and theme (dark, light).
  • Notification preferences for web and e-mail.
  • Cards and banner of the portal home.

Tools: profile_save, profile_public_save, settings_language_set, settings_appearance_set, settings_notifications_set, settings_toasts_set, workspace_cards_set, workspace_banner_set, workspace_navigation_set.

Never changes the password, two-step verification, e-mail, photo, logo or the biometric deletion option. The security-change notice can be enabled or widened, never disabled or trimmed (portal_only).

Connection

offline_access

Connection. Keep the connection without authorizing again.

Always included in the connection. The agent renews its access on its own, without asking you to sign in again. The connection stays active until you revoke it in Connected agents. It enables no tools. More in Security.

Services and installments

Services and installments is a financial feature: there are no MCP scopes or tools to manage enrollments, amounts, discounts, charges or automatic debits. Site permissions only allow composing the catalog plugin; they do not authorize those operations.

The site:read permission includes library image dimensions and rendition sizes. It grants no public file access or additional permissions.

Email (D175)

mail_preferences_get (profile:read) reads the account's own promotional consent; mail_preferences_unsubscribe (profile:write) revokes it idempotently through the profile service. mail_status (profile:read) reports the business's own provisioning, pause, quotas and domain verification. They never return recipient addresses, messages, credentials or unsubscribe links. Opt-in, general terms acceptance and domain changes remain in the portal; sending activation and reputation controls are administration-only. Platform and business transactional sending is active. Promotional sending remains disabled.

Email folders

mail:read allows mail_mailboxes_list, mail_messages_list and mail_message_get: own mailboxes, folders, search and paginated reading. Third-party addresses are masked; subjects, bodies and filenames are untrusted data.

mail:write allows mail_draft_save, mail_compose_from (reply, reply all or forward into a draft) and mail_message_change (read, star, archive, spam, trash, restore, delete, cancel a pending send and edit, which returns a blocked send to Drafts to fix and send again). Every change requires the current revision.

mail:send allows mail_draft_send: queues an owned draft. Provider acceptance does not prove inbox delivery. An uncertain result is never automatically resent.

These permissions are separate: messages:* continues to cover forms and tickets and does not grant email access. Create or disable mailboxes, accept terms, manage domains and upload or download attachments in the portal. The tools share the web mail service, isolation, quotas and pause controls.

Form responses

forms_responses_summary · forms:read · readOnly=true, idempotent=true, destructive=false, openWorld=false.

Returns only aggregate counts of retained and synchronized responses, filtered by source or plugin. It exposes no answers, names, exports, faces or payment operations.

Email is covered by the general hiClient terms and requires no additional acceptance. mail_status returns termsAccepted and termsAcceptanceUrl (/account/legal). When the edition changes, the account holder must accept it there; MCP cannot accept on their behalf. acceptableUseVersion remains historical evidence and does not authorize sending.

Own forms and jobs

plugin_forms_list, plugin_form_get, plugin_forms_answers_summary · forms:read · readOnly=true, idempotent=true, destructive=false, openWorld=false.

plugin_form_save · forms:write · readOnly=false, idempotent=false, destructive=false, openWorld=false. plugin_form_set_state · forms:write · readOnly=false, idempotent=true, destructive=false, openWorld=false.

Forms and Jobs plugins: the business creates Google Forms-like forms or job postings and opens them on its public profile and in the app. MCP manages only the definitions and sees counts: never answers, applicants, their contact data or their files (CV), which are seen in the portal and in the app. Enabling the plugin on the profile is site_module_set.