Plan, marka, gönderim politikası, çalışma saatleri, SLA, test modu, saklama süresi ve askı durumu döner. Ödeme kimlikleri ve anahtarlar dönmez. Yönetici yetkisi gerekir. Kapsam: organization:read.
Kapsam
organization:read
SDK metodu
getOrganization · get_organization
MCP aracı
getOrganizationsalt okunur
Örnek istek
curl -X GET "https://hiboty.com/api/v1/organization" \
-H "Authorization: Bearer $HIBOTY_API_KEY"
400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.
Yalnız gönderilen alanlar değişir; bir alan geçersizse hiçbiri yazılmaz. test_mode açıkken giden mesajlar kanala gönderilmez; kısa data_retention_days eski konuşma verisini kalıcı siler. campaign_four_eyes (dört göz) API ile yazılamaz: gönderim onay denetimi panelde kalır. Yönetici yetkisi gerekir. Kapsam: organization:write.
Kapsam
organization:write
SDK metodu
updateOrganization · update_organization
MCP aracı
updateOrganizationdış etkiligeri alınamaz
Gövde alanları
Ad
Tür
Zorunlu
Açıklama
name
string
hayır
len 2–80
brand
object
hayır
brand.name
string | null
hayır
len ≤ 60
brand.logo_url
string | null
hayır
https adresi ya da yüklenen görselin path değerilen ≤ 1000
400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.
400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.
Politikanın tamamı değişir: gönderilmeyen liste boşalır, gönderilmeyen sınır kalkar. Değerler sabit dizgidir, düzenli ifade kabul edilmez. Açıksa kampanya ve planlı gönderiler bu kurallarla denetlenir. Yönetici yetkisi gerekir. Kapsam: organization:write.
400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.
400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.
Yalnız gönderilen alanlar değişir. api_key yalnız yazılır, seçili sağlayıcının anahtarıdır ve kaydedilmeden önce sağlayıcıda doğrulanır: geçersizse 400, sağlayıcıya ulaşılamazsa 502. remove_key seçili sağlayıcının anahtarını siler. Sağlayıcı değişip model gönderilmezse o sağlayıcının varsayılan modeli seçilir. Yönetici yetkisi gerekir. Kapsam: organization:write.
400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.
Şifreli anahtarlar dönmez; yalnız credentials_set ve webhook_secret_set döner. Özellik kapalıysa 409 feature_disabled. Yönetici yetkisi gerekir. Kapsam: organization:read.
400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
409İşlem bu durumda yapılamıyor; kod nedeni söyler.feature_disabled
429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.
WooCommerce için key ve secret, Shopify için token gerekir. Adres herkese açık https olmalıdır. Mağazaya gerçek bir test isteği gider; başarısızsa kaydedilmez (400). Gönderilmeyen anahtar ve ayarlar korunur, ancak adres değişirse anahtarlar yeniden gönderilmelidir. Özellik kapalıysa 409 feature_disabled. Yönetici yetkisi gerekir. Kapsam: organization:write.
400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
409İşlem bu durumda yapılamıyor; kod nedeni söyler.feature_disabled
429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.
400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
409İşlem bu durumda yapılamıyor; kod nedeni söyler.feature_disabled
429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.
Mağazaya gerçek bir istek gider ve sonuç last_error alanına yazılır; başarısız bağlantı da 200 döner (connected false). Özellik kapalıysa 409 feature_disabled. Yönetici yetkisi gerekir. Kapsam: organization:write.
Kapsam
organization:write
SDK metodu
testStore · test_store
MCP aracı
testStoredış etkili
Parametreler
Ad
Tür
Zorunlu
Açıklama
platformyol
enum
evet
platform kimliğiwoocommerce | shopify
Örnek istek
curl -X POST "https://hiboty.com/api/v1/organization/stores/woocommerce/test" \
-H "Authorization: Bearer $HIBOTY_API_KEY"
400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
409İşlem bu durumda yapılamıyor; kod nedeni söyler.feature_disabled
429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.
HubSpot ve Pipedrive bağlantıları; token dönmez, yalnız token_set döner. Kuyruktaki ve başarısız eşitleme işi sayısı da döner. Yönetici yetkisi gerekir. Kapsam: organization:read.
Kapsam
organization:read
SDK metodu
listCrmConnections · list_crm_connections
MCP aracı
listCrmConnectionssalt okunur
Örnek istek
curl -X GET "https://hiboty.com/api/v1/integrations/crm" \
-H "Authorization: Bearer $HIBOTY_API_KEY"
400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.
Token CRM'e salt okuma isteğiyle sınanır; başarısızsa kaydedilmez (400 crm_connection_failed). HubSpot: private app token'ı. Pipedrive: API token'ı ve company_domain (ör. sirketim.pipedrive.com). Kayıtlı bağlantıda token gönderilmezse kayıtlı token korunur. Token şifreli saklanır ve hiçbir yanıtta dönmez. Kişiler telefon ya da e-postayla eşleşip tek yönlü eşitlenir; devir ve Mini App siparişi not ya da fırsat olarak açılır. Yönetici yetkisi gerekir. Kapsam: organization:write.
Kapsam
organization:write
SDK metodu
saveCrmConnection · save_crm_connection
MCP aracı
saveCrmConnectiondış etkili
Gövde alanları
Ad
Tür
Zorunlu
Açıklama
platform
enum
evet
hubspot | pipedrive
token
string
hayır
HubSpot private app token'ı ya da Pipedrive API token'ılen ≤ 500
company_domain
string
hayır
Yalnız Pipedrive: şirket alt alanılen ≤ 200
field_mapping
object
hayır
field_mapping.tag_field
string | null
hayır
Etiketlerin yazılacağı CRM alanı (HubSpot özellik adı, Pipedrive 40 karakterlik özel alan anahtarı)
field_mapping.email_field
string | null
hayır
Doğrulanmış e-posta yoksa kullanılacak Hiboty özel alan anahtarı
field_mapping.order_as_deal
boolean
hayır
Mini App siparişini fırsat olarak aç (varsayılan true)
field_mapping.deal_stage
string | null
hayır
Fırsat aşaması: HubSpot dealstage iç kimliği, Pipedrive stage_id
400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).crm_connection_failed
401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.
400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.
Kayıtlı token'la CRM'e salt okuma isteği gider; sonuç bağlantının durumuna yazılır. Başarısız bağlantı da 200 döner (connected: false); geçersiz token bağlantıyı status: hata yapar. Yönetici yetkisi gerekir. Kapsam: organization:write.
400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.
Bot kanalları (Telegram, WhatsApp numarası), WhatsApp hesapları, mağaza, CRM, AI araçları, giden webhook'lar, OAuth uygulamaları ve ürün beslemeleri tek listede: tür, ad, durum, son olay ve son hata. Önce sorunlular gelir. Token, App Secret, imza sırrı ve gizli başlık hiçbir zaman dönmez; adreslerin yalnız alan adı döner. Mağaza, CRM, webhook ve OAuth satırları yalnız yöneticiye listelenir; bot erişimi kısıtlı üye yalnız erişebildiği botların bağlantılarını görür. Kapsam: organization:read.
400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.