Returns the plan, brand, sending policy, working hours, SLA, test mode, retention period and suspension state. Billing identifiers and keys aren't returned. Needs admin permission. Scope: organization:read.
Scope
organization:read
SDK method
getOrganization · get_organization
MCP tool
getOrganizationread-only
Example request
curl -X GET "https://hiboty.com/api/v1/organization" \
-H "Authorization: Bearer $HIBOTY_API_KEY"
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.
Only the fields you send change; if one is invalid, nothing is written. While test_mode is on, outgoing messages aren't sent to channels; a short data_retention_days permanently deletes older conversation data. campaign_four_eyes (four-eyes approval) can't be written through the API: sending approval control stays in the dashboard. Needs admin permission. Scope: organization:write.
Scope
organization:write
SDK method
updateOrganization · update_organization
MCP tool
updateOrganizationexternal effectirreversible
Body fields
Name
Type
Required
Description
name
string
no
len 2–80
brand
object
no
brand.name
string | null
no
len ≤ 60
brand.logo_url
string | null
no
https address or the path value of an uploaded imagelen ≤ 1000
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.
The whole policy changes: a list you leave out is emptied and a limit you leave out is removed. Values are plain strings; regular expressions aren't accepted. When on, campaigns and scheduled posts are checked against these rules. Needs admin permission. Scope: organization:write.
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.
Only the fields you send change. api_key is write-only, belongs to the selected provider and is verified with the provider before saving: 400 if invalid, 502 if the provider can't be reached. remove_key deletes the selected provider's key. If the provider changes and no model is sent, that provider's default model is selected. Needs admin permission. Scope: organization:write.
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.
502A channel or external service failed (channel_error).
Encrypted keys aren't returned, only credentials_set and webhook_secret_set. Returns 409 feature_disabled if the feature is off. Needs admin permission. Scope: organization:read.
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
409The action isn't possible in this state; the code gives the reason.feature_disabled
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.
WooCommerce needs key and secret; Shopify needs token. The address must be public https. A real test request goes to the store; if it fails, nothing is saved (400). Keys and settings you leave out are kept, but they must be sent again if the address changes. Returns 409 feature_disabled if the feature is off. Needs admin permission. Scope: organization:write.
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
404The record doesn't exist or this key can't access it (not_found).
409The action isn't possible in this state; the code gives the reason.feature_disabled
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
404The record doesn't exist or this key can't access it (not_found).
409The action isn't possible in this state; the code gives the reason.feature_disabled
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.
A real request goes to the store and the result is written to last_error; a failed connection still returns 200 (connected: false). Returns 409 feature_disabled if the feature is off. Needs admin permission. Scope: organization:write.
Scope
organization:write
SDK method
testStore · test_store
MCP tool
testStoreexternal effect
Parameters
Name
Type
Required
Description
platformpath
enum
yes
Platformwoocommerce | shopify
Example request
curl -X POST "https://hiboty.com/api/v1/organization/stores/woocommerce/test" \
-H "Authorization: Bearer $HIBOTY_API_KEY"
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
404The record doesn't exist or this key can't access it (not_found).
409The action isn't possible in this state; the code gives the reason.feature_disabled
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.
HubSpot and Pipedrive connections; the token is never returned, only token_set. Queued and failed sync job counts are included. Needs admin permission. Scope: organization:read.
Scope
organization:read
SDK method
listCrmConnections · list_crm_connections
MCP tool
listCrmConnectionsread-only
Example request
curl -X GET "https://hiboty.com/api/v1/integrations/crm" \
-H "Authorization: Bearer $HIBOTY_API_KEY"
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.
The token is tested with a read-only request to the CRM; if it fails nothing is saved (400 crm_connection_failed). HubSpot: a private app token. Pipedrive: an API token and company_domain (e.g. mycompany.pipedrive.com). If no token is sent for an existing connection, the saved token is kept. The token is stored encrypted and never returned. Contacts are matched by phone or email and synced one way; handoffs and Mini App orders become notes or deals. Needs admin permission. Scope: organization:write.
Scope
organization:write
SDK method
saveCrmConnection · save_crm_connection
MCP tool
saveCrmConnectionexternal effect
Body fields
Name
Type
Required
Description
platform
enum
yes
hubspot | pipedrive
token
string
no
HubSpot private app token or Pipedrive API tokenlen ≤ 500
company_domain
string
no
Pipedrive only: company subdomainlen ≤ 200
field_mapping
object
no
field_mapping.tag_field
string | null
no
CRM field for tags (HubSpot property name, Pipedrive 40-character custom field key)
field_mapping.email_field
string | null
no
Hiboty custom field key used when there's no verified email
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).crm_connection_failed
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
404The record doesn't exist or this key can't access it (not_found).
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.
A read-only request goes to the CRM with the saved token and the result is written to the connection. A failed connection still returns 200 (connected: false); an invalid token sets status to hata. Needs admin permission. Scope: organization:write.
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
404The record doesn't exist or this key can't access it (not_found).
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.
Bot channels (Telegram, WhatsApp number), WhatsApp accounts, store, CRM, AI tools, outgoing webhooks, OAuth apps and product feeds in one list: kind, name, status, last event and last error. Problems come first. Tokens, App Secrets, signing secrets and secret headers are never returned; addresses only return their host name. Store, CRM, webhook and OAuth rows are listed to admins only; a member with restricted bot access only sees connections of the bots they can access. Scope: organization:read.
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.