Satış API

Satış modülünün tüm işlemleri (31) ve veri modelleri (11): adresler, izinler, girdiler, ön koşullar, olaylar ve örnekler.

Potansiyel müşteriler, onları takip eden aramalar ve size potansiyel müşteri gönderen iş ortakları.

Modül kodu crm · 31 işlem · 11 veri modeli · 27 olay. Bir anahtar ya da token, arkasındaki kişinin bu modülde yapabildiğinden fazlasını asla yapamaz; satır düzeyindeki güvenlik uygulamadakiyle birebir aynıdır. Yetki kapsamları: crm (hepsi), crm:read (yalnız okuma) ya da crm:<yetenek>.

Kaynaklar

KaynakTabloListeleme ve okumaPOSTPATCHDELETE
affiliate_report_linksaffiliate_report_link/api/v1/affiliate_report_links
affiliatesaffiliate/api/v1/affiliatescrm.save_affiliate
call_resultscall_result/api/v1/call_results
call_statusescall_status/api/v1/call_statuses
call_templatescall_template/api/v1/call_templates
callscall/api/v1/calls
lead_cancellationslead_cancellation/api/v1/lead_cancellations
lead_sourceslead_source/api/v1/lead_sources
lead_stageslead_stage/api/v1/lead_stages
leadslead/api/v1/leadscrm.capture_leadcrm.update_leadcrm.archive_lead
lost_reasonslost_reason/api/v1/lost_reasons

Listeler limit (en çok 200), cursor, order (ör. -created_at), fields ve q alır; diğer her sorgu parametresi bir sütun süzgecidir: ?status=paid, ?total[gte]=100, ?id[in]=a,b, ?x=null.

İşlemler

İşlemGereken izinNe yapar
crm.amend_callcrm:writeAramayı düzelt
crm.archive_leadcrm:deletePotansiyel müşteriyi arşivle
crm.assign_leadcrm:writePotansiyel müşteriyi ata
crm.attribute_leadcrm:writePotansiyel müşteriyi bir satış ortağına yaz
crm.cancel_leadcrm:writePotansiyel müşteriyi iptal et
crm.capture_leadcrm:writePotansiyel müşteri aç
crm.create_call_templatecrm:manageArama şablonunu kaydet
crm.deactivate_affiliatecrm:manageSatış ortağını kapat
crm.deactivate_call_templatecrm:manageArama şablonunu kapat
crm.deactivate_lost_reasoncrm:manageKayıp nedenini kapat
crm.export_callscrm:exportAramaları Excel’e aktar
crm.export_leadscrm:exportPotansiyel müşterileri dışa aktar
crm.issue_affiliate_report_linkcrm:manageSatış ortağına rapor bağlantısı gönder
crm.log_callcrm:writeArama kaydet
crm.merge_lost_reasonscrm:manageKayıp nedenlerini birleştir
crm.raise_stale_leadscrm:writeSessiz potansiyel müşterileri işaretle
crm.restore_leadcrm:deletePotansiyel müşteriyi geri yükle
crm.revoke_affiliate_report_linkcrm:manageSatış ortağı rapor bağlantısını kapat
crm.save_affiliatecrm:manageSatış ortağı ekle veya düzenle
crm.score_leadscrm:writeKayıtları puanla
crm.set_call_option_activecrm:manageArama seçeneğini aç veya kapat
crm.set_call_resultcrm:manageArama sonucu ekle veya değiştir
crm.set_call_statuscrm:manageArama durumu ekle veya değiştir
crm.set_lead_sourcecrm:managePotansiyel müşteri kaynağı ekle veya yeniden adlandır
crm.set_lead_source_activecrm:managePotansiyel müşteri kaynağını aç veya kapat
crm.set_lead_stagecrm:writePotansiyel müşteriyi taşı
crm.set_lead_stage_activecrm:manageAşamayı aç veya kapat
crm.set_lead_stage_definitioncrm:manageAşama ekle veya değiştir
crm.set_lost_reasoncrm:manageKayıp nedeni ekle veya yeniden adlandır
crm.start_trialcrm:writeDeneme başlat
crm.update_leadcrm:writePotansiyel müşteriyi düzenle

crm.amend_call

Aramayı düzelt — Kaydedilmiş bir aramayı düzeltir ve otomatik kapatma kuralını yeniden çalıştırır.

Gereken izin crm:write · veriyi değiştirir

POSThttps://app.getera.io/api/v1/calls/{id}/actions/amend_call
API anahtarı ya da OAuth token · crm:write
  • Asıl adres: POST /api/v1/actions/crm.amend_call

Girdi

AlanTürZorunluAçıklama
iduuidevetDoldurulduğu yer: adresteki {id} · Arama · kimliği: call
statusIduuidSonuç · kimliği: call_status
resultIduuidSonuç · kimliği: call_result
notesstringNotlar · en çok 8000
durationMinutesnumberSüre (dakika) · en az 0 · en çok 1440
isImportantbooleanÖnemli
followUpDatedateTakip tarihi
followUpTimestringSaat · en çok 8
followUpNotesstringTakip notları · en çok 4000

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

KodNe zaman reddedilir
call_not_foundArama bulunmalı.
lead_not_foundAramanın potansiyel müşterisi bulunmalı.
call_status_not_availableArama durumu bulunmalı ve aktif olmalı.
call_result_not_availableArama sonucu bulunmalı ve aktif olmalı.
follow_up_in_the_pastTaşınan takip geçmişe düşmemeli.

Yayımladığı olaylar: crm.call_amended, crm.lead_stage_changed, crm.lead_lost

Neye yazar: call (update) — Corrects the call; lead (update) — Re-evaluates the auto-close rule

curl -X POST https://app.getera.io/api/v1/calls/CALL_ID/actions/amend_call \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"statusId":"CALL_STATUS_ID"}'
Yanıt
{
  "ok": true,
  "result": "…",
  "events": [
    "crm.call_amended",
    "crm.lead_stage_changed",
    "crm.lead_lost"
  ]
}
import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.calls.amendCall("CALL_ID", {
  statusId: "CALL_STATUS_ID"
})
era calls amend_call CALL_ID \
  --status-id "CALL_STATUS_ID"
tools/call
{
  "name": "era__crm__amend_call",
  "arguments": {
    "id": "CALL_ID",
    "statusId": "CALL_STATUS_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde crm:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 call_not_found, lead_not_found, call_status_not_available, call_result_not_available, follow_up_in_the_past · 429 çok sık istek

crm.archive_lead

Potansiyel müşteriyi arşivle — Potansiyel müşteriyi veya aramalarını silmeden listelerden çıkarır.

Gereken izin crm:delete · siler ya da geri alınamaz · Era çalıştırırken bir kişiye onaylatır

POSThttps://app.getera.io/api/v1/leads/{id}/actions/archive_lead
API anahtarı ya da OAuth token · crm:delete
  • REST kısayolu: DELETE /api/v1/leads/{id}
  • Asıl adres: POST /api/v1/actions/crm.archive_lead

Girdi

AlanTürZorunluAçıklama
iduuidevetDoldurulduğu yer: adresteki {id} · Potansiyel müşteri · kimliği: lead

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

KodNe zaman reddedilir
lead_not_foundPotansiyel müşteri bulunmalı.
already_archivedPotansiyel müşteri hâlâ aktif olmalı.

Yayımladığı olaylar: crm.lead_archived

Neye yazar: lead (update) — Stamps archived_at

curl -X POST https://app.getera.io/api/v1/leads/LEAD_ID/actions/archive_lead \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'
Yanıt
{
  "ok": true,
  "result": "…",
  "events": [
    "crm.lead_archived"
  ]
}
import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.leads.archiveLead("LEAD_ID")
era leads archive_lead LEAD_ID
tools/call
{
  "name": "era__crm__archive_lead",
  "arguments": {
    "id": "LEAD_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde crm:delete izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 lead_not_found, already_archived · 429 çok sık istek

crm.assign_lead

Potansiyel müşteriyi ata — Potansiyel müşteriye bir sahip verir ya da havuza geri koyar.

Gereken izin crm:write · veriyi değiştirir

POSThttps://app.getera.io/api/v1/leads/{id}/actions/assign_lead
API anahtarı ya da OAuth token · crm:write
  • Asıl adres: POST /api/v1/actions/crm.assign_lead

Girdi

AlanTürZorunluAçıklama
iduuidevetDoldurulduğu yer: adresteki {id} · Potansiyel müşteri · kimliği: lead
userIduuidSahip

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

KodNe zaman reddedilir
lead_not_foundPotansiyel müşteri bulunmalı.
not_a_memberSahip bu çalışma alanının aktif bir üyesi olmalı.

Yayımladığı olaylar: crm.lead_assigned

Neye yazar: lead (update) — Sets the owner

curl -X POST https://app.getera.io/api/v1/leads/LEAD_ID/actions/assign_lead \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"userId":"USER_ID"}'
Yanıt
{
  "ok": true,
  "result": "…",
  "events": [
    "crm.lead_assigned"
  ]
}
import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.leads.assignLead("LEAD_ID", {
  userId: "USER_ID"
})
era leads assign_lead LEAD_ID \
  --user-id "USER_ID"
tools/call
{
  "name": "era__crm__assign_lead",
  "arguments": {
    "id": "LEAD_ID",
    "userId": "USER_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde crm:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 lead_not_found, not_a_member · 429 çok sık istek

crm.attribute_lead

Potansiyel müşteriyi bir satış ortağına yaz — Potansiyel müşteriyi hangi satış ortağının gönderdiğini belirtir; var olan kaydı taşımak onay gerektirir.

Gereken izin crm:write · veriyi değiştirir

POSThttps://app.getera.io/api/v1/leads/{id}/actions/attribute_lead
API anahtarı ya da OAuth token · crm:write
  • Asıl adres: POST /api/v1/actions/crm.attribute_lead

Girdi

AlanTürZorunluAçıklama
iduuidevetDoldurulduğu yer: adresteki {id} · Potansiyel müşteri · kimliği: lead
affiliateIduuidSatış ortağı · kimliği: affiliate
replacebooleanMevcut krediyi taşı

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

KodNe zaman reddedilir
lead_not_foundPotansiyel müşteri bulunmalı.
lead_archivedArşivlenmiş bir potansiyel müşteri önce geri yüklenir.
affiliate_not_foundSatış ortağı bulunmalı ve açık olmalı.
already_attributedKaynağı bir satış ortağından diğerine taşımak onaylanmalı.
unchangedPotansiyel müşteri zaten bu şekilde bir satış ortağına bağlı.

Yayımladığı olaylar: crm.lead_attributed

Neye yazar: lead (update) — Sets who referred the lead

curl -X POST https://app.getera.io/api/v1/leads/LEAD_ID/actions/attribute_lead \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"affiliateId":"AFFILIATE_ID"}'
Yanıt
{
  "ok": true,
  "result": "…",
  "events": [
    "crm.lead_attributed"
  ]
}
import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.leads.attributeLead("LEAD_ID", {
  affiliateId: "AFFILIATE_ID"
})
era leads attribute_lead LEAD_ID \
  --affiliate-id "AFFILIATE_ID"
tools/call
{
  "name": "era__crm__attribute_lead",
  "arguments": {
    "id": "LEAD_ID",
    "affiliateId": "AFFILIATE_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde crm:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 lead_not_found, lead_archived, affiliate_not_found, already_attributed, unchanged · 429 çok sık istek

crm.cancel_lead

Potansiyel müşteriyi iptal et — Müşterinin satın aldıktan sonra vazgeçtiğini kaydeder; iadeyi finans yürütür.

Gereken izin crm:write · siler ya da geri alınamaz · Era çalıştırırken bir kişiye onaylatır

POSThttps://app.getera.io/api/v1/lead_cancellations/actions/cancel_lead
API anahtarı ya da OAuth token · crm:write
  • Asıl adres: POST /api/v1/actions/crm.cancel_lead

Girdi

AlanTürZorunluAçıklama
iduuidevetPotansiyel müşteri · kimliği: lead
reasonstringevetNeden · en çok 2000

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

KodNe zaman reddedilir
lead_not_foundPotansiyel müşteri bulunmalı.
already_cancelledBir potansiyel müşteri bir kez iptal edilir.

Yayımladığı olaylar: crm.lead_cancelled

Neye yazar: lead_cancellation (insert) — Records the cancellation

curl -X POST https://app.getera.io/api/v1/lead_cancellations/actions/cancel_lead \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"id":"LEAD_ID","reason":"Reason"}'
Yanıt
{
  "ok": true,
  "result": "…",
  "events": [
    "crm.lead_cancelled"
  ]
}
import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.leadCancellations.cancelLead({
  id: "LEAD_ID",
  reason: "Reason"
})
era lead_cancellations cancel_lead \
  --id "LEAD_ID" \
  --reason "Reason"
tools/call
{
  "name": "era__crm__cancel_lead",
  "arguments": {
    "id": "LEAD_ID",
    "reason": "Reason"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde crm:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 lead_not_found, already_cancelled · 429 çok sık istek

crm.capture_lead

Potansiyel müşteri aç — Zaten müşteri olarak tanınan biri için bir satış takibi başlatır.

Gereken izin crm:write · veriyi değiştirir

POSThttps://app.getera.io/api/v1/leads/actions/capture_lead
API anahtarı ya da OAuth token · crm:write
  • REST kısayolu: POST /api/v1/leads
  • Asıl adres: POST /api/v1/actions/crm.capture_lead

Girdi

AlanTürZorunluAçıklama
customerIduuidevetKişi · kimliği: customer
sourceIduuidKaynak · kimliği: lead_source
stageIduuidAşama · kimliği: lead_stage
assignedUserIduuidAtanan
assignmentNotestringSahibi için not · en çok 2000
messagestringNe dediler · en çok 4000
affiliateIduuidYönlendiren · kimliği: affiliate
trialDurationDaysnumberDeneme süresi (gün) · en az 0 · en çok 365

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

KodNe zaman reddedilir
customer_not_foundKişi zaten müşteri olarak kayıtlı olmalı.
customer_archivedArşivlenmiş bir kişi takip edilemez.
no_open_stageÇalışma alanının en az bir açık aşaması olmalı.
stage_not_availableAşama bulunmalı ve aktif olmalı.
source_not_availableKaynak bulunmalı ve aktif olmalı.
affiliate_not_foundYönlendiren satış ortağı bulunmalı.

Yayımladığı olaylar: crm.lead_captured

Neye yazar: lead (insert) — Opens the lead

curl -X POST https://app.getera.io/api/v1/leads/actions/capture_lead \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"customerId":"CUSTOMER_ID"}'
Yanıt
{
  "ok": true,
  "result": "…",
  "events": [
    "crm.lead_captured"
  ]
}
import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.leads.create({
  customerId: "CUSTOMER_ID"
})
era leads create \
  --customer-id "CUSTOMER_ID"
tools/call
{
  "name": "era__crm__capture_lead",
  "arguments": {
    "customerId": "CUSTOMER_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde crm:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 customer_not_found, customer_archived, no_open_stage, stage_not_available, source_not_available, affiliate_not_found · 429 çok sık istek

crm.create_call_template

Arama şablonunu kaydet — Arama formunun hızlıca ekleyebileceği kısa bir not — yeni, ya da düzenlenip yeniden açılan bir tane.

Gereken izin crm:manage · veriyi değiştirir

POSThttps://app.getera.io/api/v1/call_templates/{id}/actions/create_call_template
API anahtarı ya da OAuth token · crm:manage
  • Asıl adres: POST /api/v1/actions/crm.create_call_template

Girdi

AlanTürZorunluAçıklama
iduuidDoldurulduğu yer: adresteki {id} · Şablon · kimliği: call_template
namestringevetAd · en çok 255
templateTextstringevetMetin · en çok 8000
isActivebooleanKullanımda

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

KodNe zaman reddedilir
not_foundDüzenlenen şablon mevcut olmalı.

Yayımladığı olaylar: crm.call_template_changed

Neye yazar: call_template (insert) — Adds the template; call_template (update) — Or rewrites an existing one, opening or closing it

curl -X POST https://app.getera.io/api/v1/call_templates/CALL_TEMPLATE_ID/actions/create_call_template \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"name":"Name","templateText":"Text"}'
Yanıt
{
  "ok": true,
  "result": "…",
  "events": [
    "crm.call_template_changed"
  ]
}
import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.callTemplates.createCallTemplate("CALL_TEMPLATE_ID", {
  name: "Name",
  templateText: "Text"
})
era call_templates create_call_template CALL_TEMPLATE_ID \
  --name "Name" \
  --template-text "Text"
tools/call
{
  "name": "era__crm__create_call_template",
  "arguments": {
    "id": "CALL_TEMPLATE_ID",
    "name": "Name",
    "templateText": "Text"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde crm:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_found · 429 çok sık istek

crm.deactivate_affiliate

Satış ortağını kapat — Yeni yönlendirmeleri durdurur; açık potansiyel müşteriler kaynak bilgisini korur.

Gereken izin crm:manage · dışarıya ulaşır (gönderir, yayımlar ya da ücret alır) · Era çalıştırırken bir kişiye onaylatır

POSThttps://app.getera.io/api/v1/affiliates/{id}/actions/deactivate_affiliate
API anahtarı ya da OAuth token · crm:manage
  • Asıl adres: POST /api/v1/actions/crm.deactivate_affiliate

Girdi

AlanTürZorunluAçıklama
iduuidevetDoldurulduğu yer: adresteki {id} · Satış ortağı · kimliği: affiliate

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

KodNe zaman reddedilir
not_foundSatış ortağı bulunmalı.
already_archivedSatış ortağı hâlâ açık olmalı.

Yayımladığı olaylar: crm.affiliate_deactivated

Neye yazar: affiliate (update) — Closes the affiliate

curl -X POST https://app.getera.io/api/v1/affiliates/AFFILIATE_ID/actions/deactivate_affiliate \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'
Yanıt
{
  "ok": true,
  "result": "…",
  "events": [
    "crm.affiliate_deactivated"
  ]
}
import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.affiliates.deactivateAffiliate("AFFILIATE_ID")
era affiliates deactivate_affiliate AFFILIATE_ID
tools/call
{
  "name": "era__crm__deactivate_affiliate",
  "arguments": {
    "id": "AFFILIATE_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde crm:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_found, already_archived · 429 çok sık istek

crm.deactivate_call_template

Arama şablonunu kapat — Şablonu seçiciden çıkarır.

Gereken izin crm:manage · veriyi değiştirir

POSThttps://app.getera.io/api/v1/call_templates/{id}/actions/deactivate_call_template
API anahtarı ya da OAuth token · crm:manage
  • Asıl adres: POST /api/v1/actions/crm.deactivate_call_template

Girdi

AlanTürZorunluAçıklama
iduuidevetDoldurulduğu yer: adresteki {id} · Şablon · kimliği: call_template

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

KodNe zaman reddedilir
not_foundŞablon bulunmalı.
already_inactiveŞablon hâlâ açık olmalı.

Yayımladığı olaylar: crm.call_template_changed

Neye yazar: call_template (update) — Closes the template

curl -X POST https://app.getera.io/api/v1/call_templates/CALL_TEMPLATE_ID/actions/deactivate_call_template \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'
Yanıt
{
  "ok": true,
  "result": "…",
  "events": [
    "crm.call_template_changed"
  ]
}
import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.callTemplates.deactivateCallTemplate("CALL_TEMPLATE_ID")
era call_templates deactivate_call_template CALL_TEMPLATE_ID
tools/call
{
  "name": "era__crm__deactivate_call_template",
  "arguments": {
    "id": "CALL_TEMPLATE_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde crm:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_found, already_inactive · 429 çok sık istek

crm.deactivate_lost_reason

Kayıp nedenini kapat — Nedeni, onu kullanan potansiyel müşterilere dokunmadan seçiciden çıkarır.

Gereken izin crm:manage · veriyi değiştirir

POSThttps://app.getera.io/api/v1/lost_reasons/{id}/actions/deactivate_lost_reason
API anahtarı ya da OAuth token · crm:manage
  • Asıl adres: POST /api/v1/actions/crm.deactivate_lost_reason

Girdi

AlanTürZorunluAçıklama
iduuidevetDoldurulduğu yer: adresteki {id} · Neden · kimliği: lost_reason

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

KodNe zaman reddedilir
not_foundNeden bulunmalı.
already_inactiveNeden hâlâ açık olmalı.

Yayımladığı olaylar: crm.lost_reason_changed

Neye yazar: lost_reason (update) — Closes the reason

curl -X POST https://app.getera.io/api/v1/lost_reasons/LOST_REASON_ID/actions/deactivate_lost_reason \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'
Yanıt
{
  "ok": true,
  "result": "…",
  "events": [
    "crm.lost_reason_changed"
  ]
}
import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.lostReasons.deactivateLostReason("LOST_REASON_ID")
era lost_reasons deactivate_lost_reason LOST_REASON_ID
tools/call
{
  "name": "era__crm__deactivate_lost_reason",
  "arguments": {
    "id": "LOST_REASON_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde crm:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_found, already_inactive · 429 çok sık istek

crm.export_calls

Aramaları Excel’e aktar — Arama kaydını, her arayan için bir sayfa olacak şekilde tek bir çalışma kitabında verir.

Gereken izin crm:export · dışarıya ulaşır (gönderir, yayımlar ya da ücret alır)

POSThttps://app.getera.io/api/v1/actions/crm.export_calls
API anahtarı ya da OAuth token · crm:export

Girdi

AlanTürZorunluAçıklama
outcomeuuidSonuç · kimliği: call_status
callerstringArayan · en çok 64
fromdateArama başlangıcı
todateArama bitişi

Yayımladığı olaylar: crm.calls_exported

curl -X POST https://app.getera.io/api/v1/actions/crm.export_calls \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"outcome":"CALL_STATUS_ID"}'
Yanıt
{
  "ok": true,
  "result": "…",
  "events": [
    "crm.calls_exported"
  ]
}
import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.actions.run("crm.export_calls", {
  outcome: "CALL_STATUS_ID"
})
era crm export_calls \
  --outcome "CALL_STATUS_ID"
tools/call
{
  "name": "era__crm__export_calls",
  "arguments": {
    "outcome": "CALL_STATUS_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde crm:export izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 429 çok sık istek

crm.export_leads

Potansiyel müşterileri dışa aktar — Filtrelenmiş potansiyel müşteri listesi, satırlar hâlinde — potansiyel müşteriler ekranı bunu CSV’ye çevirir.

Gereken izin crm:export · dışarıya ulaşır (gönderir, yayımlar ya da ücret alır)

POSThttps://app.getera.io/api/v1/actions/crm.export_leads
API anahtarı ya da OAuth token · crm:export

Girdi

AlanTürZorunluAçıklama
viewstring (enum)Görüntüle · İzin verilen değerler: all, trials, recurring, today, tomorrow, overdue, never, archived
qstringAra · en çok 200
stageIduuidAşama · kimliği: lead_stage
sourceIduuidKaynak · kimliği: lead_source
ownerIdstringSahip · en çok 64
createdFromdateEklenme başlangıcı
createdTodateEklenme bitişi
leadIdsobject / arrayYalnızca bu potansiyel müşteriler

Yayımladığı olaylar: crm.leads_exported

curl -X POST https://app.getera.io/api/v1/actions/crm.export_leads \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"view":"all"}'
Yanıt
{
  "ok": true,
  "result": "…",
  "events": [
    "crm.leads_exported"
  ]
}
import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.actions.run("crm.export_leads", {
  view: "all"
})
era crm export_leads \
  --view "all"
tools/call
{
  "name": "era__crm__export_leads",
  "arguments": {
    "view": "all"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde crm:export izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 429 çok sık istek

Satış ortağına rapor bağlantısı gönder — Satış ortağının giriş yapmadan potansiyel müşterilerini ve komisyonunu görebildiği bir bağlantı. Bir kez gösterilir.

Gereken izin crm:manage · veriyi değiştirir

POSThttps://app.getera.io/api/v1/affiliate_report_links/actions/issue_affiliate_report_link
API anahtarı ya da OAuth token · crm:manage
  • Asıl adres: POST /api/v1/actions/crm.issue_affiliate_report_link
AlanTürZorunluAçıklama
affiliateIduuidevetSatış ortağı · kimliği: affiliate
purposestring (enum)Bağlantının amacı · İzin verilen değerler: report, referral
expiresInDaysnumberAçık kalma süresi (gün) · en az 1 · en çok 365

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

KodNe zaman reddedilir
affiliate_not_foundSatış ortağı bulunmalı ve açık olmalı.

Yayımladığı olaylar: crm.affiliate_report_link_issued

Neye yazar: affiliate_report_link (insert) — Stores the hash of a new token

curl -X POST https://app.getera.io/api/v1/affiliate_report_links/actions/issue_affiliate_report_link \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"affiliateId":"AFFILIATE_ID"}'
Yanıt
{
  "ok": true,
  "result": "…",
  "events": [
    "crm.affiliate_report_link_issued"
  ]
}
import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.affiliateReportLinks.issueAffiliateReportLink({
  affiliateId: "AFFILIATE_ID"
})
era affiliate_report_links issue_affiliate_report_link \
  --affiliate-id "AFFILIATE_ID"
tools/call
{
  "name": "era__crm__issue_affiliate_report_link",
  "arguments": {
    "affiliateId": "AFFILIATE_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde crm:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 affiliate_not_found · 429 çok sık istek

crm.log_call

Arama kaydet — Bir aramayı kaydeder — art arda üçüncü başarısızlıksa potansiyel müşteriyi kapatır.

Gereken izin crm:write · veriyi değiştirir

POSThttps://app.getera.io/api/v1/leads/{id}/actions/log_call
API anahtarı ya da OAuth token · crm:write
  • Asıl adres: POST /api/v1/actions/crm.log_call

Girdi

AlanTürZorunluAçıklama
leadIduuidevetDoldurulduğu yer: adresteki {id} · Potansiyel müşteri · kimliği: lead
statusIduuidevetSonuç · kimliği: call_status
resultIduuidevetSonuç · kimliği: call_result
durationMinutesnumberSüre (dakika) · en az 0 · en çok 1440
notesstringNotlar · en çok 8000
isImportantbooleanÖnemli
followUpDatedateTakip tarihi
followUpTimestringSaat · en çok 8
followUpNotesstringTakip notları · en çok 4000

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

KodNe zaman reddedilir
lead_not_foundPotansiyel müşteri bulunmalı.
lead_archivedArşivlenmiş bir potansiyel müşteriye arama kaydedilmez.
call_status_not_availableArama durumu bulunmalı ve aktif olmalı.
call_result_not_availableArama sonucu bulunmalı ve aktif olmalı.
follow_up_in_the_pastTakip geçmişe planlanmamalı.

Yayımladığı olaylar: crm.call_logged, crm.lead_stage_changed, crm.lead_lost

Neye yazar: call (insert) — Records the call; lead (update) — Closes the lead on the Nth consecutive failure

curl -X POST https://app.getera.io/api/v1/leads/LEAD_ID/actions/log_call \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"statusId":"CALL_STATUS_ID","resultId":"CALL_RESULT_ID"}'
Yanıt
{
  "ok": true,
  "result": "…",
  "events": [
    "crm.call_logged",
    "crm.lead_stage_changed",
    "crm.lead_lost"
  ]
}
import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.leads.logCall("LEAD_ID", {
  statusId: "CALL_STATUS_ID",
  resultId: "CALL_RESULT_ID"
})
era leads log_call LEAD_ID \
  --status-id "CALL_STATUS_ID" \
  --result-id "CALL_RESULT_ID"
tools/call
{
  "name": "era__crm__log_call",
  "arguments": {
    "leadId": "LEAD_ID",
    "statusId": "CALL_STATUS_ID",
    "resultId": "CALL_RESULT_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde crm:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 lead_not_found, lead_archived, call_status_not_available, call_result_not_available, follow_up_in_the_past · 429 çok sık istek

crm.merge_lost_reasons

Kayıp nedenlerini birleştir — Birkaç nedenle kaydedilmiş tüm potansiyel müşterileri tek nedene taşır, sonra diğerlerini kapatır.

Gereken izin crm:manage · siler ya da geri alınamaz

POSThttps://app.getera.io/api/v1/lost_reasons/{id}/actions/merge_lost_reasons
API anahtarı ya da OAuth token · crm:manage
  • Asıl adres: POST /api/v1/actions/crm.merge_lost_reasons

Girdi

AlanTürZorunluAçıklama
sourceIdsobject / arrayevetBirleştirilecek nedenler
targetIduuidevetDoldurulduğu yer: adresteki {id} · Bunu tut · kimliği: lost_reason

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

KodNe zaman reddedilir
invalid_sourcesHedef dışında en az bir neden seçilmeli.
target_not_foundHer şeyin taşınacağı neden açık olmalı.

Yayımladığı olaylar: crm.lost_reason_changed

Neye yazar: lead (update) — Re-files the leads onto the surviving reason; lost_reason (update) — Closes the reasons that were folded in

curl -X POST https://app.getera.io/api/v1/lost_reasons/LOST_REASON_ID/actions/merge_lost_reasons \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"sourceIds":{}}'
Yanıt
{
  "ok": true,
  "result": "…",
  "events": [
    "crm.lost_reason_changed"
  ]
}
import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.lostReasons.mergeLostReasons("LOST_REASON_ID", {
  sourceIds: {}
})
era lost_reasons merge_lost_reasons LOST_REASON_ID --data '{"sourceIds":{}}'
tools/call
{
  "name": "era__crm__merge_lost_reasons",
  "arguments": {
    "targetId": "LOST_REASON_ID",
    "sourceIds": {}
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde crm:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 invalid_sources, target_not_found · 429 çok sık istek

crm.raise_stale_leads

Sessiz potansiyel müşterileri işaretle — Günlük iş: süre boyunca hareket etmeyen her açık potansiyel müşteri bir kez bildirilir.

Gereken izin crm:write · veriyi değiştirir

Era’nın kendi çalıştırdığı bir işlem. Başvuru eksiksiz olsun diye listelenir; API anahtarı ya da token ile istek reddedilir (403 machine_only).
POSThttps://app.getera.io/api/v1/leads/actions/raise_stale_leads
API anahtarı ya da OAuth token · crm:write
  • Asıl adres: POST /api/v1/actions/crm.raise_stale_leads

Girdi

Bu işlem girdi almaz.

Yayımladığı olaylar: crm.lead_stale

Neye yazar: lead (update) — Records that the lead was flagged as quiet

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde crm:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 429 çok sık istek

crm.restore_lead

Potansiyel müşteriyi geri yükle — Arşivlenmiş bir potansiyel müşteriyi geri getirir.

Gereken izin crm:delete · veriyi değiştirir

POSThttps://app.getera.io/api/v1/leads/{id}/actions/restore_lead
API anahtarı ya da OAuth token · crm:delete
  • Asıl adres: POST /api/v1/actions/crm.restore_lead

Girdi

AlanTürZorunluAçıklama
iduuidevetDoldurulduğu yer: adresteki {id} · Potansiyel müşteri · kimliği: lead

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

KodNe zaman reddedilir
lead_not_foundPotansiyel müşteri bulunmalı.
not_archivedPotansiyel müşteri arşivlenmiş olmalı.

Yayımladığı olaylar: crm.lead_restored

Neye yazar: lead (update) — Clears archived_at

curl -X POST https://app.getera.io/api/v1/leads/LEAD_ID/actions/restore_lead \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'
Yanıt
{
  "ok": true,
  "result": "…",
  "events": [
    "crm.lead_restored"
  ]
}
import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.leads.restoreLead("LEAD_ID")
era leads restore_lead LEAD_ID
tools/call
{
  "name": "era__crm__restore_lead",
  "arguments": {
    "id": "LEAD_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde crm:delete izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 lead_not_found, not_archived · 429 çok sık istek

Satış ortağı rapor bağlantısını kapat — Bağlantı hemen çalışmaz olur; satış ortağına yenisi gönderilebilir.

Gereken izin crm:manage · siler ya da geri alınamaz · Era çalıştırırken bir kişiye onaylatır

POSThttps://app.getera.io/api/v1/affiliate_report_links/{id}/actions/revoke_affiliate_report_link
API anahtarı ya da OAuth token · crm:manage
  • Asıl adres: POST /api/v1/actions/crm.revoke_affiliate_report_link
AlanTürZorunluAçıklama
iduuidevetDoldurulduğu yer: adresteki {id} · Bağlantı · kimliği: affiliate_report_link

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

KodNe zaman reddedilir
not_foundBağlantı bulunmalı.
already_revokedBağlantı hâlâ açık olmalı.

Yayımladığı olaylar: crm.affiliate_report_link_revoked

Neye yazar: affiliate_report_link (update) — Stamps it revoked

curl -X POST https://app.getera.io/api/v1/affiliate_report_links/AFFILIATE_REPORT_LINK_ID/actions/revoke_affiliate_report_link \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'
Yanıt
{
  "ok": true,
  "result": "…",
  "events": [
    "crm.affiliate_report_link_revoked"
  ]
}
import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.affiliateReportLinks.revokeAffiliateReportLink("AFFILIATE_REPORT_LINK_ID")
era affiliate_report_links revoke_affiliate_report_link AFFILIATE_REPORT_LINK_ID
tools/call
{
  "name": "era__crm__revoke_affiliate_report_link",
  "arguments": {
    "id": "AFFILIATE_REPORT_LINK_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde crm:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_found, already_revoked · 429 çok sık istek

crm.save_affiliate

Satış ortağı ekle veya düzenle — Yönlendirme kanalı ve anlaşılan koşullar.

Gereken izin crm:manage · veriyi değiştirir

POSThttps://app.getera.io/api/v1/affiliates/{id}/actions/save_affiliate
API anahtarı ya da OAuth token · crm:manage
  • REST kısayolu: PATCH /api/v1/affiliates/{id}
  • Asıl adres: POST /api/v1/actions/crm.save_affiliate

Girdi

AlanTürZorunluAçıklama
iduuidDoldurulduğu yer: adresteki {id} · Satış ortağı · kimliği: affiliate
namestringevetAd · en çok 200
emailemailE-posta
phonephoneTelefon
commissionTypestring (enum)evetKomisyon türü · İzin verilen değerler: percentage, fixed
commissionRatenumberOran (%) · en az 0 · en çok 100
fixedCommissionAmountnumber (money)Sabit tutar · en az 0
commissionCurrencystringPara birimi · en çok 3
commissionAccrualModestring (enum)Kazanılan · İzin verilen değerler: proportional, on_sale, on_full_collection
notesstringNotlar · en çok 4000

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

KodNe zaman reddedilir
no_contactSatış ortağının bir e-posta adresi veya telefon numarası olmalı.
rate_requiredYüzdelik anlaşma bir oran gerektirir.
amount_requiredSabit anlaşma bir tutar gerektirir.

Yayımladığı olaylar: crm.affiliate_created, crm.affiliate_updated

Neye yazar: affiliate (upsert) — Writes the affiliate

curl -X POST https://app.getera.io/api/v1/affiliates/AFFILIATE_ID/actions/save_affiliate \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"name":"Name","commissionType":"percentage"}'
Yanıt
{
  "ok": true,
  "result": "…",
  "events": [
    "crm.affiliate_created",
    "crm.affiliate_updated"
  ]
}
import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.affiliates.saveAffiliate("AFFILIATE_ID", {
  name: "Name",
  commissionType: "percentage"
})
era affiliates save_affiliate AFFILIATE_ID \
  --name "Name" \
  --commission-type "percentage"
tools/call
{
  "name": "era__crm__save_affiliate",
  "arguments": {
    "id": "AFFILIATE_ID",
    "name": "Name",
    "commissionType": "percentage"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde crm:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 no_contact, rate_required, amount_required · 429 çok sık istek

crm.score_leads

Kayıtları puanla — Her açık kayda iletişim bilgisi, aşama, aramalar, tutar ve güncelliğe göre 0–100 arası bir puan ve gerekçelerini verir.

Gereken izin crm:write · veriyi değiştirir

POSThttps://app.getera.io/api/v1/leads/actions/score_leads
API anahtarı ya da OAuth token · crm:write
  • Asıl adres: POST /api/v1/actions/crm.score_leads

Girdi

AlanTürZorunluAçıklama
leadIdsobject / arrayYalnızca bu potansiyel müşteriler

Yayımladığı olaylar: crm.leads_scored

Neye yazar: lead (update) — Writes score, score_reasons and scored_at

curl -X POST https://app.getera.io/api/v1/leads/actions/score_leads \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"leadIds":{}}'
Yanıt
{
  "ok": true,
  "result": "…",
  "events": [
    "crm.leads_scored"
  ]
}
import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.leads.scoreLeads({
  leadIds: {}
})
era leads score_leads --data '{"leadIds":{}}'
tools/call
{
  "name": "era__crm__score_leads",
  "arguments": {
    "leadIds": {}
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde crm:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 429 çok sık istek

crm.set_call_option_active

Arama seçeneğini aç veya kapat — Bir arama durumu veya sonucunu, onu kullanan aramalara dokunmadan seçiciden çıkarır.

Gereken izin crm:manage · veriyi değiştirir

POSThttps://app.getera.io/api/v1/call_statuses/actions/set_call_option_active
API anahtarı ya da OAuth token · crm:manage
  • Asıl adres: POST /api/v1/actions/crm.set_call_option_active

Girdi

AlanTürZorunluAçıklama
tablestring (enum)evetSözlük · İzin verilen değerler: call_status, call_result
iduuidevetSeçenek
activebooleanevetAç

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

KodNe zaman reddedilir
not_foundSeçenek bulunmalı.
already_in_that_stateSeçenek zaten açık ya da zaten kapalı.

Yayımladığı olaylar: crm.call_dictionary_changed

Neye yazar: call_status (update) — Opens or closes the outcome; call_result (update) — Opens or closes the result

curl -X POST https://app.getera.io/api/v1/call_statuses/actions/set_call_option_active \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"table":"call_status","id":"ID_ID","active":true}'
Yanıt
{
  "ok": true,
  "result": "…",
  "events": [
    "crm.call_dictionary_changed"
  ]
}
import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.callStatuses.setCallOptionActive({
  table: "call_status",
  id: "ID_ID",
  active: true
})
era call_statuses set_call_option_active \
  --table "call_status" \
  --id "ID_ID" \
  --active true
tools/call
{
  "name": "era__crm__set_call_option_active",
  "arguments": {
    "table": "call_status",
    "id": "ID_ID",
    "active": true
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde crm:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_found, already_in_that_state · 429 çok sık istek

crm.set_call_result

Arama sonucu ekle veya değiştir — Arama sonuçlarını ve her birinin potansiyel müşteri lehine mi aleyhine mi sayıldığını yönetir.

Gereken izin crm:manage · veriyi değiştirir

POSThttps://app.getera.io/api/v1/call_results/{id}/actions/set_call_result
API anahtarı ya da OAuth token · crm:manage
  • Asıl adres: POST /api/v1/actions/crm.set_call_result

Girdi

AlanTürZorunluAçıklama
iduuidDoldurulduğu yer: adresteki {id} · Sonuç · kimliği: call_result
keystringevetAnahtar · en çok 50
namestringevetAd · en çok 255
behaviorstring (enum)evetSayıldığı tür · İzin verilen değerler: positive, neutral, negative

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

KodNe zaman reddedilir
key_takenİki arama sonucu aynı anahtarı paylaşamaz.

Yayımladığı olaylar: crm.call_dictionary_changed

Neye yazar: call_result (upsert) — Writes the result

curl -X POST https://app.getera.io/api/v1/call_results/CALL_RESULT_ID/actions/set_call_result \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"key":"Key","name":"Name","behavior":"positive"}'
Yanıt
{
  "ok": true,
  "result": "…",
  "events": [
    "crm.call_dictionary_changed"
  ]
}
import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.callResults.setCallResult("CALL_RESULT_ID", {
  key: "Key",
  name: "Name",
  behavior: "positive"
})
era call_results set_call_result CALL_RESULT_ID \
  --key "Key" \
  --name "Name" \
  --behavior "positive"
tools/call
{
  "name": "era__crm__set_call_result",
  "arguments": {
    "id": "CALL_RESULT_ID",
    "key": "Key",
    "name": "Name",
    "behavior": "positive"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde crm:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 key_taken · 429 çok sık istek

crm.set_call_status

Arama durumu ekle veya değiştir — Arama durumlarını ve her birinin birine ulaşmış sayılıp sayılmadığını yönetir.

Gereken izin crm:manage · veriyi değiştirir

POSThttps://app.getera.io/api/v1/call_statuses/{id}/actions/set_call_status
API anahtarı ya da OAuth token · crm:manage
  • Asıl adres: POST /api/v1/actions/crm.set_call_status

Girdi

AlanTürZorunluAçıklama
iduuidDoldurulduğu yer: adresteki {id} · Sonuç · kimliği: call_status
keystringevetAnahtar · en çok 50
namestringevetAd · en çok 255
behaviorstring (enum)evetSayıldığı tür · İzin verilen değerler: reached, not_reached

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

KodNe zaman reddedilir
key_takenİki arama durumu aynı anahtarı paylaşamaz.

Yayımladığı olaylar: crm.call_dictionary_changed

Neye yazar: call_status (upsert) — Writes the outcome

curl -X POST https://app.getera.io/api/v1/call_statuses/CALL_STATUSE_ID/actions/set_call_status \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"key":"Key","name":"Name","behavior":"reached"}'
Yanıt
{
  "ok": true,
  "result": "…",
  "events": [
    "crm.call_dictionary_changed"
  ]
}
import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.callStatuses.setCallStatus("CALL_STATUSE_ID", {
  key: "Key",
  name: "Name",
  behavior: "reached"
})
era call_statuses set_call_status CALL_STATUSE_ID \
  --key "Key" \
  --name "Name" \
  --behavior "reached"
tools/call
{
  "name": "era__crm__set_call_status",
  "arguments": {
    "id": "CALL_STATUSE_ID",
    "key": "Key",
    "name": "Name",
    "behavior": "reached"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde crm:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 key_taken · 429 çok sık istek

crm.set_lead_source

Potansiyel müşteri kaynağı ekle veya yeniden adlandır — Potansiyel müşterilerin nereden geldiğini yönetir — 25 farklı yazım yerine kanal başına tek satır.

Gereken izin crm:manage · veriyi değiştirir

POSThttps://app.getera.io/api/v1/lead_sources/{id}/actions/set_lead_source
API anahtarı ya da OAuth token · crm:manage
  • Asıl adres: POST /api/v1/actions/crm.set_lead_source

Girdi

AlanTürZorunluAçıklama
iduuidDoldurulduğu yer: adresteki {id} · Kaynak · kimliği: lead_source
keystringevetAnahtar · en çok 50
namestringevetAd · en çok 255
displayOrdernumberSipariş · en az 0

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

KodNe zaman reddedilir
key_takenİki kaynak aynı anahtarı paylaşamaz.

Yayımladığı olaylar: crm.lead_source_changed

Neye yazar: lead_source (upsert) — Writes the source

curl -X POST https://app.getera.io/api/v1/lead_sources/LEAD_SOURCE_ID/actions/set_lead_source \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"key":"Key","name":"Name"}'
Yanıt
{
  "ok": true,
  "result": "…",
  "events": [
    "crm.lead_source_changed"
  ]
}
import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.leadSources.setLeadSource("LEAD_SOURCE_ID", {
  key: "Key",
  name: "Name"
})
era lead_sources set_lead_source LEAD_SOURCE_ID \
  --key "Key" \
  --name "Name"
tools/call
{
  "name": "era__crm__set_lead_source",
  "arguments": {
    "id": "LEAD_SOURCE_ID",
    "key": "Key",
    "name": "Name"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde crm:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 key_taken · 429 çok sık istek

crm.set_lead_source_active

Potansiyel müşteri kaynağını aç veya kapat — Bir kanalı, oradan gelen potansiyel müşterilere dokunmadan seçicilerden çıkarır.

Gereken izin crm:manage · veriyi değiştirir

POSThttps://app.getera.io/api/v1/lead_sources/{id}/actions/set_lead_source_active
API anahtarı ya da OAuth token · crm:manage
  • Asıl adres: POST /api/v1/actions/crm.set_lead_source_active

Girdi

AlanTürZorunluAçıklama
iduuidevetDoldurulduğu yer: adresteki {id} · Kaynak · kimliği: lead_source
activebooleanevetAç

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

KodNe zaman reddedilir
not_foundKaynak bulunmalı.
already_in_that_stateKaynak zaten açık ya da zaten kapalı.

Yayımladığı olaylar: crm.lead_source_changed

Neye yazar: lead_source (update) — Opens or closes the source

curl -X POST https://app.getera.io/api/v1/lead_sources/LEAD_SOURCE_ID/actions/set_lead_source_active \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"active":true}'
Yanıt
{
  "ok": true,
  "result": "…",
  "events": [
    "crm.lead_source_changed"
  ]
}
import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.leadSources.setLeadSourceActive("LEAD_SOURCE_ID", {
  active: true
})
era lead_sources set_lead_source_active LEAD_SOURCE_ID \
  --active true
tools/call
{
  "name": "era__crm__set_lead_source_active",
  "arguments": {
    "id": "LEAD_SOURCE_ID",
    "active": true
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde crm:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_found, already_in_that_state · 429 çok sık istek

crm.set_lead_stage

Potansiyel müşteriyi taşı — Potansiyel müşteriyi başka bir aşamaya taşır; aşama son aşamaysa kapatır.

Gereken izin crm:write · veriyi değiştirir

POSThttps://app.getera.io/api/v1/leads/{id}/actions/set_lead_stage
API anahtarı ya da OAuth token · crm:write
  • Asıl adres: POST /api/v1/actions/crm.set_lead_stage

Girdi

AlanTürZorunluAçıklama
iduuidevetDoldurulduğu yer: adresteki {id} · Potansiyel müşteri · kimliği: lead
stageIduuidevetAşama · kimliği: lead_stage
lostReasonIduuidNeden · kimliği: lost_reason

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

KodNe zaman reddedilir
lead_not_foundPotansiyel müşteri bulunmalı.
lead_archivedArşivlenmiş bir potansiyel müşteri taşınmadan önce geri yüklenir.
stage_not_availableAşama bulunmalı ve aktif olmalı.
lost_reason_requiredBir potansiyel müşteriyi kaybedildi olarak kapatmak bir neden gerektirir.
lost_reason_not_availableNeden bulunmalı ve aktif olmalı.

Yayımladığı olaylar: crm.lead_stage_changed, crm.lead_won, crm.lead_lost

Neye yazar: lead (update) — Moves the lead and stamps its closure

curl -X POST https://app.getera.io/api/v1/leads/LEAD_ID/actions/set_lead_stage \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"stageId":"LEAD_STAGE_ID"}'
Yanıt
{
  "ok": true,
  "result": "…",
  "events": [
    "crm.lead_stage_changed",
    "crm.lead_won",
    "crm.lead_lost"
  ]
}
import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.leads.setLeadStage("LEAD_ID", {
  stageId: "LEAD_STAGE_ID"
})
era leads set_lead_stage LEAD_ID \
  --stage-id "LEAD_STAGE_ID"
tools/call
{
  "name": "era__crm__set_lead_stage",
  "arguments": {
    "id": "LEAD_ID",
    "stageId": "LEAD_STAGE_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde crm:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 lead_not_found, lead_archived, stage_not_available, lost_reason_required, lost_reason_not_available · 429 çok sık istek

crm.set_lead_stage_active

Aşamayı aç veya kapat — Aşamayı seçicilerden çıkarır; o aşamadaki potansiyel müşteriler orada kalır.

Gereken izin crm:manage · veriyi değiştirir

POSThttps://app.getera.io/api/v1/lead_stages/{id}/actions/set_lead_stage_active
API anahtarı ya da OAuth token · crm:manage
  • Asıl adres: POST /api/v1/actions/crm.set_lead_stage_active

Girdi

AlanTürZorunluAçıklama
iduuidevetDoldurulduğu yer: adresteki {id} · Aşama · kimliği: lead_stage
activebooleanevetAç

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

KodNe zaman reddedilir
not_foundAşama bulunmalı.
already_in_that_stateAşama zaten açık ya da zaten kapalı.
last_terminal_stageBir çalışma alanında en az bir kazanıldı ve bir kaybedildi aşaması kalır.
last_open_stageBir çalışma alanında yeni potansiyel müşteriler için en az bir açık aşama kalır.

Yayımladığı olaylar: crm.lead_stage_definition_changed

Neye yazar: lead_stage (update) — Opens or closes the stage

curl -X POST https://app.getera.io/api/v1/lead_stages/LEAD_STAGE_ID/actions/set_lead_stage_active \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"active":true}'
Yanıt
{
  "ok": true,
  "result": "…",
  "events": [
    "crm.lead_stage_definition_changed"
  ]
}
import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.leadStages.setLeadStageActive("LEAD_STAGE_ID", {
  active: true
})
era lead_stages set_lead_stage_active LEAD_STAGE_ID \
  --active true
tools/call
{
  "name": "era__crm__set_lead_stage_active",
  "arguments": {
    "id": "LEAD_STAGE_ID",
    "active": true
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde crm:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_found, already_in_that_state, last_terminal_stage, last_open_stage · 429 çok sık istek

crm.set_lead_stage_definition

Aşama ekle veya değiştir — Satış hattını yönetir — en az bir kazanıldı ve bir kaybedildi aşaması bırakır.

Gereken izin crm:manage · veriyi değiştirir

POSThttps://app.getera.io/api/v1/lead_stages/{id}/actions/set_lead_stage_definition
API anahtarı ya da OAuth token · crm:manage
  • Asıl adres: POST /api/v1/actions/crm.set_lead_stage_definition

Girdi

AlanTürZorunluAçıklama
iduuidDoldurulduğu yer: adresteki {id} · Aşama · kimliği: lead_stage
keystringevetAnahtar · en çok 50
namestringevetAd · en çok 255
behaviorstring (enum)evetAnlamı · İzin verilen değerler: open, won, lost, suspended
displayOrdernumberSipariş · en az 0
winProbabilitynumberKazanma şansı (%) · en az 0 · en çok 100

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

KodNe zaman reddedilir
not_foundAşama bulunmalı.
key_takenİki aşama aynı anahtarı paylaşamaz.
last_terminal_stageBir çalışma alanında en az bir kazanıldı ve bir kaybedildi aşaması kalır.

Yayımladığı olaylar: crm.lead_stage_definition_changed

Neye yazar: lead_stage (upsert) — Writes the stage

curl -X POST https://app.getera.io/api/v1/lead_stages/LEAD_STAGE_ID/actions/set_lead_stage_definition \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"key":"Key","name":"Name","behavior":"open"}'
Yanıt
{
  "ok": true,
  "result": "…",
  "events": [
    "crm.lead_stage_definition_changed"
  ]
}
import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.leadStages.setLeadStageDefinition("LEAD_STAGE_ID", {
  key: "Key",
  name: "Name",
  behavior: "open"
})
era lead_stages set_lead_stage_definition LEAD_STAGE_ID \
  --key "Key" \
  --name "Name" \
  --behavior "open"
tools/call
{
  "name": "era__crm__set_lead_stage_definition",
  "arguments": {
    "id": "LEAD_STAGE_ID",
    "key": "Key",
    "name": "Name",
    "behavior": "open"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde crm:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_found, key_taken, last_terminal_stage · 429 çok sık istek

crm.set_lost_reason

Kayıp nedeni ekle veya yeniden adlandır — Bir potansiyel müşterinin neden kaybedildiğine dair çalışma alanının kendi sözlüğünü yönetir.

Gereken izin crm:manage · veriyi değiştirir

POSThttps://app.getera.io/api/v1/lost_reasons/{id}/actions/set_lost_reason
API anahtarı ya da OAuth token · crm:manage
  • Asıl adres: POST /api/v1/actions/crm.set_lost_reason

Girdi

AlanTürZorunluAçıklama
iduuidDoldurulduğu yer: adresteki {id} · Neden · kimliği: lost_reason
namestringevetAd · en çok 255
displayOrdernumberSipariş · en az 0

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

KodNe zaman reddedilir
name_takenİki neden aynı adı paylaşamaz.

Yayımladığı olaylar: crm.lost_reason_changed

Neye yazar: lost_reason (upsert) — Writes the reason

curl -X POST https://app.getera.io/api/v1/lost_reasons/LOST_REASON_ID/actions/set_lost_reason \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"name":"Name"}'
Yanıt
{
  "ok": true,
  "result": "…",
  "events": [
    "crm.lost_reason_changed"
  ]
}
import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.lostReasons.setLostReason("LOST_REASON_ID", {
  name: "Name"
})
era lost_reasons set_lost_reason LOST_REASON_ID \
  --name "Name"
tools/call
{
  "name": "era__crm__set_lost_reason",
  "arguments": {
    "id": "LOST_REASON_ID",
    "name": "Name"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde crm:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 name_taken · 429 çok sık istek

crm.start_trial

Deneme başlat — Denemeyi başlatır ve başladığı günü kaydeder.

Gereken izin crm:write · veriyi değiştirir

POSThttps://app.getera.io/api/v1/leads/{id}/actions/start_trial
API anahtarı ya da OAuth token · crm:write
  • Asıl adres: POST /api/v1/actions/crm.start_trial

Girdi

AlanTürZorunluAçıklama
iduuidevetDoldurulduğu yer: adresteki {id} · Potansiyel müşteri · kimliği: lead
daysnumberSüre (gün) · en az 1 · en çok 365

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

KodNe zaman reddedilir
lead_not_foundPotansiyel müşteri bulunmalı.
lead_archivedArşivlenmiş bir potansiyel müşteri deneme başlatamaz.
no_trial_lengthDenemenin gün olarak bir süresi olmalı.

Yayımladığı olaylar: crm.lead_trial_started

Neye yazar: lead (update) — Records the trial and its start date

curl -X POST https://app.getera.io/api/v1/leads/LEAD_ID/actions/start_trial \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"days":1}'
Yanıt
{
  "ok": true,
  "result": "…",
  "events": [
    "crm.lead_trial_started"
  ]
}
import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.leads.startTrial("LEAD_ID", {
  days: 1
})
era leads start_trial LEAD_ID \
  --days 1
tools/call
{
  "name": "era__crm__start_trial",
  "arguments": {
    "id": "LEAD_ID",
    "days": 1
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde crm:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 lead_not_found, lead_archived, no_trial_length · 429 çok sık istek

crm.update_lead

Potansiyel müşteriyi düzenle — Takibi değiştirir — kaynağını, sahibini, notunu veya deneme süresini.

Gereken izin crm:write · veriyi değiştirir

POSThttps://app.getera.io/api/v1/leads/{id}/actions/update_lead
API anahtarı ya da OAuth token · crm:write
  • REST kısayolu: PATCH /api/v1/leads/{id}
  • Asıl adres: POST /api/v1/actions/crm.update_lead

Girdi

AlanTürZorunluAçıklama
iduuidevetDoldurulduğu yer: adresteki {id} · Potansiyel müşteri · kimliği: lead
sourceIduuidKaynak · kimliği: lead_source
assignedUserIduuidAtanan
assignmentNotestringSahibi için not · en çok 2000
messagestringNe dediler · en çok 4000
affiliateIduuidYönlendiren · kimliği: affiliate
trialDurationDaysnumberDeneme süresi (gün) · en az 0 · en çok 365
expectedValueAmountnumber (money)Fırsat değeri
expectedValueCurrencystringFırsat para birimi · en çok 3
expectedCloseDatedateBeklenen kapanış

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

KodNe zaman reddedilir
lead_not_foundPotansiyel müşteri bulunmalı.
lead_archivedArşivlenmiş bir potansiyel müşteri düzenlenmeden önce geri yüklenir.
invalid_currencyFırsat değerinin para birimi üç harfli bir kod olmalı.
source_not_availableKaynak bulunmalı ve aktif olmalı.
affiliate_not_foundYönlendiren satış ortağı bulunmalı.
not_a_memberSahip bu çalışma alanının aktif bir üyesi olmalı.

Yayımladığı olaylar: crm.lead_updated

Neye yazar: lead (update) — Updates the lead

curl -X POST https://app.getera.io/api/v1/leads/LEAD_ID/actions/update_lead \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"sourceId":"LEAD_SOURCE_ID"}'
Yanıt
{
  "ok": true,
  "result": "…",
  "events": [
    "crm.lead_updated"
  ]
}
import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.leads.updateLead("LEAD_ID", {
  sourceId: "LEAD_SOURCE_ID"
})
era leads update_lead LEAD_ID \
  --source-id "LEAD_SOURCE_ID"
tools/call
{
  "name": "era__crm__update_lead",
  "arguments": {
    "id": "LEAD_ID",
    "sourceId": "LEAD_SOURCE_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde crm:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 lead_not_found, lead_archived, invalid_currency, source_not_available, affiliate_not_found, not_a_member · 429 çok sık istek

Veri modelleri

Tablo affiliate_report_link · Kaynak affiliate_report_links

  • GET /api/v1/affiliate_report_links
  • GET /api/v1/affiliate_report_links/{id}
SütunTürBoş olabilirİzin verilen değerlerBağlı olduğu tablo
idstring (uuid) · uuid
organization_idstring (uuid) · uuidorganization
workspace_idstring (uuid) · uuidworkspace
affiliate_idstring (uuid) · uuidaffiliate
expires_atstring (date-time) · timestamptzevet
revoked_atstring (date-time) · timestamptzevet
last_used_atstring (date-time) · timestamptzevet
created_by_user_idstring (uuid) · uuidevetapp_user
created_atstring (date-time) · timestamptz
purposestring · textreport, referral

Birincil anahtar: id

Affiliate

Tablo affiliate · Kaynak affiliates

  • GET /api/v1/affiliates
  • GET /api/v1/affiliates/{id}
  • PATCH /api/v1/affiliates/{id} → crm.save_affiliate
SütunTürBoş olabilirİzin verilen değerlerBağlı olduğu tablo
idstring (uuid) · uuid
organization_idstring (uuid) · uuidorganization
workspace_idstring (uuid) · uuidworkspace
namestring · text
emailstring · textevet
phonestring · textevet
phone_country_codeinteger · int2evet
statusstring · textactive, inactive
notesstring · textevet
commission_typestring · textpercentage, fixed
commission_ratestring (decimal) · numericevet
fixed_commission_amountstring (int64) · int8evet
commission_currencystring · bpcharen çok 3
commission_accrual_modestring · textproportional, on_sale, on_full_collection
archived_atstring (date-time) · timestamptzevet
created_atstring (date-time) · timestamptz
updated_atstring (date-time) · timestamptz

Birincil anahtar: id

Denetimler:

  • CHECK (((commission_rate >= (0)::numeric) AND (commission_rate <= (100)::numeric)))
  • CHECK ((fixed_commission_amount >= 0))
  • CHECK ((((commission_type = 'percentage'::text) AND (commission_rate IS NOT NULL)) OR ((commission_type = 'fixed'::text) AND (fixed_commission_amount IS NOT NULL))))

CallResult

Tablo call_result · Kaynak call_results

  • GET /api/v1/call_results
  • GET /api/v1/call_results/{id}
SütunTürBoş olabilirİzin verilen değerlerBağlı olduğu tablo
idstring (uuid) · uuid
organization_idstring (uuid) · uuidorganization
workspace_idstring (uuid) · uuidworkspace
keystring · text
namestring · text
behaviorstring · textpositive, neutral, negative
display_orderinteger · int4
is_activeboolean · bool
created_atstring (date-time) · timestamptz
updated_atstring (date-time) · timestamptz

Birincil anahtar: id

CallStatus

Tablo call_status · Kaynak call_statuses

  • GET /api/v1/call_statuses
  • GET /api/v1/call_statuses/{id}
SütunTürBoş olabilirİzin verilen değerlerBağlı olduğu tablo
idstring (uuid) · uuid
organization_idstring (uuid) · uuidorganization
workspace_idstring (uuid) · uuidworkspace
keystring · text
namestring · text
behaviorstring · textreached, not_reached
display_orderinteger · int4
is_activeboolean · bool
created_atstring (date-time) · timestamptz
updated_atstring (date-time) · timestamptz

Birincil anahtar: id

CallTemplate

Tablo call_template · Kaynak call_templates

  • GET /api/v1/call_templates
  • GET /api/v1/call_templates/{id}
SütunTürBoş olabilirİzin verilen değerlerBağlı olduğu tablo
idstring (uuid) · uuid
organization_idstring (uuid) · uuidorganization
workspace_idstring (uuid) · uuidworkspace
namestring · text
template_textstring · text
is_activeboolean · bool
created_by_user_idstring (uuid) · uuidevetapp_user
created_atstring (date-time) · timestamptz
updated_atstring (date-time) · timestamptz

Birincil anahtar: id

Call

Tablo call · Kaynak calls

  • GET /api/v1/calls
  • GET /api/v1/calls/{id}
SütunTürBoş olabilirİzin verilen değerlerBağlı olduğu tablo
idstring (uuid) · uuid
organization_idstring (uuid) · uuidorganization
workspace_idstring (uuid) · uuidworkspace
lead_idstring (uuid) · uuidlead
called_by_user_idstring (uuid) · uuidevetapp_user
assigned_user_idstring (uuid) · uuidevetapp_user
duration_minutesinteger · int4evet
status_idstring (uuid) · uuidcall_status
result_idstring (uuid) · uuidcall_result
notesstring · textevet
is_importantboolean · bool
follow_up_datestring (date) · dateevet
follow_up_timestring (time) · timeevet
follow_up_notesstring · textevet
created_atstring (date-time) · timestamptz
updated_atstring (date-time) · timestamptz

Birincil anahtar: id

Denetimler:

  • CHECK ((duration_minutes >= 0))

LeadCancellation

Tablo lead_cancellation · Kaynak lead_cancellations

  • GET /api/v1/lead_cancellations
  • GET /api/v1/lead_cancellations/{id}
SütunTürBoş olabilirİzin verilen değerlerBağlı olduğu tablo
idstring (uuid) · uuid
organization_idstring (uuid) · uuidorganization
workspace_idstring (uuid) · uuidworkspace
lead_idstring (uuid) · uuidlead
reasonstring · text
cancelled_by_user_idstring (uuid) · uuidevetapp_user
cancellation_typestring · text
created_atstring (date-time) · timestamptz
updated_atstring (date-time) · timestamptz

Birincil anahtar: id

LeadSource

Tablo lead_source · Kaynak lead_sources

  • GET /api/v1/lead_sources
  • GET /api/v1/lead_sources/{id}
SütunTürBoş olabilirİzin verilen değerlerBağlı olduğu tablo
idstring (uuid) · uuid
organization_idstring (uuid) · uuidorganization
workspace_idstring (uuid) · uuidworkspace
keystring · text
namestring · text
display_orderinteger · int4
is_activeboolean · bool
created_atstring (date-time) · timestamptz
updated_atstring (date-time) · timestamptz

Birincil anahtar: id

LeadStage

Tablo lead_stage · Kaynak lead_stages

  • GET /api/v1/lead_stages
  • GET /api/v1/lead_stages/{id}
SütunTürBoş olabilirİzin verilen değerlerBağlı olduğu tablo
idstring (uuid) · uuid
organization_idstring (uuid) · uuidorganization
workspace_idstring (uuid) · uuidworkspace
keystring · text
namestring · text
behaviorstring · textopen, won, lost, suspended
display_orderinteger · int4
is_activeboolean · bool
created_atstring (date-time) · timestamptz
updated_atstring (date-time) · timestamptz
win_probabilityinteger · int2evet

Birincil anahtar: id

Denetimler:

  • CHECK (((win_probability IS NULL) OR ((win_probability >= 0) AND (win_probability <= 100))))

Lead

Tablo lead · Kaynak leads

SütunTürBoş olabilirİzin verilen değerlerBağlı olduğu tablo
idstring (uuid) · uuid
organization_idstring (uuid) · uuidorganization
workspace_idstring (uuid) · uuidworkspace
customer_idstring (uuid) · uuidcustomer
source_idstring (uuid) · uuidevetlead_source
stage_idstring (uuid) · uuidlead_stage
lost_reason_idstring (uuid) · uuidevetlost_reason
affiliate_idstring (uuid) · uuidevetaffiliate
assigned_user_idstring (uuid) · uuidevetapp_user
assignment_notestring · textevet
messagestring · textevet
trial_duration_daysinteger · int4
trial_start_datestring (date) · dateevet
archived_atstring (date-time) · timestamptzevet
closed_atstring (date-time) · timestamptzevet
created_atstring (date-time) · timestamptz
updated_atstring (date-time) · timestamptz
expected_value_amountstring (int64) · int8evet
expected_value_currencystring · textevet
expected_close_datestring (date) · dateevet
stale_notice_atstring (date-time) · timestamptzevet
scoreinteger · int2evet
scored_atstring (date-time) · timestamptzevet
score_reasonsobject · jsonb

Birincil anahtar: id

Denetimler:

  • CHECK ((((expected_value_amount IS NULL) OR (expected_value_amount >= 0)) AND ((expected_value_currency IS NULL) OR (expected_value_currency ~ '^[A-Z]{3}$'::text)) AND ((expected_value_amount IS NULL) OR (expected_value_currency IS NOT NULL))))
  • CHECK (((score IS NULL) OR ((score >= 0) AND (score <= 100))))
  • CHECK ((jsonb_typeof(score_reasons) = 'array'::text))
  • CHECK ((trial_duration_days >= 0))

LostReason

Tablo lost_reason · Kaynak lost_reasons

  • GET /api/v1/lost_reasons
  • GET /api/v1/lost_reasons/{id}
SütunTürBoş olabilirİzin verilen değerlerBağlı olduğu tablo
idstring (uuid) · uuid
organization_idstring (uuid) · uuidorganization
workspace_idstring (uuid) · uuidworkspace
namestring · text
display_orderinteger · int4
is_activeboolean · bool
created_atstring (date-time) · timestamptz
updated_atstring (date-time) · timestamptz

Birincil anahtar: id

Olaylar

İş akışları ve webhook'lar bu olaylara tepki verir.

OlayNe olurTaşıdığı alanlar
crm.affiliate_createdBir iş ortağı eklendi.id
crm.affiliate_deactivatedBir iş ortağı kapatıldı.id, openLeads
crm.affiliate_report_link_issuedBir iş ortağına rapor ya da yönlendirme bağlantısı gönderildi.id, affiliateId, purpose
crm.affiliate_report_link_revokedBir iş ortağı rapor bağlantısı kapatıldı.id, affiliateId
crm.affiliate_updatedBir iş ortağı düzenlendi.id
crm.call_amendedKaydedilmiş bir arama düzeltildi.id, leadId
crm.call_dictionary_changedArama sözlüğü değişti.id, table
crm.call_loggedBir arama kaydedildi.id, leadId
crm.call_template_changedBir arama şablonu değişti.id
crm.calls_exportedArama kaydı, arayan başına bir sayfa olarak indirildi.count
crm.lead_archivedBir potansiyel müşteri arşivlendi.id
crm.lead_assignedBir potansiyel müşterinin sahibi değişti.id, userId
crm.lead_attributedBir potansiyel müşteri bir satış ortağıyla ilişkilendirildi ya da ilişkili satış ortağı değişti.id, affiliateId, previousAffiliateId
crm.lead_cancelledBir müşteri satın aldıktan sonra vazgeçti.id, customerId
crm.lead_capturedBir potansiyel müşteri açıldı.id, customerId, affiliateId
crm.lead_lostBir potansiyel müşteri elle ya da otomatik kapatma kuralıyla kaybedildi.id, customerId, lostReasonId, automatic
crm.lead_restoredArşivlenmiş bir potansiyel müşteri geri geldi.id
crm.lead_source_changedKaynak sözlüğü değişti.id
crm.lead_stage_changedBir potansiyel müşteri satış hattında ilerledi.id, stageId, behavior, stageKey, fromStageId, fromStageKey, customerId
crm.lead_stage_definition_changedSatış hattı değişti.id
crm.lead_staleAçık bir potansiyel müşteri bir süredir hareket etmedi.id, customerId, customerName, ownerUserId, stage, quietDays, lastMovedAt
crm.lead_trial_startedBir deneme başladı.id, days
crm.lead_updatedBir potansiyel müşteri düzenlendi.id
crm.lead_wonBir potansiyel müşteri kazanıldı — finans sözleşmeyi açar.id, customerId
crm.leads_exportedBiri potansiyel müşteri listesini dosya olarak dışa aktardı.count, view, truncated
crm.leads_scoredAçık kayıtlar puanlandı.count
crm.lost_reason_changedKayıp nedeni sözlüğü değişti.id
Bu sayfa yardımcı oldu mu?