Manage user profiles including account information, subscription details, and team associations.
All requests use a single endpoint: POST https://api.helpgenie.ai/v1 with resource: "profiles".
Access control
Action
Regular user
Admin
all
No
Yes
list
No
Yes
get
Own profile only
Any profile
create
No
Yes
update
Own profile only
Any profile
delete
Own profile only
Any profile
check-timezone
Yes (own profile)
Yes
generate-sso-token
Yes (own session)
Yes (+ impersonation)
generate-sync-consent-link
Yes (own email)
Yes (any email)
usage-summary
Yes (own profile)
Yes
list-auth-sessions
Yes (own signed-in session only)
No impersonation
revoke-auth-session
Yes (own signed-in session only)
No impersonation
Admin endpoints require a role starting with internal_ (e.g. internal_admin). Non-admin users attempting admin-only actions receive a 403 Forbidden response.
role values
Value
Description
"business"
Business owner — can create and manage agents, view leads, and access all standard features
"consumer"
End user — can talk to agents and interact with consumer-facing features
"internal_admin"
Full platform access — can manage all users, agents, marketplace listings, and system settings
Profile mutations (create, update, delete) are automatically logged to the activities table as user_action events. Update actions include the list of changed fields in the activity metadata.
List all profiles (admin)
Retrieves all profiles with complete joined data including subscriptions, call purchases, and phone subscriptions.
string
required
Must be "profiles"
string
required
Must be "all"
object
Show properties
number
Results per page. Range: 1-100. Default: 50.
number
Pagination offset. Default: 0.
object
Show properties
string
Search in full_name or email.
string
Filter by role (exact match): "business", "consumer" or "internal_admin".
number
Filter by team ID.
boolean
Filter profiles with active subscriptions.
boolean
When true, return only accounts with unbilled purchased phone numbers — a paying, non-admin account whose number has no phone subscription, usually because it was added during a trial.
string
Column to sort by. One of: "created_at" (default), "email", "full_name".
string
Sort direction. "asc" or "desc". Default: "desc".
Response
boolean
object
Show properties
object[]
Array of full profile objects with joined relations. See profile object. Each profile also carries unbilled_phone_numbers — the account’s purchased numbers with no phone subscription (empty when none). Each entry has the same shape as a numbers item from billing → phones, with billing always "unbilled". Each profile also carries genie_counts — { active, eligible }, where active is the number of the account’s genies that are switched on and eligible excludes genies deactivated on purpose. Compare them with the account’s seats to spot a mismatch.
number
number
number
number
Number of accounts with unbilled purchased phone numbers, ignoring the other filters.
Retrieves a single profile with complete details including subscriptions and team data. Users can only access their own profile; admins can access any profile.
string
required
Must be "profiles"
string
required
Must be "get"
string
required
The profile ID (user UUID).
Response
boolean
object
Show properties
object
Full profile object with all joined relations. See profile object.
Creates a new user profile. There are two ways to call it:
Attach to an existing account — send id set to the UUID of an existing sign-in account.
Create the account too — send email with password, or email with send_welcome_email: true (no id needed). The sign-in account is created first with its email already confirmed, and its UUID becomes the profile id. Without a password, the account gets a random one that the user replaces through the set-password link in the welcome email. Fields you leave out keep the defaults the new account was given; they are not reset to empty. If saving the profile fails, the new sign-in account is removed again.
No email is sent to the user unless send_welcome_email is true, so accounts can be set up quietly.Any field not listed below is ignored.
string
required
Must be "profiles"
string
required
Must be "create"
object
required
Show properties
string
UUID of an existing sign-in account to attach the profile to. Required unless email is sent with password or send_welcome_email: true.
string
Profile email. Sent together with password or send_welcome_email: true, it also creates the sign-in account. When present, the new profile is also added to the customer contact list (best-effort — a failure there does not fail the request).
string
Sent together with email, creates the sign-in account first. The email is marked as confirmed.
boolean
default:"false"
With email, sends the welcome email with a set-password link once the account is created. Without password, the account is created with a random password the user replaces via that link. Leave false to create the account without emailing the user.
Two-letter ISO 3166-1 country code, e.g. "NZ". A full country name (e.g. "New Zealand") is converted to its code and, when no country_name is sent, kept as country_name. A name that cannot be matched leaves country empty.
string
Full country name. When country is not sent, country is filled from this name.
string
string
string
string
string
string
string
One of USD, NZD, AUD, GBP, EUR (any case). An unsupported value is ignored, the rest of the profile still saves, and the response includes a warnings entry.
string
string
Overwritten with the customer contact ID when the contact sync succeeds.
number
string
boolean
string
Admin only. Records the activity log entry against this user. It does not change the created profile’s id.
Response (status 201)
boolean
object
Show properties
object
The created profile with joined data. See Profile object.
object
Present only when the sign-in account was created by this request. The new account record, including its id and email.
boolean
Present only when the sign-in account was created with send_welcome_email: true. false if the welcome email could not be sent; the profile is still created.
string[]
Present only when a field was ignored, e.g. an unsupported billing_currency.
// Attach a profile to an existing accountconst response = await ApiService.invoke<{ profile: Profile }>( { resource: "profiles", action: "create", data: { id: "auth-user-uuid-here", full_name: "Jane Smith", email: "jane@example.com", role: "business", }, }, 201);// Create the sign-in account and profile togetherconst created = await ApiService.invoke<{ profile: Profile; user: { id: string; email: string } }>( { resource: "profiles", action: "create", data: { email: "jane@example.com", password: "a-strong-password", full_name: "Jane Smith", }, }, 201);// Create the account and let the user set their own password from the welcome emailconst invited = await ApiService.invoke<{ profile: Profile; user: { id: string; email: string }; welcome_email_sent: boolean;}>( { resource: "profiles", action: "create", data: { email: "jane@example.com", full_name: "Jane Smith", send_welcome_email: true, }, }, 201);
Updates an existing profile. Users can only update their own profile; admins can update any profile. This is a partial update — only include the fields you want to change.
string
required
Must be "profiles"
string
required
Must be "update"
string
required
The profile ID (user UUID).
object
required
Any key not listed below is rejected with a validation error. country, country_name and billing_currency are normalized the same way as on create.
Show properties
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
number
Number of connected social accounts.
string
Admin only.
string
Admin only. Only admins can change a profile’s role after sign-up.
number
Admin only.
string
Admin only.
string
Admin only.
string
Admin only.
string
Admin only.
boolean
Admin only.
string
Admin only. Sets a new sign-in password. Minimum 6 characters.
Auth-context keys such as adminMode and impersonatedUserId are also rejected. Because admin API keys add adminMode to data automatically, update currently fails when called with an admin API key.
Response
boolean
object
Show properties
object
The updated profile with joined data.
string[]
Present only when a field was ignored, e.g. an unsupported billing_currency.
Permanently deletes a profile. Users can only delete their own profile; admins can delete any profile.
string
required
Must be "profiles"
string
required
Must be "delete"
string
required
The profile ID (user UUID).
Response
boolean
object
Show properties
boolean
string
This permanently deletes the profile record, the user’s sign-in account, and cancels any active subscriptions.
Before the profile is deleted, the mailbox of every genie the user owns is permanently removed. The profile is kept in place, and the request returns an INTERNAL_ERROR, when:
one or more mailboxes can’t be removed — the error names the affected genies. Try again.
the account has too many genies to clear in one call — the error reports how many mailboxes were removed. Call delete again to continue; each call picks up where the last one stopped.
Checks the authenticated user’s profile for a timezone value. If the timezone is not set, auto-detects it from the server and saves it to the profile. No-op if timezone is already set.
Remembers the authenticated user’s Conversations inbox filters. The saved filters are replaced as a whole — any field you leave out is stored as null. Malformed or unknown values are stored as null (meaning “all”) rather than rejected, so a bad value never blocks the save.
string
required
Must be "profiles"
string
required
Must be "save-inbox-filters"
object
required
Show properties
string | null
Selected genie UUID. null for all genies.
string | null
Selected channel. One of "phone", "web", "link", "app", "email", "meeting", "slack", "teams". null for all channels.
string | null
Selected saved inbox view UUID. null for none.
string | null
Relative time range: {value}{unit} where unit is h (hours), d (days) or m (minutes), for example "30d", or "all".
string | null
Selected inbox queue: "attention", "mine" or "handled". null for all.
Response
boolean
object
Show properties
object
The filters as stored, after invalid values were replaced with null.
Signs out one of the authenticated user’s other sign-ins. The current session cannot be revoked this way; sign out instead.
Sign-ins can only be revoked from the user’s own signed-in browser session. API keys, service calls and admin impersonation receive 403 Forbidden.
The revoked device can no longer renew its sign-in, but the access token it already holds stays valid until it expires (about an hour).
string
required
Must be "profiles"
string
required
Must be "revoke-auth-session"
object
required
Show properties
string
required
Session UUID from list-auth-sessions. Must not be the current session.
Response
boolean
object
Show properties
boolean
Returns VALIDATION_ERROR when sessionId is not a valid UUID or is the current session, and NOT_FOUND when the session does not exist or belongs to someone else.
The full profile object returned by all, get, create, and update actions.
Core fields
string
User UUID.
string | null
string | null
string | null
string | null
Contact information
string | null
string | null
Address
string | null
string | null
string | null
string | null
string | null
string | null
string | null
Company
string | null
string | null
Preferences
string | null
string | null
string | null
string | null
External IDs
string | null
string | null
Marketplace
string | null
boolean | null
Team
number | null
object | null
Show properties
number
string
string
string
string
Subscription
object | null
Show properties
number
string | null
string | null
string | null
number | null
number | null
string | null
string | null
string
Call purchases
object[]
Show properties
number
number | null
string | null
string | null
string
Phone subscriptions
object[]
Show properties
string
string
string
string
string
string
Timestamps
string
string
Generate SSO token
Generates a signed, time-limited SSO token for the authenticated user. The token is used to authenticate the user into connected suite applications without a separate login.When impersonation parameters are provided, the token encodes the target user’s identity alongside the admin’s, allowing the receiving application to establish an impersonated session.
string
required
Must be "profiles"
string
required
Must be "generate-sso-token"
object
Show properties
string
The user ID of the account to impersonate. Must be supplied together with adminUserId. Both fields must be present for impersonation fields to be embedded; supplying only one has no effect.
string
The admin user’s own ID. Must be supplied together with impersonatedUserId.
Response
boolean
object
Show properties
string
A signed token string in the format email={email}&ts={unix_timestamp}[&imp_uid={id}&admin_uid={id}]&sig={hmac_hex}. Pass this value to the target suite application to authenticate the session.
Generates a signed, time-limited URL that redirects the user through an OAuth consent flow to authorise a third-party integration. The link is valid for a short window and is tied to the user’s email address.Regular users can only generate a link for their own email. Admins can generate a link for any user’s email.
string
required
Must be "profiles"
string
required
Must be "generate-sync-consent-link"
object
required
Show properties
string
required
The email address of the user to generate the link for. Must match the authenticated user’s email unless the caller is an admin.
string
required
The integration to connect. Must be one of: "airtable", "anthropic", "asana", "github-app", "google-calendar", "google-sheet", "hubspot", "simpro", "slack", "supabase", "xero".
Response
boolean
object
Show properties
string
A signed consent URL. Redirect the user to this URL to complete the integration authorisation flow. The URL includes HMAC-verified query parameters (email, ts, sig, connection) and is time-limited.
const response = await ApiService.invoke<{ url: string }>({ resource: "profiles", action: "generate-sync-consent-link", data: { email: "user@example.com", connection: "slack", },});// Redirect the user to response?.url to complete authorisationconst consentUrl = response?.url;
Returns a usage summary for the profile (calls, leads, conversations, etc.).
string
required
usage-summary
string
Profile UUID. Defaults to the authenticated user. Admins may pass any profile ID.
Activity logging
Profile mutations are logged to the activities table:
Action
Activity type
Action logged
Create
user_action
profile_created
Update
user_action
profile_updated (includes updated_fields in metadata)
Delete
user_action
profile_deleted
Error responses
Status
Code
Description
400
VALIDATION_ERROR
Profile ID not provided
401
UNAUTHORIZED
Invalid or missing authentication token
403
FORBIDDEN
Non-admin accessing admin-only action, or user accessing another user’s profile
404
NOT_FOUND
Profile does not exist
500
INTERNAL_ERROR
Database operation failed
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Help Genie","description":"API documentation for the Help Genie voice AI platform","colors":{"primary":"#4E9CFF","light":"#7BB8FF","dark":"#2B7FE8"},"logo":{"light":"https://mintcdn.com/helpgenie/a134Jyg1BOpqw0vP/logo/light.png?fit=max\u0026auto=format\u0026n=a134Jyg1BOpqw0vP\u0026q=85\u0026s=f29d097a201254a8a750843d0d692c50","dark":"https://mintcdn.com/helpgenie/a134Jyg1BOpqw0vP/logo/dark.png?fit=max\u0026auto=format\u0026n=a134Jyg1BOpqw0vP\u0026q=85\u0026s=f00cbee677f1f3a3f46d463cb7cbad38","href":"https://helpgenie.ai"},"favicon":"https://mintcdn.com/helpgenie/17V8AwVjtycIuhCm/favicon.svg?fit=max\u0026auto=format\u0026n=17V8AwVjtycIuhCm\u0026q=85\u0026s=8a7865e1c10e3dacc378789f70f5ef6e","navbar":{"links":[{"href":"mailto:support@helpgenie.ai","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://helpgenie.ai/dashboard"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/helpgenie"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Help Genie Voice","icon":"microphone","href":"https://helpgenie.ai"},{"anchor":"Help Genie Mail","icon":"envelope","href":"https://mail.helpgenie.ai"},{"anchor":"Help Genie Outbound","icon":"phone","href":"https://outbound.helpgenie.ai"},{"anchor":"Help Genie Sync","icon":"arrows-rotate","href":"https://sync.helpgenie.ai"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"helpgenie","hasAudioNarration":false,"actualSubdomain":"helpgenie","customDomains":["docs.helpgenie.ai"],"gitSource":{"type":"github","owner":"help-genie-ai","repo":"help-genie-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6af6f87607e6a796f0fd81d2","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API reference","count":54},{"language":"default","tag":"Voice","count":37},{"language":"default","tag":"Overview","count":20},{"language":"default","tag":"Expanded Platform","count":16},{"language":"default","tag":"Sync","count":13},{"language":"default","tag":"Mail","count":11},{"language":"default","tag":"Outbound","count":9},{"language":"default","tag":"Knowledge","count":6},{"language":"default","tag":"Working with mail","count":6},{"language":"default","tag":"Configuring a Genie","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/profiles","slug":"/api-reference/profiles","pageMetadata":{"title":"Profiles","description":"Manage user profiles including account information, subscription details, and team associations.","href":"/api-reference/profiles"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Manage user profiles including account information, subscription details, and team associations.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,hr:`hr`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,CodeGroup,Expandable,Heading,Info,Note,ParamField,ResponseField,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`All requests use a single endpoint: `,_jsx(_components.code,{children:`POST https://api.helpgenie.ai/v1`}),` with `,_jsx(_components.code,{children:`resource: \"profiles\"`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`access-control`,children:`Access control`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Action`}),_jsx(_components.th,{children:`Regular user`}),_jsx(_components.th,{children:`Admin`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`all`})}),_jsx(_components.td,{children:`No`}),_jsx(_components.td,{children:`Yes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`list`})}),_jsx(_components.td,{children:`No`}),_jsx(_components.td,{children:`Yes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`get`})}),_jsx(_components.td,{children:`Own profile only`}),_jsx(_components.td,{children:`Any profile`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`create`})}),_jsx(_components.td,{children:`No`}),_jsx(_components.td,{children:`Yes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`update`})}),_jsx(_components.td,{children:`Own profile only`}),_jsx(_components.td,{children:`Any profile`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`delete`})}),_jsx(_components.td,{children:`Own profile only`}),_jsx(_components.td,{children:`Any profile`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`check-timezone`})}),_jsx(_components.td,{children:`Yes (own profile)`}),_jsx(_components.td,{children:`Yes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`generate-sso-token`})}),_jsx(_components.td,{children:`Yes (own session)`}),_jsx(_components.td,{children:`Yes (+ impersonation)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`generate-sync-consent-link`})}),_jsx(_components.td,{children:`Yes (own email)`}),_jsx(_components.td,{children:`Yes (any email)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`usage-summary`})}),_jsx(_components.td,{children:`Yes (own profile)`}),_jsx(_components.td,{children:`Yes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`list-auth-sessions`})}),_jsx(_components.td,{children:`Yes (own signed-in session only)`}),_jsx(_components.td,{children:`No impersonation`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`revoke-auth-session`})}),_jsx(_components.td,{children:`Yes (own signed-in session only)`}),_jsx(_components.td,{children:`No impersonation`})]})]})]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Admin endpoints require a role starting with `,_jsx(_components.code,{children:`internal_`}),` (e.g. `,_jsx(_components.code,{children:`internal_admin`}),`). Non-admin users attempting admin-only actions receive a `,_jsx(_components.code,{children:`403 Forbidden`}),` response.`]})}),`\n`,_jsxs(Heading,{level:`3`,id:`role-values`,children:[_jsx(_components.code,{children:`role`}),` values`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Value`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`\"business\"`})}),_jsx(_components.td,{children:`Business owner — can create and manage agents, view leads, and access all standard features`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`\"consumer\"`})}),_jsx(_components.td,{children:`End user — can talk to agents and interact with consumer-facing features`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`\"internal_admin\"`})}),_jsx(_components.td,{children:`Full platform access — can manage all users, agents, marketplace listings, and system settings`})]})]})]}),`\n`,_jsx(Info,{children:_jsxs(_components.p,{children:[`Profile mutations (`,_jsx(_components.code,{children:`create`}),`, `,_jsx(_components.code,{children:`update`}),`, `,_jsx(_components.code,{children:`delete`}),`) are automatically logged to the `,_jsx(_components.code,{children:`activities`}),` table as `,_jsx(_components.code,{children:`user_action`}),` events. Update actions include the list of changed fields in the activity metadata.`]})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`list-all-profiles-admin`,children:`List all profiles (admin)`}),`\n`,_jsx(_components.p,{children:`Retrieves all profiles with complete joined data including subscriptions, call purchases, and phone subscriptions.`}),`\n`,_jsx(ParamField,{body:`resource`,type:`string`,required:true,id:`param-resource`,children:_jsxs(_components.p,{children:[`Must be `,_jsx(_components.code,{children:`\"profiles\"`})]})}),`\n`,_jsx(ParamField,{body:`action`,type:`string`,required:true,id:`param-action`,children:_jsxs(_components.p,{children:[`Must be `,_jsx(_components.code,{children:`\"all\"`})]})}),`\n`,_jsx(ParamField,{body:`data`,type:`object`,id:`param-data`,children:_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`limit`,type:`number`,id:`param-limit`,children:_jsxs(_components.p,{children:[`Results per page. Range: 1-100. Default: `,_jsx(_components.code,{children:`50`}),`.`]})}),_jsx(ParamField,{body:`offset`,type:`number`,id:`param-offset`,children:_jsxs(_components.p,{children:[`Pagination offset. Default: `,_jsx(_components.code,{children:`0`}),`.`]})}),_jsx(ParamField,{body:`filters`,type:`object`,id:`param-filters`,children:_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`searchTerm`,type:`string`,id:`param-search-term`,children:_jsxs(_components.p,{children:[`Search in `,_jsx(_components.code,{children:`full_name`}),` or `,_jsx(_components.code,{children:`email`}),`.`]})}),_jsx(ParamField,{body:`role`,type:`string`,id:`param-role`,children:_jsxs(_components.p,{children:[`Filter by role (exact match): `,_jsx(_components.code,{children:`\"business\"`}),`, `,_jsx(_components.code,{children:`\"consumer\"`}),` or `,_jsx(_components.code,{children:`\"internal_admin\"`}),`.`]})}),_jsx(ParamField,{body:`teamId`,type:`number`,id:`param-team-id`,children:_jsx(_components.p,{children:`Filter by team ID.`})}),_jsx(ParamField,{body:`hasSubscription`,type:`boolean`,id:`param-has-subscription`,children:_jsx(_components.p,{children:`Filter profiles with active subscriptions.`})}),_jsx(ParamField,{body:`needsAttention`,type:`boolean`,id:`param-needs-attention`,children:_jsxs(_components.p,{children:[`When `,_jsx(_components.code,{children:`true`}),`, return only accounts with unbilled purchased phone numbers — a paying, non-admin account whose number has no phone subscription, usually because it was added during a trial.`]})})]})}),_jsx(ParamField,{body:`sortBy`,type:`string`,id:`param-sort-by`,children:_jsxs(_components.p,{children:[`Column to sort by. One of: `,_jsx(_components.code,{children:`\"created_at\"`}),` (default), `,_jsx(_components.code,{children:`\"email\"`}),`, `,_jsx(_components.code,{children:`\"full_name\"`}),`.`]})}),_jsx(ParamField,{body:`sortOrder`,type:`string`,id:`param-sort-order`,children:_jsxs(_components.p,{children:[`Sort direction. `,_jsx(_components.code,{children:`\"asc\"`}),` or `,_jsx(_components.code,{children:`\"desc\"`}),`. Default: `,_jsx(_components.code,{children:`\"desc\"`}),`.`]})})]})}),`\n`,_jsx(Heading,{level:`3`,id:`response`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`success`,type:`boolean`,id:`param-success`}),`\n`,_jsx(ResponseField,{name:`data`,type:`object`,id:`param-data-1`,children:_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`profiles`,type:`object[]`,id:`param-profiles`,children:_jsxs(_components.p,{children:[`Array of full profile objects with joined relations. See `,_jsx(_components.a,{href:`#profile-object`,children:`profile object`}),`. Each profile also carries `,_jsx(_components.code,{children:`unbilled_phone_numbers`}),` — the account’s purchased numbers with no phone subscription (empty when none). Each entry has the same shape as a `,_jsx(_components.code,{children:`numbers`}),` item from `,_jsxs(_components.a,{href:`/api-reference/billing#get-phone-billing`,children:[_jsx(_components.code,{children:`billing`}),` → `,_jsx(_components.code,{children:`phones`})]}),`, with `,_jsx(_components.code,{children:`billing`}),` always `,_jsx(_components.code,{children:`\"unbilled\"`}),`. Each profile also carries `,_jsx(_components.code,{children:`genie_counts`}),` — `,_jsx(_components.code,{children:`{ active, eligible }`}),`, where `,_jsx(_components.code,{children:`active`}),` is the number of the account’s genies that are switched on and `,_jsx(_components.code,{children:`eligible`}),` excludes genies deactivated on purpose. Compare them with the account’s seats to spot a mismatch.`]})}),_jsx(ResponseField,{name:`count`,type:`number`,id:`param-count`}),_jsx(ResponseField,{name:`limit`,type:`number`,id:`param-limit-1`}),_jsx(ResponseField,{name:`offset`,type:`number`,id:`param-offset-1`}),_jsx(ResponseField,{name:`attentionCount`,type:`number`,id:`param-attention-count`,children:_jsx(_components.p,{children:`Number of accounts with unbilled purchased phone numbers, ignoring the other filters.`})})]})}),`\n`,_jsx(CodeGroup,{children:_jsx(CodeBlock,{filename:`Example request`,numberOfLines:`17`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`17`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` response`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` ApiService`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`invoke`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`\u003c{`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` profiles`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:` Profile`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`[];`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` count`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` number`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` limit`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` number`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` offset`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` number`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` attentionCount`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` number`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}>({`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` resource:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"profiles\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` action:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"all\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` data:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` limit:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 100`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` offset:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 0`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` filters:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` role:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"internal_admin\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`]})})})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`list-basic-profiles-admin`,children:`List basic profiles (admin)`}),`\n`,_jsx(_components.p,{children:`Retrieves a paginated list of profiles with basic fields only, optimized for lists and dropdowns.`}),`\n`,_jsx(ParamField,{body:`resource`,type:`string`,required:true,id:`param-resource-1`,children:_jsxs(_components.p,{children:[`Must be `,_jsx(_components.code,{children:`\"profiles\"`})]})}),`\n`,_jsx(ParamField,{body:`action`,type:`string`,required:true,id:`param-action-1`,children:_jsxs(_components.p,{children:[`Must be `,_jsx(_components.code,{children:`\"list\"`})]})}),`\n`,_jsx(ParamField,{body:`data`,type:`object`,id:`param-data-2`,children:_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`limit`,type:`number`,id:`param-limit-2`,children:_jsxs(_components.p,{children:[`Results per page. Range: 1-200. Default: `,_jsx(_components.code,{children:`50`}),`.`]})}),_jsx(ParamField,{body:`offset`,type:`number`,id:`param-offset-2`,children:_jsxs(_components.p,{children:[`Pagination offset. Default: `,_jsx(_components.code,{children:`0`}),`.`]})}),_jsx(ParamField,{body:`filters`,type:`object`,id:`param-filters-1`,children:_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`searchTerm`,type:`string`,id:`param-search-term-1`,children:_jsxs(_components.p,{children:[`Search in `,_jsx(_components.code,{children:`full_name`}),` or `,_jsx(_components.code,{children:`email`}),`.`]})}),_jsx(ParamField,{body:`role`,type:`string`,id:`param-role-1`,children:_jsxs(_components.p,{children:[`Filter by role (exact match): `,_jsx(_components.code,{children:`\"business\"`}),`, `,_jsx(_components.code,{children:`\"consumer\"`}),` or `,_jsx(_components.code,{children:`\"internal_admin\"`}),`.`]})}),_jsx(ParamField,{body:`teamId`,type:`number`,id:`param-team-id-1`,children:_jsx(_components.p,{children:`Filter by team ID.`})})]})})]})}),`\n`,_jsx(Heading,{level:`3`,id:`response-2`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`success`,type:`boolean`,id:`param-success-1`}),`\n`,_jsx(ResponseField,{name:`data`,type:`object`,id:`param-data-3`,children:_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`profiles`,type:`object[]`,id:`param-profiles-1`,children:_jsxs(Expandable,{title:`Basic profile fields`,children:[_jsx(ResponseField,{name:`id`,type:`string`,id:`param-id`}),_jsx(ResponseField,{name:`full_name`,type:`string | null`,id:`param-full-name`}),_jsx(ResponseField,{name:`email`,type:`string | null`,id:`param-email`}),_jsx(ResponseField,{name:`role`,type:`string | null`,id:`param-role-2`}),_jsx(ResponseField,{name:`avatar_url`,type:`string | null`,id:`param-avatar-url`}),_jsx(ResponseField,{name:`team_id`,type:`number | null`,id:`param-team-id-2`}),_jsx(ResponseField,{name:`created_at`,type:`string`,id:`param-created-at`}),_jsx(ResponseField,{name:`updated_at`,type:`string`,id:`param-updated-at`})]})}),_jsx(ResponseField,{name:`count`,type:`number`,id:`param-count-1`}),_jsx(ResponseField,{name:`limit`,type:`number`,id:`param-limit-3`}),_jsx(ResponseField,{name:`offset`,type:`number`,id:`param-offset-3`})]})}),`\n`,_jsx(CodeGroup,{children:_jsx(CodeBlock,{filename:`Example request`,numberOfLines:`13`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`13`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` response`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` ApiService`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`invoke`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`\u003c{`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` profiles`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:` Profile`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`[];`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` count`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` number`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}>({`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` resource:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"profiles\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` action:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"list\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` data:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` limit:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 50`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` filters:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` searchTerm:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"john@example.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`]})})})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`get-a-profile`,children:`Get a profile`}),`\n`,_jsx(_components.p,{children:`Retrieves a single profile with complete details including subscriptions and team data. Users can only access their own profile; admins can access any profile.`}),`\n`,_jsx(ParamField,{body:`resource`,type:`string`,required:true,id:`param-resource-2`,children:_jsxs(_components.p,{children:[`Must be `,_jsx(_components.code,{children:`\"profiles\"`})]})}),`\n`,_jsx(ParamField,{body:`action`,type:`string`,required:true,id:`param-action-2`,children:_jsxs(_components.p,{children:[`Must be `,_jsx(_components.code,{children:`\"get\"`})]})}),`\n`,_jsx(ParamField,{body:`id`,type:`string`,required:true,id:`param-id-1`,children:_jsx(_components.p,{children:`The profile ID (user UUID).`})}),`\n`,_jsx(Heading,{level:`3`,id:`response-3`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`success`,type:`boolean`,id:`param-success-2`}),`\n`,_jsx(ResponseField,{name:`data`,type:`object`,id:`param-data-4`,children:_jsx(Expandable,{title:`properties`,children:_jsx(ResponseField,{name:`profile`,type:`object`,id:`param-profile`,children:_jsxs(_components.p,{children:[`Full profile object with all joined relations. See `,_jsx(_components.a,{href:`#profile-object`,children:`profile object`}),`.`]})})})}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Example request`,numberOfLines:`8`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`8`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:`user`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` } `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` supabase`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`auth`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`getUser`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`();`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` response`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` ApiService`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`invoke`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`\u003c{ `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`profile`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:` Profile`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }>({`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` resource:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"profiles\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` action:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"get\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` id:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` user`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`id`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` subscriptions`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` response`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`?.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`profile`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`?.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`call_purchases`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`7`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`7`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.helpgenie.ai/v1/profiles`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer hg_live_YOUR_KEY\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"action\": \"get\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"id\": \"d4f8e2a1-5b3c-4e9f-a1b2-c3d4e5f67890\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`create-a-profile-admin`,children:`Create a profile (admin)`}),`\n`,_jsx(_components.p,{children:`Creates a new user profile. There are two ways to call it:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Attach to an existing account`}),` — send `,_jsx(_components.code,{children:`id`}),` set to the UUID of an existing sign-in account.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Create the account too`}),` — send `,_jsx(_components.code,{children:`email`}),` with `,_jsx(_components.code,{children:`password`}),`, or `,_jsx(_components.code,{children:`email`}),` with `,_jsx(_components.code,{children:`send_welcome_email: true`}),` (no `,_jsx(_components.code,{children:`id`}),` needed). The sign-in account is created first with its email already confirmed, and its UUID becomes the profile `,_jsx(_components.code,{children:`id`}),`. Without a `,_jsx(_components.code,{children:`password`}),`, the account gets a random one that the user replaces through the set-password link in the welcome email. Fields you leave out keep the defaults the new account was given; they are not reset to empty. If saving the profile fails, the new sign-in account is removed again.`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`No email is sent to the user unless `,_jsx(_components.code,{children:`send_welcome_email`}),` is `,_jsx(_components.code,{children:`true`}),`, so accounts can be set up quietly.`]}),`\n`,_jsx(_components.p,{children:`Any field not listed below is ignored.`}),`\n`,_jsx(ParamField,{body:`resource`,type:`string`,required:true,id:`param-resource-3`,children:_jsxs(_components.p,{children:[`Must be `,_jsx(_components.code,{children:`\"profiles\"`})]})}),`\n`,_jsx(ParamField,{body:`action`,type:`string`,required:true,id:`param-action-3`,children:_jsxs(_components.p,{children:[`Must be `,_jsx(_components.code,{children:`\"create\"`})]})}),`\n`,_jsx(ParamField,{body:`data`,type:`object`,required:true,id:`param-data-5`,children:_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`id`,type:`string`,id:`param-id-2`,children:_jsxs(_components.p,{children:[`UUID of an existing sign-in account to attach the profile to. Required unless `,_jsx(_components.code,{children:`email`}),` is sent with `,_jsx(_components.code,{children:`password`}),` or `,_jsx(_components.code,{children:`send_welcome_email: true`}),`.`]})}),_jsx(ParamField,{body:`email`,type:`string`,id:`param-email-1`,children:_jsxs(_components.p,{children:[`Profile email. Sent together with `,_jsx(_components.code,{children:`password`}),` or `,_jsx(_components.code,{children:`send_welcome_email: true`}),`, it also creates the sign-in account. When present, the new profile is also added to the customer contact list (best-effort — a failure there does not fail the request).`]})}),_jsx(ParamField,{body:`password`,type:`string`,id:`param-password`,children:_jsxs(_components.p,{children:[`Sent together with `,_jsx(_components.code,{children:`email`}),`, creates the sign-in account first. The email is marked as confirmed.`]})}),_jsx(ParamField,{body:`send_welcome_email`,type:`boolean`,default:`false`,id:`param-send-welcome-email`,children:_jsxs(_components.p,{children:[`With `,_jsx(_components.code,{children:`email`}),`, sends the welcome email with a set-password link once the account is created. Without `,_jsx(_components.code,{children:`password`}),`, the account is created with a random password the user replaces via that link. Leave `,_jsx(_components.code,{children:`false`}),` to create the account without emailing the user.`]})}),_jsx(ParamField,{body:`full_name`,type:`string`,id:`param-full-name-1`}),_jsx(ParamField,{body:`role`,type:`string`,default:`business`,id:`param-role-3`,children:_jsxs(_components.p,{children:[`See `,_jsxs(_components.a,{href:`#role-values`,children:[_jsx(_components.code,{children:`role`}),` values`]}),`.`]})}),_jsx(ParamField,{body:`avatar_url`,type:`string`,id:`param-avatar-url-1`}),_jsx(ParamField,{body:`phone_number`,type:`string`,id:`param-phone-number`}),_jsx(ParamField,{body:`phone_country_code`,type:`string`,id:`param-phone-country-code`}),_jsx(ParamField,{body:`address_line1`,type:`string`,id:`param-address-line1`}),_jsx(ParamField,{body:`address_line2`,type:`string`,id:`param-address-line2`}),_jsx(ParamField,{body:`city`,type:`string`,id:`param-city`}),_jsx(ParamField,{body:`state_province`,type:`string`,id:`param-state-province`}),_jsx(ParamField,{body:`country`,type:`string`,id:`param-country`,children:_jsxs(_components.p,{children:[`Two-letter ISO 3166-1 country code, e.g. `,_jsx(_components.code,{children:`\"NZ\"`}),`. A full country name (e.g. `,_jsx(_components.code,{children:`\"New Zealand\"`}),`) is converted to its code and, when no `,_jsx(_components.code,{children:`country_name`}),` is sent, kept as `,_jsx(_components.code,{children:`country_name`}),`. A name that cannot be matched leaves `,_jsx(_components.code,{children:`country`}),` empty.`]})}),_jsx(ParamField,{body:`country_name`,type:`string`,id:`param-country-name`,children:_jsxs(_components.p,{children:[`Full country name. When `,_jsx(_components.code,{children:`country`}),` is not sent, `,_jsx(_components.code,{children:`country`}),` is filled from this name.`]})}),_jsx(ParamField,{body:`postal_code`,type:`string`,id:`param-postal-code`}),_jsx(ParamField,{body:`company_name`,type:`string`,id:`param-company-name`}),_jsx(ParamField,{body:`job_title`,type:`string`,id:`param-job-title`}),_jsx(ParamField,{body:`date_of_birth`,type:`string`,id:`param-date-of-birth`}),_jsx(ParamField,{body:`timezone`,type:`string`,id:`param-timezone`}),_jsx(ParamField,{body:`preferred_language`,type:`string`,id:`param-preferred-language`}),_jsx(ParamField,{body:`billing_currency`,type:`string`,id:`param-billing-currency`,children:_jsxs(_components.p,{children:[`One of `,_jsx(_components.code,{children:`USD`}),`, `,_jsx(_components.code,{children:`NZD`}),`, `,_jsx(_components.code,{children:`AUD`}),`, `,_jsx(_components.code,{children:`GBP`}),`, `,_jsx(_components.code,{children:`EUR`}),` (any case). An unsupported value is ignored, the rest of the profile still saves, and the response includes a `,_jsx(_components.code,{children:`warnings`}),` entry.`]})}),_jsx(ParamField,{body:`stripe_id`,type:`string`,id:`param-stripe-id`}),_jsx(ParamField,{body:`hubspot_id`,type:`string`,id:`param-hubspot-id`,children:_jsx(_components.p,{children:`Overwritten with the customer contact ID when the contact sync succeeds.`})}),_jsx(ParamField,{body:`team_id`,type:`number`,id:`param-team-id-3`}),_jsx(ParamField,{body:`marketplace_creator_bio`,type:`string`,id:`param-marketplace-creator-bio`}),_jsx(ParamField,{body:`marketplace_creator_verified`,type:`boolean`,id:`param-marketplace-creator-verified`}),_jsx(ParamField,{body:`impersonatedUserId`,type:`string`,id:`param-impersonated-user-id`,children:_jsxs(_components.p,{children:[`Admin only. Records the activity log entry against this user. It does not change the created profile’s `,_jsx(_components.code,{children:`id`}),`.`]})})]})}),`\n`,_jsx(Heading,{level:`3`,id:`response-status-201`,children:`Response (status 201)`}),`\n`,_jsx(ResponseField,{name:`success`,type:`boolean`,id:`param-success-3`}),`\n`,_jsx(ResponseField,{name:`data`,type:`object`,id:`param-data-6`,children:_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`profile`,type:`object`,id:`param-profile-1`,children:_jsxs(_components.p,{children:[`The created profile with joined data. See `,_jsx(_components.a,{href:`#profile-object`,children:`Profile object`}),`.`]})}),_jsx(ResponseField,{name:`user`,type:`object`,id:`param-user`,children:_jsxs(_components.p,{children:[`Present only when the sign-in account was created by this request. The new account record, including its `,_jsx(_components.code,{children:`id`}),` and `,_jsx(_components.code,{children:`email`}),`.`]})}),_jsx(ResponseField,{name:`welcome_email_sent`,type:`boolean`,id:`param-welcome-email-sent`,children:_jsxs(_components.p,{children:[`Present only when the sign-in account was created with `,_jsx(_components.code,{children:`send_welcome_email: true`}),`. `,_jsx(_components.code,{children:`false`}),` if the welcome email could not be sent; the profile is still created.`]})})]})}),`\n`,_jsx(ResponseField,{name:`warnings`,type:`string[]`,id:`param-warnings`,children:_jsxs(_components.p,{children:[`Present only when a field was ignored, e.g. an unsupported `,_jsx(_components.code,{children:`billing_currency`}),`.`]})}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Example request`,numberOfLines:`46`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`46`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// Attach a profile to an existing account`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` response`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` ApiService`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`invoke`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`\u003c{ `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`profile`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:` Profile`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }>(`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` resource:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"profiles\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` action:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"create\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` data:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` id:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"auth-user-uuid-here\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` full_name:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Jane Smith\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` email:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"jane@example.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` role:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"business\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 201`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`);`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// Create the sign-in account and profile together`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` created`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` ApiService`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`invoke`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`\u003c{ `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`profile`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:` Profile`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`; `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`user`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`id`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` string`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`; `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`email`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` string`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` } }>(`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` resource:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"profiles\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` action:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"create\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` data:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` email:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"jane@example.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` password:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"a-strong-password\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` full_name:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Jane Smith\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 201`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`);`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// Create the account and let the user set their own password from the welcome email`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` invited`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` ApiService`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`invoke`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`\u003c{`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` profile`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:` Profile`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` user`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`id`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` string`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`; `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`email`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` string`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` };`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` welcome_email_sent`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` boolean`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}>(`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` resource:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"profiles\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` action:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"create\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` data:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` email:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"jane@example.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` full_name:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Jane Smith\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` send_welcome_email:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 201`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`);`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`11`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`11`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.helpgenie.ai/v1/profiles`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer hg_live_YOUR_KEY\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"action\": \"create\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"data\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"email\": \"jane@example.com\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"password\": \"a-strong-password\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"full_name\": \"Jane Smith\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`update-a-profile`,children:`Update a profile`}),`\n`,_jsx(_components.p,{children:`Updates an existing profile. Users can only update their own profile; admins can update any profile. This is a partial update — only include the fields you want to change.`}),`\n`,_jsx(ParamField,{body:`resource`,type:`string`,required:true,id:`param-resource-4`,children:_jsxs(_components.p,{children:[`Must be `,_jsx(_components.code,{children:`\"profiles\"`})]})}),`\n`,_jsx(ParamField,{body:`action`,type:`string`,required:true,id:`param-action-4`,children:_jsxs(_components.p,{children:[`Must be `,_jsx(_components.code,{children:`\"update\"`})]})}),`\n`,_jsx(ParamField,{body:`id`,type:`string`,required:true,id:`param-id-3`,children:_jsx(_components.p,{children:`The profile ID (user UUID).`})}),`\n`,_jsxs(ParamField,{body:`data`,type:`object`,required:true,id:`param-data-7`,children:[_jsxs(_components.p,{children:[`Any key not listed below is rejected with a validation error. `,_jsx(_components.code,{children:`country`}),`, `,_jsx(_components.code,{children:`country_name`}),` and `,_jsx(_components.code,{children:`billing_currency`}),` are normalized the same way as on `,_jsx(_components.code,{children:`create`}),`.`]}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`full_name`,type:`string`,id:`param-full-name-2`}),_jsx(ParamField,{body:`avatar_url`,type:`string`,id:`param-avatar-url-2`}),_jsx(ParamField,{body:`phone_number`,type:`string`,id:`param-phone-number-1`}),_jsx(ParamField,{body:`phone_country_code`,type:`string`,id:`param-phone-country-code-1`}),_jsx(ParamField,{body:`address_line1`,type:`string`,id:`param-address-line1-1`}),_jsx(ParamField,{body:`address_line2`,type:`string`,id:`param-address-line2-1`}),_jsx(ParamField,{body:`city`,type:`string`,id:`param-city-1`}),_jsx(ParamField,{body:`state_province`,type:`string`,id:`param-state-province-1`}),_jsx(ParamField,{body:`country`,type:`string`,id:`param-country-1`}),_jsx(ParamField,{body:`country_name`,type:`string`,id:`param-country-name-1`}),_jsx(ParamField,{body:`postal_code`,type:`string`,id:`param-postal-code-1`}),_jsx(ParamField,{body:`company_name`,type:`string`,id:`param-company-name-1`}),_jsx(ParamField,{body:`job_title`,type:`string`,id:`param-job-title-1`}),_jsx(ParamField,{body:`date_of_birth`,type:`string`,id:`param-date-of-birth-1`}),_jsx(ParamField,{body:`timezone`,type:`string`,id:`param-timezone-1`}),_jsx(ParamField,{body:`preferred_language`,type:`string`,id:`param-preferred-language-1`}),_jsx(ParamField,{body:`socials`,type:`number`,id:`param-socials`,children:_jsx(_components.p,{children:`Number of connected social accounts.`})}),_jsx(ParamField,{body:`email`,type:`string`,id:`param-email-2`,children:`Admin only.`}),_jsx(ParamField,{body:`role`,type:`string`,id:`param-role-4`,children:`Admin only. Only admins can change a profile’s role after sign-up.`}),_jsx(ParamField,{body:`team_id`,type:`number`,id:`param-team-id-4`,children:`Admin only.`}),_jsx(ParamField,{body:`billing_currency`,type:`string`,id:`param-billing-currency-1`,children:`Admin only.`}),_jsx(ParamField,{body:`stripe_id`,type:`string`,id:`param-stripe-id-1`,children:`Admin only.`}),_jsx(ParamField,{body:`hubspot_id`,type:`string`,id:`param-hubspot-id-1`,children:`Admin only.`}),_jsx(ParamField,{body:`marketplace_creator_bio`,type:`string`,id:`param-marketplace-creator-bio-1`,children:`Admin only.`}),_jsx(ParamField,{body:`marketplace_creator_verified`,type:`boolean`,id:`param-marketplace-creator-verified-1`,children:`Admin only.`}),_jsx(ParamField,{body:`password`,type:`string`,id:`param-password-1`,children:_jsx(_components.p,{children:`Admin only. Sets a new sign-in password. Minimum 6 characters.`})})]})]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Auth-context keys such as `,_jsx(_components.code,{children:`adminMode`}),` and `,_jsx(_components.code,{children:`impersonatedUserId`}),` are also rejected. Because admin API keys add `,_jsx(_components.code,{children:`adminMode`}),` to `,_jsx(_components.code,{children:`data`}),` automatically, `,_jsx(_components.code,{children:`update`}),` currently fails when called with an admin API key.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`response-4`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`success`,type:`boolean`,id:`param-success-4`}),`\n`,_jsx(ResponseField,{name:`data`,type:`object`,id:`param-data-8`,children:_jsx(Expandable,{title:`properties`,children:_jsx(ResponseField,{name:`profile`,type:`object`,id:`param-profile-2`,children:_jsx(_components.p,{children:`The updated profile with joined data.`})})})}),`\n`,_jsx(ResponseField,{name:`warnings`,type:`string[]`,id:`param-warnings-1`,children:_jsxs(_components.p,{children:[`Present only when a field was ignored, e.g. an unsupported `,_jsx(_components.code,{children:`billing_currency`}),`.`]})}),`\n`,_jsx(CodeGroup,{children:_jsx(CodeBlock,{filename:`Example request`,numberOfLines:`10`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`10`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` response`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` ApiService`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`invoke`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`\u003c{ `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`profile`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:` Profile`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }>({`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` resource:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"profiles\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` action:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"update\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` id:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` userId`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` data:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` full_name:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"John Doe\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` timezone:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"America/New_York\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` company_name:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Acme Corp\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`]})})})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`delete-a-profile`,children:`Delete a profile`}),`\n`,_jsx(_components.p,{children:`Permanently deletes a profile. Users can only delete their own profile; admins can delete any profile.`}),`\n`,_jsx(ParamField,{body:`resource`,type:`string`,required:true,id:`param-resource-5`,children:_jsxs(_components.p,{children:[`Must be `,_jsx(_components.code,{children:`\"profiles\"`})]})}),`\n`,_jsx(ParamField,{body:`action`,type:`string`,required:true,id:`param-action-5`,children:_jsxs(_components.p,{children:[`Must be `,_jsx(_components.code,{children:`\"delete\"`})]})}),`\n`,_jsx(ParamField,{body:`id`,type:`string`,required:true,id:`param-id-4`,children:_jsx(_components.p,{children:`The profile ID (user UUID).`})}),`\n`,_jsx(Heading,{level:`3`,id:`response-5`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`success`,type:`boolean`,id:`param-success-5`}),`\n`,_jsx(ResponseField,{name:`data`,type:`object`,id:`param-data-9`,children:_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`success`,type:`boolean`,id:`param-success-6`}),_jsx(ResponseField,{name:`message`,type:`string`,id:`param-message`})]})}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`This permanently deletes the profile record, the user’s sign-in account, and cancels any active subscriptions.`})}),`\n`,_jsxs(_components.p,{children:[`Before the profile is deleted, the mailbox of every genie the user owns is permanently removed. The profile is kept in place, and the request returns an `,_jsx(_components.code,{children:`INTERNAL_ERROR`}),`, when:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`one or more mailboxes can’t be removed — the error names the affected genies. Try again.`}),`\n`,_jsxs(_components.li,{children:[`the account has too many genies to clear in one call — the error reports how many mailboxes were removed. Call `,_jsx(_components.code,{children:`delete`}),` again to continue; each call picks up where the last one stopped.`]}),`\n`]}),`\n`,_jsx(CodeGroup,{children:_jsx(CodeBlock,{filename:`Example request`,numberOfLines:`8`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`8`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` response`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` ApiService`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`invoke`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`\u003c{`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` success`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` boolean`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` message`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` string`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}>({`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` resource:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"profiles\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` action:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"delete\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` id:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"user-uuid\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`]})})})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`check-timezone`,children:`Check timezone`}),`\n`,_jsx(_components.p,{children:`Checks the authenticated user’s profile for a timezone value. If the timezone is not set, auto-detects it from the server and saves it to the profile. No-op if timezone is already set.`}),`\n`,_jsx(ParamField,{body:`resource`,type:`string`,required:true,id:`param-resource-6`,children:_jsxs(_components.p,{children:[`Must be `,_jsx(_components.code,{children:`\"profiles\"`})]})}),`\n`,_jsx(ParamField,{body:`action`,type:`string`,required:true,id:`param-action-6`,children:_jsxs(_components.p,{children:[`Must be `,_jsx(_components.code,{children:`\"check-timezone\"`})]})}),`\n`,_jsx(Heading,{level:`3`,id:`response-6`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`success`,type:`boolean`,id:`param-success-7`}),`\n`,_jsx(ResponseField,{name:`data`,type:`object`,id:`param-data-10`,children:_jsx(Expandable,{title:`properties`,children:_jsx(ResponseField,{name:`success`,type:`boolean`,id:`param-success-8`})})}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Example request`,numberOfLines:`4`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` ApiService`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`invoke`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`({`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` resource:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"profiles\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` action:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"check-timezone\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`4`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.helpgenie.ai/v1/profiles`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer hg_live_YOUR_KEY\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{ \"action\": \"check-timezone\" }'`})]}),`\n`]})})})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`get-inbox-filters`,children:`Get inbox filters`}),`\n`,_jsx(_components.p,{children:`Returns the filters the authenticated user last used on the Conversations inbox, so the inbox can reopen the way they left it.`}),`\n`,_jsx(ParamField,{body:`resource`,type:`string`,required:true,id:`param-resource-7`,children:_jsxs(_components.p,{children:[`Must be `,_jsx(_components.code,{children:`\"profiles\"`})]})}),`\n`,_jsx(ParamField,{body:`action`,type:`string`,required:true,id:`param-action-7`,children:_jsxs(_components.p,{children:[`Must be `,_jsx(_components.code,{children:`\"get-inbox-filters\"`})]})}),`\n`,_jsx(Heading,{level:`3`,id:`response-7`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`success`,type:`boolean`,id:`param-success-9`}),`\n`,_jsx(ResponseField,{name:`data`,type:`object`,id:`param-data-11`,children:_jsx(Expandable,{title:`properties`,children:_jsx(ResponseField,{name:`filters`,type:`object | null`,id:`param-filters-2`,children:_jsxs(_components.p,{children:[`The saved filters, or `,_jsx(_components.code,{children:`null`}),` when the user has never saved any. Same shape as the `,_jsx(_components.code,{children:`filters`}),` returned by `,_jsx(_components.a,{href:`#save-inbox-filters`,children:`Save inbox filters`}),`.`]})})})}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Example request`,numberOfLines:`12`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`12`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` response`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` ApiService`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`invoke`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`\u003c{`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` filters`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` agentId`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` string`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` |`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` channel`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` string`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` |`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` viewId`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` string`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` |`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` timeRange`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` string`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` |`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` queue`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` string`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` |`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` } `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`|`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}>({`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` resource:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"profiles\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` action:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"get-inbox-filters\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`4`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.helpgenie.ai/v1/profiles`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer hg_live_YOUR_KEY\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{ \"action\": \"get-inbox-filters\" }'`})]}),`\n`]})})})]}),`\n`,_jsx(CodeBlock,{filename:`Example response`,numberOfLines:`12`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`12`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"filters\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"agentId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"channel\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"phone\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"viewId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"view-uuid\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"timeRange\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"30d\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"queue\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`save-inbox-filters`,children:`Save inbox filters`}),`\n`,_jsxs(_components.p,{children:[`Remembers the authenticated user’s Conversations inbox filters. The saved filters are replaced as a whole — any field you leave out is stored as `,_jsx(_components.code,{children:`null`}),`. Malformed or unknown values are stored as `,_jsx(_components.code,{children:`null`}),` (meaning “all”) rather than rejected, so a bad value never blocks the save.`]}),`\n`,_jsx(ParamField,{body:`resource`,type:`string`,required:true,id:`param-resource-8`,children:_jsxs(_components.p,{children:[`Must be `,_jsx(_components.code,{children:`\"profiles\"`})]})}),`\n`,_jsx(ParamField,{body:`action`,type:`string`,required:true,id:`param-action-8`,children:_jsxs(_components.p,{children:[`Must be `,_jsx(_components.code,{children:`\"save-inbox-filters\"`})]})}),`\n`,_jsx(ParamField,{body:`data`,type:`object`,required:true,id:`param-data-12`,children:_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`agentId`,type:`string | null`,id:`param-agent-id`,children:_jsxs(_components.p,{children:[`Selected genie UUID. `,_jsx(_components.code,{children:`null`}),` for all genies.`]})}),_jsx(ParamField,{body:`channel`,type:`string | null`,id:`param-channel`,children:_jsxs(_components.p,{children:[`Selected channel. One of `,_jsx(_components.code,{children:`\"phone\"`}),`, `,_jsx(_components.code,{children:`\"web\"`}),`, `,_jsx(_components.code,{children:`\"link\"`}),`, `,_jsx(_components.code,{children:`\"app\"`}),`, `,_jsx(_components.code,{children:`\"email\"`}),`, `,_jsx(_components.code,{children:`\"meeting\"`}),`, `,_jsx(_components.code,{children:`\"slack\"`}),`, `,_jsx(_components.code,{children:`\"teams\"`}),`. `,_jsx(_components.code,{children:`null`}),` for all channels.`]})}),_jsx(ParamField,{body:`viewId`,type:`string | null`,id:`param-view-id`,children:_jsxs(_components.p,{children:[`Selected saved inbox view UUID. `,_jsx(_components.code,{children:`null`}),` for none.`]})}),_jsx(ParamField,{body:`timeRange`,type:`string | null`,id:`param-time-range`,children:_jsxs(_components.p,{children:[`Relative time range: `,_jsx(_components.code,{children:`{value}{unit}`}),` where unit is `,_jsx(_components.code,{children:`h`}),` (hours), `,_jsx(_components.code,{children:`d`}),` (days) or `,_jsx(_components.code,{children:`m`}),` (minutes), for example `,_jsx(_components.code,{children:`\"30d\"`}),`, or `,_jsx(_components.code,{children:`\"all\"`}),`.`]})}),_jsx(ParamField,{body:`queue`,type:`string | null`,id:`param-queue`,children:_jsxs(_components.p,{children:[`Selected inbox queue: `,_jsx(_components.code,{children:`\"attention\"`}),`, `,_jsx(_components.code,{children:`\"mine\"`}),` or `,_jsx(_components.code,{children:`\"handled\"`}),`. `,_jsx(_components.code,{children:`null`}),` for all.`]})})]})}),`\n`,_jsx(Heading,{level:`3`,id:`response-8`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`success`,type:`boolean`,id:`param-success-10`}),`\n`,_jsx(ResponseField,{name:`data`,type:`object`,id:`param-data-13`,children:_jsx(Expandable,{title:`properties`,children:_jsxs(ResponseField,{name:`filters`,type:`object`,id:`param-filters-3`,children:[_jsxs(_components.p,{children:[`The filters as stored, after invalid values were replaced with `,_jsx(_components.code,{children:`null`}),`.`]}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`agentId`,type:`string | null`,id:`param-agent-id-1`}),_jsx(ResponseField,{name:`channel`,type:`string | null`,id:`param-channel-1`}),_jsx(ResponseField,{name:`viewId`,type:`string | null`,id:`param-view-id-1`}),_jsx(ResponseField,{name:`timeRange`,type:`string | null`,id:`param-time-range-1`}),_jsx(ResponseField,{name:`queue`,type:`string | null`,id:`param-queue-1`})]})]})})}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Example request`,numberOfLines:`11`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`11`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` ApiService`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`invoke`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`({`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` resource:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"profiles\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` action:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"save-inbox-filters\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` data:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` agentId:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` channel:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"phone\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` viewId:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"view-uuid\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` timeRange:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"30d\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` queue:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"attention\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`13`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`13`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.helpgenie.ai/v1/profiles`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer hg_live_YOUR_KEY\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"action\": \"save-inbox-filters\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"data\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"agentId\": null,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"channel\": \"phone\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"viewId\": \"view-uuid\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"timeRange\": \"30d\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"queue\": \"attention\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})})]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Returns `,_jsx(_components.code,{children:`VALIDATION_ERROR`}),` when `,_jsx(_components.code,{children:`data`}),` is missing or is not an object.`]})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`list-sign-in-sessions`,children:`List sign-in sessions`}),`\n`,_jsx(_components.p,{children:`Lists the authenticated user’s active sign-ins (browsers and devices), most recently active first.`}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Sign-ins can only be listed from the user’s own signed-in browser session. API keys, service calls and admin impersonation receive `,_jsx(_components.code,{children:`403 Forbidden`}),`.`]})}),`\n`,_jsx(ParamField,{body:`resource`,type:`string`,required:true,id:`param-resource-9`,children:_jsxs(_components.p,{children:[`Must be `,_jsx(_components.code,{children:`\"profiles\"`})]})}),`\n`,_jsx(ParamField,{body:`action`,type:`string`,required:true,id:`param-action-9`,children:_jsxs(_components.p,{children:[`Must be `,_jsx(_components.code,{children:`\"list-auth-sessions\"`})]})}),`\n`,_jsx(Heading,{level:`3`,id:`response-9`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`success`,type:`boolean`,id:`param-success-11`}),`\n`,_jsx(ResponseField,{name:`data`,type:`object`,id:`param-data-14`,children:_jsx(Expandable,{title:`properties`,children:_jsx(ResponseField,{name:`sessions`,type:`object[]`,id:`param-sessions`,children:_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`id`,type:`string`,id:`param-id-5`,children:_jsxs(_components.p,{children:[`Session UUID. Pass this to `,_jsx(_components.code,{children:`revoke-auth-session`}),`.`]})}),_jsx(ResponseField,{name:`device`,type:`string`,id:`param-device`,children:_jsxs(_components.p,{children:[`Browser and operating system, e.g. `,_jsx(_components.code,{children:`\"Chrome on macOS\"`}),`, or `,_jsx(_components.code,{children:`\"Unknown device\"`}),`.`]})}),_jsx(ResponseField,{name:`ip`,type:`string | null`,id:`param-ip`,children:_jsx(_components.p,{children:`IP address the session was created from.`})}),_jsx(ResponseField,{name:`createdAt`,type:`string`,id:`param-created-at-1`,children:_jsx(_components.p,{children:`ISO 8601 timestamp of the sign-in.`})}),_jsx(ResponseField,{name:`lastActiveAt`,type:`string`,id:`param-last-active-at`,children:_jsx(_components.p,{children:`ISO 8601 timestamp of the session’s most recent activity.`})}),_jsx(ResponseField,{name:`current`,type:`boolean`,id:`param-current`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`true`}),` for the session making this request.`]})})]})})})}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Example request`,numberOfLines:`4`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` response`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` ApiService`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`invoke`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`\u003c{ `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`sessions`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:` AuthSession`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`[] }>({`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` resource:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"profiles\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` action:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"list-auth-sessions\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`6`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`6`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.helpgenie.ai/v1/profiles`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer USER_SESSION_TOKEN\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"action\": \"list-auth-sessions\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})})]}),`\n`,_jsx(CodeBlock,{filename:`Example response`,numberOfLines:`15`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`15`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"sessions\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"8d6c1f8e-1a2b-4c3d-9e8f-0a1b2c3d4e5f\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"device\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Chrome on macOS\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"ip\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"203.0.113.7\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"createdAt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-11-01T09:00:00Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"lastActiveAt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-11-11T08:40:00Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"current\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`revoke-a-sign-in-session`,children:`Revoke a sign-in session`}),`\n`,_jsx(_components.p,{children:`Signs out one of the authenticated user’s other sign-ins. The current session cannot be revoked this way; sign out instead.`}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Sign-ins can only be revoked from the user’s own signed-in browser session. API keys, service calls and admin impersonation receive `,_jsx(_components.code,{children:`403 Forbidden`}),`.`]})}),`\n`,_jsx(Note,{children:_jsx(_components.p,{children:`The revoked device can no longer renew its sign-in, but the access token it already holds stays valid until it expires (about an hour).`})}),`\n`,_jsx(ParamField,{body:`resource`,type:`string`,required:true,id:`param-resource-10`,children:_jsxs(_components.p,{children:[`Must be `,_jsx(_components.code,{children:`\"profiles\"`})]})}),`\n`,_jsx(ParamField,{body:`action`,type:`string`,required:true,id:`param-action-10`,children:_jsxs(_components.p,{children:[`Must be `,_jsx(_components.code,{children:`\"revoke-auth-session\"`})]})}),`\n`,_jsx(ParamField,{body:`data`,type:`object`,required:true,id:`param-data-15`,children:_jsx(Expandable,{title:`properties`,children:_jsx(ParamField,{body:`sessionId`,type:`string`,required:true,id:`param-session-id`,children:_jsxs(_components.p,{children:[`Session UUID from `,_jsx(_components.code,{children:`list-auth-sessions`}),`. Must not be the current session.`]})})})}),`\n`,_jsx(Heading,{level:`3`,id:`response-10`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`success`,type:`boolean`,id:`param-success-12`}),`\n`,_jsx(ResponseField,{name:`data`,type:`object`,id:`param-data-16`,children:_jsx(Expandable,{title:`properties`,children:_jsx(ResponseField,{name:`success`,type:`boolean`,id:`param-success-13`})})}),`\n`,_jsxs(_components.p,{children:[`Returns `,_jsx(_components.code,{children:`VALIDATION_ERROR`}),` when `,_jsx(_components.code,{children:`sessionId`}),` is not a valid UUID or is the current session, and `,_jsx(_components.code,{children:`NOT_FOUND`}),` when the session does not exist or belongs to someone else.`]}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Example request`,numberOfLines:`7`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`7`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` ApiService`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`invoke`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`({`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` resource:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"profiles\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` action:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"revoke-auth-session\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` data:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` sessionId:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"8d6c1f8e-1a2b-4c3d-9e8f-0a1b2c3d4e5f\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`9`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`9`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.helpgenie.ai/v1/profiles`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer USER_SESSION_TOKEN\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"action\": \"revoke-auth-session\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"data\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"sessionId\": \"8d6c1f8e-1a2b-4c3d-9e8f-0a1b2c3d4e5f\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`profile-object`,children:`Profile object`}),`\n`,_jsxs(_components.p,{children:[`The full profile object returned by `,_jsx(_components.code,{children:`all`}),`, `,_jsx(_components.code,{children:`get`}),`, `,_jsx(_components.code,{children:`create`}),`, and `,_jsx(_components.code,{children:`update`}),` actions.`]}),`\n`,_jsx(Heading,{level:`3`,id:`core-fields`,children:`Core fields`}),`\n`,_jsx(ResponseField,{name:`id`,type:`string`,id:`param-id-6`,children:_jsx(_components.p,{children:`User UUID.`})}),`\n`,_jsx(ResponseField,{name:`full_name`,type:`string | null`,id:`param-full-name-3`}),`\n`,_jsx(ResponseField,{name:`email`,type:`string | null`,id:`param-email-3`}),`\n`,_jsx(ResponseField,{name:`role`,type:`string | null`,id:`param-role-5`}),`\n`,_jsx(ResponseField,{name:`avatar_url`,type:`string | null`,id:`param-avatar-url-3`}),`\n`,_jsx(Heading,{level:`3`,id:`contact-information`,children:`Contact information`}),`\n`,_jsx(ResponseField,{name:`phone_number`,type:`string | null`,id:`param-phone-number-2`}),`\n`,_jsx(ResponseField,{name:`phone_country_code`,type:`string | null`,id:`param-phone-country-code-2`}),`\n`,_jsx(Heading,{level:`3`,id:`address`,children:`Address`}),`\n`,_jsx(ResponseField,{name:`address_line1`,type:`string | null`,id:`param-address-line1-2`}),`\n`,_jsx(ResponseField,{name:`address_line2`,type:`string | null`,id:`param-address-line2-2`}),`\n`,_jsx(ResponseField,{name:`city`,type:`string | null`,id:`param-city-2`}),`\n`,_jsx(ResponseField,{name:`state_province`,type:`string | null`,id:`param-state-province-2`}),`\n`,_jsx(ResponseField,{name:`country`,type:`string | null`,id:`param-country-2`}),`\n`,_jsx(ResponseField,{name:`country_name`,type:`string | null`,id:`param-country-name-2`}),`\n`,_jsx(ResponseField,{name:`postal_code`,type:`string | null`,id:`param-postal-code-2`}),`\n`,_jsx(Heading,{level:`3`,id:`company`,children:`Company`}),`\n`,_jsx(ResponseField,{name:`company_name`,type:`string | null`,id:`param-company-name-2`}),`\n`,_jsx(ResponseField,{name:`job_title`,type:`string | null`,id:`param-job-title-2`}),`\n`,_jsx(Heading,{level:`3`,id:`preferences`,children:`Preferences`}),`\n`,_jsx(ResponseField,{name:`date_of_birth`,type:`string | null`,id:`param-date-of-birth-2`}),`\n`,_jsx(ResponseField,{name:`timezone`,type:`string | null`,id:`param-timezone-2`}),`\n`,_jsx(ResponseField,{name:`preferred_language`,type:`string | null`,id:`param-preferred-language-2`}),`\n`,_jsx(ResponseField,{name:`billing_currency`,type:`string | null`,id:`param-billing-currency-2`}),`\n`,_jsx(Heading,{level:`3`,id:`external-ids`,children:`External IDs`}),`\n`,_jsx(ResponseField,{name:`stripe_id`,type:`string | null`,id:`param-stripe-id-2`}),`\n`,_jsx(ResponseField,{name:`hubspot_id`,type:`string | null`,id:`param-hubspot-id-2`}),`\n`,_jsx(Heading,{level:`3`,id:`marketplace`,children:`Marketplace`}),`\n`,_jsx(ResponseField,{name:`marketplace_creator_bio`,type:`string | null`,id:`param-marketplace-creator-bio-2`}),`\n`,_jsx(ResponseField,{name:`marketplace_creator_verified`,type:`boolean | null`,id:`param-marketplace-creator-verified-2`}),`\n`,_jsx(Heading,{level:`3`,id:`team`,children:`Team`}),`\n`,_jsx(ResponseField,{name:`team_id`,type:`number | null`,id:`param-team-id-5`}),`\n`,_jsx(ResponseField,{name:`team`,type:`object | null`,id:`param-team`,children:_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`id`,type:`number`,id:`param-id-7`}),_jsx(ResponseField,{name:`name`,type:`string`,id:`param-name`}),_jsx(ResponseField,{name:`brand`,type:`string`,id:`param-brand`}),_jsx(ResponseField,{name:`owner_id`,type:`string`,id:`param-owner-id`}),_jsx(ResponseField,{name:`created_at`,type:`string`,id:`param-created-at-2`})]})}),`\n`,_jsx(Heading,{level:`3`,id:`subscription`,children:`Subscription`}),`\n`,_jsx(ResponseField,{name:`subscription`,type:`object | null`,id:`param-subscription`,children:_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`id`,type:`number`,id:`param-id-8`}),_jsx(ResponseField,{name:`status`,type:`string | null`,id:`param-status`}),_jsx(ResponseField,{name:`price_id`,type:`string | null`,id:`param-price-id`}),_jsx(ResponseField,{name:`stripe_id`,type:`string | null`,id:`param-stripe-id-3`}),_jsx(ResponseField,{name:`quantity`,type:`number | null`,id:`param-quantity`}),_jsx(ResponseField,{name:`extra_quantity`,type:`number | null`,id:`param-extra-quantity`}),_jsx(ResponseField,{name:`trial_ends_at`,type:`string | null`,id:`param-trial-ends-at`}),_jsx(ResponseField,{name:`ends_at`,type:`string | null`,id:`param-ends-at`}),_jsx(ResponseField,{name:`created_at`,type:`string`,id:`param-created-at-3`})]})}),`\n`,_jsx(Heading,{level:`3`,id:`call-purchases`,children:`Call purchases`}),`\n`,_jsx(ResponseField,{name:`call_purchases`,type:`object[]`,id:`param-call-purchases`,children:_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`id`,type:`number`,id:`param-id-9`}),_jsx(ResponseField,{name:`quantity`,type:`number | null`,id:`param-quantity-1`}),_jsx(ResponseField,{name:`status`,type:`string | null`,id:`param-status-1`}),_jsx(ResponseField,{name:`stripe_subscription_id`,type:`string | null`,id:`param-stripe-subscription-id`}),_jsx(ResponseField,{name:`created_at`,type:`string`,id:`param-created-at-4`})]})}),`\n`,_jsx(Heading,{level:`3`,id:`phone-subscriptions`,children:`Phone subscriptions`}),`\n`,_jsx(ResponseField,{name:`phone_subscriptions`,type:`object[]`,id:`param-phone-subscriptions`,children:_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`id`,type:`string`,id:`param-id-10`}),_jsx(ResponseField,{name:`phone_number`,type:`string`,id:`param-phone-number-3`}),_jsx(ResponseField,{name:`phone_type`,type:`string`,id:`param-phone-type`}),_jsx(ResponseField,{name:`status`,type:`string`,id:`param-status-2`}),_jsx(ResponseField,{name:`stripe_price_id`,type:`string`,id:`param-stripe-price-id`}),_jsx(ResponseField,{name:`created_at`,type:`string`,id:`param-created-at-5`})]})}),`\n`,_jsx(Heading,{level:`3`,id:`timestamps`,children:`Timestamps`}),`\n`,_jsx(ResponseField,{name:`created_at`,type:`string`,id:`param-created-at-6`}),`\n`,_jsx(ResponseField,{name:`updated_at`,type:`string`,id:`param-updated-at-1`}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`generate-sso-token`,children:`Generate SSO token`}),`\n`,_jsx(_components.p,{children:`Generates a signed, time-limited SSO token for the authenticated user. The token is used to authenticate the user into connected suite applications without a separate login.`}),`\n`,_jsx(_components.p,{children:`When impersonation parameters are provided, the token encodes the target user’s identity alongside the admin’s, allowing the receiving application to establish an impersonated session.`}),`\n`,_jsx(ParamField,{body:`resource`,type:`string`,required:true,id:`param-resource-11`,children:_jsxs(_components.p,{children:[`Must be `,_jsx(_components.code,{children:`\"profiles\"`})]})}),`\n`,_jsx(ParamField,{body:`action`,type:`string`,required:true,id:`param-action-11`,children:_jsxs(_components.p,{children:[`Must be `,_jsx(_components.code,{children:`\"generate-sso-token\"`})]})}),`\n`,_jsx(ParamField,{body:`data`,type:`object`,id:`param-data-17`,children:_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`impersonatedUserId`,type:`string`,id:`param-impersonated-user-id-1`,children:_jsxs(_components.p,{children:[`The user ID of the account to impersonate. Must be supplied together with `,_jsx(_components.code,{children:`adminUserId`}),`. Both fields must be present for impersonation fields to be embedded; supplying only one has no effect.`]})}),_jsx(ParamField,{body:`adminUserId`,type:`string`,id:`param-admin-user-id`,children:_jsxs(_components.p,{children:[`The admin user’s own ID. Must be supplied together with `,_jsx(_components.code,{children:`impersonatedUserId`}),`.`]})})]})}),`\n`,_jsx(Heading,{level:`3`,id:`response-11`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`success`,type:`boolean`,id:`param-success-14`}),`\n`,_jsx(ResponseField,{name:`data`,type:`object`,id:`param-data-18`,children:_jsx(Expandable,{title:`properties`,children:_jsx(ResponseField,{name:`token`,type:`string`,id:`param-token`,children:_jsxs(_components.p,{children:[`A signed token string in the format `,_jsx(_components.code,{children:`email={email}\u0026ts={unix_timestamp}[\u0026imp_uid={id}\u0026admin_uid={id}]\u0026sig={hmac_hex}`}),`. Pass this value to the target suite application to authenticate the session.`]})})})}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Own session`,numberOfLines:`7`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`7`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` response`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` ApiService`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`invoke`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`\u003c{ `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`token`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` string`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }>({`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` resource:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"profiles\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` action:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"generate-sso-token\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` ssoToken`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` response`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`?.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`token`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// Redirect: https://app.example.com/sso?token=\u003cssoToken>`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`With impersonation (admin)`,numberOfLines:`10`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`10`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` response`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` ApiService`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`invoke`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`\u003c{ `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`token`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` string`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }>({`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` resource:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"profiles\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` action:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"generate-sso-token\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` data:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` impersonatedUserId:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"target-user-uuid\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` adminUserId:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"admin-user-uuid\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` ssoToken`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` response`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`?.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`token`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`6`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`6`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.helpgenie.ai/v1/profiles`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer hg_live_YOUR_KEY\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"action\": \"generate-sso-token\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`generate-sync-consent-link`,children:`Generate sync consent link`}),`\n`,_jsx(_components.p,{children:`Generates a signed, time-limited URL that redirects the user through an OAuth consent flow to authorise a third-party integration. The link is valid for a short window and is tied to the user’s email address.`}),`\n`,_jsx(_components.p,{children:`Regular users can only generate a link for their own email. Admins can generate a link for any user’s email.`}),`\n`,_jsx(ParamField,{body:`resource`,type:`string`,required:true,id:`param-resource-12`,children:_jsxs(_components.p,{children:[`Must be `,_jsx(_components.code,{children:`\"profiles\"`})]})}),`\n`,_jsx(ParamField,{body:`action`,type:`string`,required:true,id:`param-action-12`,children:_jsxs(_components.p,{children:[`Must be `,_jsx(_components.code,{children:`\"generate-sync-consent-link\"`})]})}),`\n`,_jsx(ParamField,{body:`data`,type:`object`,required:true,id:`param-data-19`,children:_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`email`,type:`string`,required:true,id:`param-email-4`,children:_jsx(_components.p,{children:`The email address of the user to generate the link for. Must match the authenticated user’s email unless the caller is an admin.`})}),_jsx(ParamField,{body:`connection`,type:`string`,required:true,id:`param-connection`,children:_jsxs(_components.p,{children:[`The integration to connect. Must be one of: `,_jsx(_components.code,{children:`\"airtable\"`}),`, `,_jsx(_components.code,{children:`\"anthropic\"`}),`, `,_jsx(_components.code,{children:`\"asana\"`}),`, `,_jsx(_components.code,{children:`\"github-app\"`}),`, `,_jsx(_components.code,{children:`\"google-calendar\"`}),`, `,_jsx(_components.code,{children:`\"google-sheet\"`}),`, `,_jsx(_components.code,{children:`\"hubspot\"`}),`, `,_jsx(_components.code,{children:`\"simpro\"`}),`, `,_jsx(_components.code,{children:`\"slack\"`}),`, `,_jsx(_components.code,{children:`\"supabase\"`}),`, `,_jsx(_components.code,{children:`\"xero\"`}),`.`]})})]})}),`\n`,_jsx(Heading,{level:`3`,id:`response-12`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`success`,type:`boolean`,id:`param-success-15`}),`\n`,_jsx(ResponseField,{name:`data`,type:`object`,id:`param-data-20`,children:_jsx(Expandable,{title:`properties`,children:_jsx(ResponseField,{name:`url`,type:`string`,id:`param-url`,children:_jsxs(_components.p,{children:[`A signed consent URL. Redirect the user to this URL to complete the integration authorisation flow. The URL includes HMAC-verified query parameters (`,_jsx(_components.code,{children:`email`}),`, `,_jsx(_components.code,{children:`ts`}),`, `,_jsx(_components.code,{children:`sig`}),`, `,_jsx(_components.code,{children:`connection`}),`) and is time-limited.`]})})})}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Own account`,numberOfLines:`11`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`11`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` response`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` ApiService`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`invoke`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`\u003c{ `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`url`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` string`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }>({`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` resource:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"profiles\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` action:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"generate-sync-consent-link\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` data:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` email:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"user@example.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` connection:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"slack\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// Redirect the user to response?.url to complete authorisation`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` consentUrl`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` response`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`?.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`url`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Another user (admin only)`,numberOfLines:`10`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`10`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` response`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` ApiService`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`invoke`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`\u003c{ `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`url`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` string`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }>({`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` resource:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"profiles\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` action:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"generate-sync-consent-link\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` data:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` email:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"customer@example.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` connection:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"hubspot\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` consentUrl`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` response`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`?.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`url`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`11`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`11`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.helpgenie.ai/v1`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer hg_live_YOUR_KEY\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"resource\": \"profiles\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"action\": \"generate-sync-consent-link\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"data\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"email\": \"user@example.com\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"connection\": \"google-calendar\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`usage-summary`,children:`Usage summary`}),`\n`,_jsx(_components.p,{children:`Returns a usage summary for the profile (calls, leads, conversations, etc.).`}),`\n`,_jsx(ParamField,{body:`action`,type:`string`,required:true,id:`param-action-13`,children:_jsx(_components.p,{children:_jsx(_components.code,{children:`usage-summary`})})}),`\n`,_jsx(ParamField,{body:`id`,type:`string`,id:`param-id-11`,children:_jsx(_components.p,{children:`Profile UUID. Defaults to the authenticated user. Admins may pass any profile ID.`})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`activity-logging`,children:`Activity logging`}),`\n`,_jsxs(_components.p,{children:[`Profile mutations are logged to the `,_jsx(_components.code,{children:`activities`}),` table:`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Action`}),_jsx(_components.th,{children:`Activity type`}),_jsx(_components.th,{children:`Action logged`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Create`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`user_action`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`profile_created`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Update`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`user_action`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`profile_updated`}),` (includes `,_jsx(_components.code,{children:`updated_fields`}),` in metadata)`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Delete`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`user_action`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`profile_deleted`})})]})]})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`error-responses`,children:`Error responses`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`VALIDATION_ERROR`})}),_jsx(_components.td,{children:`Profile ID not provided`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`401`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`UNAUTHORIZED`})}),_jsx(_components.td,{children:`Invalid or missing authentication token`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`403`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`FORBIDDEN`})}),_jsx(_components.td,{children:`Non-admin accessing admin-only action, or user accessing another user’s profile`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`404`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`NOT_FOUND`})}),_jsx(_components.td,{children:`Profile does not exist`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`500`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`INTERNAL_ERROR`})}),_jsx(_components.td,{children:`Database operation failed`})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Profiles","description":"Manage user profiles including account information, subscription details, and team associations.","href":"/api-reference/profiles"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Access control","slug":"access-control","depth":2,"children":[{"title":"role values","slug":"role-values","depth":3,"children":[]}]},{"title":"List all profiles (admin)","slug":"list-all-profiles-admin","depth":2,"children":[{"title":"Response","slug":"response","depth":3,"children":[]}]},{"title":"List basic profiles (admin)","slug":"list-basic-profiles-admin","depth":2,"children":[{"title":"Response","slug":"response-2","depth":3,"children":[]}]},{"title":"Get a profile","slug":"get-a-profile","depth":2,"children":[{"title":"Response","slug":"response-3","depth":3,"children":[]}]},{"title":"Create a profile (admin)","slug":"create-a-profile-admin","depth":2,"children":[{"title":"Response (status 201)","slug":"response-status-201","depth":3,"children":[]}]},{"title":"Update a profile","slug":"update-a-profile","depth":2,"children":[{"title":"Response","slug":"response-4","depth":3,"children":[]}]},{"title":"Delete a profile","slug":"delete-a-profile","depth":2,"children":[{"title":"Response","slug":"response-5","depth":3,"children":[]}]},{"title":"Check timezone","slug":"check-timezone","depth":2,"children":[{"title":"Response","slug":"response-6","depth":3,"children":[]}]},{"title":"Get inbox filters","slug":"get-inbox-filters","depth":2,"children":[{"title":"Response","slug":"response-7","depth":3,"children":[]}]},{"title":"Save inbox filters","slug":"save-inbox-filters","depth":2,"children":[{"title":"Response","slug":"response-8","depth":3,"children":[]}]},{"title":"List sign-in sessions","slug":"list-sign-in-sessions","depth":2,"children":[{"title":"Response","slug":"response-9","depth":3,"children":[]}]},{"title":"Revoke a sign-in session","slug":"revoke-a-sign-in-session","depth":2,"children":[{"title":"Response","slug":"response-10","depth":3,"children":[]}]},{"title":"Profile object","slug":"profile-object","depth":2,"children":[{"title":"Core fields","slug":"core-fields","depth":3,"children":[]},{"title":"Contact information","slug":"contact-information","depth":3,"children":[]},{"title":"Address","slug":"address","depth":3,"children":[]},{"title":"Company","slug":"company","depth":3,"children":[]},{"title":"Preferences","slug":"preferences","depth":3,"children":[]},{"title":"External IDs","slug":"external-ids","depth":3,"children":[]},{"title":"Marketplace","slug":"marketplace","depth":3,"children":[]},{"title":"Team","slug":"team","depth":3,"children":[]},{"title":"Subscription","slug":"subscription","depth":3,"children":[]},{"title":"Call purchases","slug":"call-purchases","depth":3,"children":[]},{"title":"Phone subscriptions","slug":"phone-subscriptions","depth":3,"children":[]},{"title":"Timestamps","slug":"timestamps","depth":3,"children":[]}]},{"title":"Generate SSO token","slug":"generate-sso-token","depth":2,"children":[{"title":"Response","slug":"response-11","depth":3,"children":[]}]},{"title":"Generate sync consent link","slug":"generate-sync-consent-link","depth":2,"children":[{"title":"Response","slug":"response-12","depth":3,"children":[]}]},{"title":"Usage summary","slug":"usage-summary","depth":2,"children":[]},{"title":"Activity logging","slug":"activity-logging","depth":2,"children":[]},{"title":"Error responses","slug":"error-responses","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"helpgenie","siteName":"Help Genie","title":"Profiles - Help Genie","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-13T09:06:23.101Z","originalFileLocation":"api-reference/profiles.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Manage user profiles including account information, subscription details, and team associations.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Help Genie\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/helpgenie/ypdPY4Ery9DMUCww/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/helpgenie/ypdPY4Ery9DMUCww/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/helpgenie/ypdPY4Ery9DMUCww/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/helpgenie/ypdPY4Ery9DMUCww/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/helpgenie/ypdPY4Ery9DMUCww/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/helpgenie/ypdPY4Ery9DMUCww/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/helpgenie/ypdPY4Ery9DMUCww/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/helpgenie/ypdPY4Ery9DMUCww/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/helpgenie/ypdPY4Ery9DMUCww/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Profiles - Help Genie\">\u003cmeta data-mint-head property=\"og:description\" content=\"Manage user profiles including account information, subscription details, and team associations.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Help Genie\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.helpgenie.ai/api-reference/profiles\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://helpgenie.mintlify.site/_mintlify/api/og/v2?division=Platform\u0026amp;title=Profiles\u0026amp;description=Manage+user+profiles+including+account+information%2C+subscription+details%2C+and+team+associations.\u0026amp;theme=fc0888b7de96c166e1873963\u0026amp;signature=b227953e0fb7011462f519f4435e1fc575c80707cd3b11074d91def5d13f607b\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Profiles - Help Genie\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Manage user profiles including account information, subscription details, and team associations.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://helpgenie.mintlify.site/_mintlify/api/og/v2?division=Platform\u0026amp;title=Profiles\u0026amp;description=Manage+user+profiles+including+account+information%2C+subscription+details%2C+and+team+associations.\u0026amp;theme=fc0888b7de96c166e1873963\u0026amp;signature=b227953e0fb7011462f519f4435e1fc575c80707cd3b11074d91def5d13f607b\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/helpgenie/ypdPY4Ery9DMUCww/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Help Genie\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4E9CFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.helpgenie.ai/api-reference/profiles\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/profiles.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.helpgenie.ai/#organization\",\"name\":\"Help Genie\",\"url\":\"https://docs.helpgenie.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/helpgenie/a134Jyg1BOpqw0vP/logo/light.png?fit=max\u0026auto=format\u0026n=a134Jyg1BOpqw0vP\u0026q=85\u0026s=f29d097a201254a8a750843d0d692c50\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.helpgenie.ai#website\",\"name\":\"Help Genie\",\"url\":\"https://docs.helpgenie.ai\",\"publisher\":{\"@id\":\"https://docs.helpgenie.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.helpgenie.ai/api-reference/profiles#webpage\",\"url\":\"https://docs.helpgenie.ai/api-reference/profiles\",\"name\":\"Profiles\",\"description\":\"Manage user profiles including account information, subscription details, and team associations.\",\"dateModified\":\"2026-11-13T09:06:23.101Z\",\"isPartOf\":{\"@id\":\"https://docs.helpgenie.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.helpgenie.ai/api-reference/profiles#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.helpgenie.ai/api-reference/profiles#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Help Genie\",\"item\":\"https://docs.helpgenie.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Profiles\",\"item\":\"https://docs.helpgenie.ai/api-reference/profiles\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.helpgenie.ai/api-reference/profiles#article\",\"headline\":\"Profiles\",\"name\":\"Profiles\",\"description\":\"Manage user profiles including account information, subscription details, and team associations.\",\"url\":\"https://docs.helpgenie.ai/api-reference/profiles\",\"mainEntityOfPage\":{\"@id\":\"https://docs.helpgenie.ai/api-reference/profiles#webpage\"},\"dateModified\":\"2026-11-13T09:06:23.101Z\",\"publisher\":{\"@id\":\"https://docs.helpgenie.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.helpgenie.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Help Genie\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Help Genie\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/profiles.md","siteName":"Help Genie","nav":{"global":{"anchors":[{"anchor":"Help Genie Voice","icon":"microphone","href":"https://helpgenie.ai"},{"anchor":"Help Genie Mail","icon":"envelope","href":"https://mail.helpgenie.ai"},{"anchor":"Help Genie Outbound","icon":"phone","href":"https://outbound.helpgenie.ai"},{"anchor":"Help Genie Sync","icon":"arrows-rotate","href":"https://sync.helpgenie.ai"}]},"tabs":[{"tab":"Getting started","icon":"compass","pages":[{"title":"Getting started","href":""}]},{"tab":"API reference","icon":"code","groups":[{"group":"Overview","pages":[{"title":"API reference","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Making requests","href":"/api-reference/making-requests"},{"title":"Error handling","href":"/api-reference/errors"}]},{"group":"Public (unauthenticated)","pages":[{"title":"Public Genies","href":"/api-reference/public-genies"},{"title":"Public Help Hub","href":"/api-reference/public-help-hub"},{"title":"Activation (Public)","href":"/api-reference/activation"},{"title":"Help Hub","href":"/api-reference/help-hub"}]},{"group":"Agents","pages":[{"title":"Genies","href":"/api-reference/genies"},{"title":"Genie groups","href":"/api-reference/genie-groups"},{"title":"Conversations","href":"/api-reference/conversations"},{"title":"Genie Meetings","href":"/api-reference/genie-meetings"}]},{"group":"Knowledge","pages":[{"title":"Knowledge base","href":"/api-reference/knowledge-base"},{"title":"Knowledge Recommendations","href":"/api-reference/knowledge-recommendations"},{"title":"Document folders","href":"/api-reference/document-folders"},{"title":"Genie Documents","href":"/api-reference/genie-documents"}]},{"group":"CRM","pages":[{"title":"Leads","href":"/api-reference/leads"}]},{"group":"Marketplace","pages":[{"title":"Marketplace","description":"Browse, search, and manage marketplace genie listings with categories and statistics.","href":"/api-reference/marketplace"}]},{"group":"Platform","pages":[{"title":"Profiles","href":"/api-reference/profiles"},{"title":"Teams","description":"Manage teams, team membership, and invitations.","href":"/api-reference/teams"},{"title":"Activities","href":"/api-reference/activities"},{"title":"Goals","href":"/api-reference/goals"},{"title":"API keys","href":"/api-reference/api-keys"}]},{"group":"Telephony","pages":[{"title":"Phone numbers","href":"/api-reference/phone-numbers"},{"title":"QR codes","href":"/api-reference/qr-code"}]},{"group":"Worker genies","pages":[{"title":"Worker genies","href":"/api-reference/worker-genies"}]},{"group":"Quality \u0026 Compliance","pages":[{"title":"Brand Integrity","href":"/api-reference/brand-integrity"}]},{"group":"Access Control","pages":[{"title":"Genie Access","href":"/api-reference/genie-access"}]},{"group":"Intelligence","pages":[{"title":"Insights","href":"/api-reference/insights"}]},{"group":"Education","pages":[{"title":"Learn","href":"/api-reference/learn"}]},{"group":"Voice","pages":[{"title":"Voices","href":"/api-reference/voices"},{"title":"Voice collections","href":"/api-reference/voice-collections"},{"title":"Preselected voices","href":"/api-reference/preselected-voices"},{"title":"Pronunciation Vaults","href":"/api-reference/pronunciation-vaults"}]},{"group":"Integrations","pages":[{"title":"Context Sources","href":"/api-reference/context-sources"},{"title":"Escalation Webhooks","href":"/api-reference/escalation-webhooks"},{"title":"Chat channels","href":"/api-reference/chat-channels"},{"title":"MCP connections","href":"/api-reference/mcp-connections"}]},{"group":"Expanded Platform","pages":[{"title":"Analytics","href":"/api-reference/analytics"},{"title":"Billing","href":"/api-reference/billing"},{"title":"Branding","href":"/api-reference/branding"},{"title":"Portals","href":"/api-reference/portals"},{"title":"Activation Packs","href":"/api-reference/activation-packs"},{"title":"Print Orders","href":"/api-reference/print-orders"},{"title":"Playbooks","href":"/api-reference/playbooks"},{"title":"Demo Genies","href":"/api-reference/demo-genies"},{"title":"Email Templates","href":"/api-reference/email-templates"},{"title":"Email Logs","href":"/api-reference/email-logs"},{"title":"System Emails","href":"/api-reference/system-emails"},{"title":"Generate Logo","href":"/api-reference/generate-logo"},{"title":"Capabilities","href":"/api-reference/capabilities"},{"title":"Agent mailboxes","href":"/api-reference/agent-mailboxes"},{"title":"Genie mailbox (self)","href":"/api-reference/agent-mailboxes-self"},{"title":"Mail tenant credentials","href":"/api-reference/mail-tenant-credentials"}]}]},{"tab":"Voice","icon":"microphone","pages":[{"title":"Voice","href":"/voice-guide/my-genies-list"}]},{"tab":"Mail","icon":"envelope","pages":[{"title":"Mail","href":"/mail-guide/introduction"}]},{"tab":"Outbound","icon":"phone","pages":[{"title":"Outbound","href":"/outbound-guide/introduction"}]},{"tab":"Sync","icon":"arrows-rotate","pages":[{"title":"Sync","href":"/sync-guide/introduction"}]}]},"basePath":"","title":"Profiles - Help Genie","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":[],"chunks":[]}