Referensi tool, prompt, dan izin.
Server MCP Klik Flow versi 2.3.7 di https://mcp.klikflow.id/mcp menyediakan 46 tool baca, 35 tool ubah, dan 5 prompt. Halaman ini dibuat dari kode server yang sama, jadi selalu sesuai. Nama dan deskripsi tool berbahasa Inggris, persis seperti yang dibaca aplikasi AI.
Cara membaca
Setiap tool butuh satu izin koneksi (scope) yang dicentang saat persetujuan, dan izin role orang yang menghubungkannya. Tool yang tidak memenuhi keduanya tidak muncul di aplikasi AI. Hasil berisi paling banyak 25 item; lanjutkan dengan cursor dari next_cursor.
Setiap tool punya anotasi eksplisit. Tool baca: readOnlyHint: true. Tool ubah: readOnlyHint: false, butuh fitur paket mcp_write dan parameter idempotency_key (panggilan yang diulang dengan kunci yang sama tidak dijalankan dua kali). Aksi ke pelanggan: openWorldHint: true dan mengikuti kebijakan kirim koneksi; dengan kebijakan Draf, hasilnya status: "awaiting_approval".
Dasar
get_workspace Ruang kerja
Business profile (name, time zone, whether it is inside working hours, package), the channels this person can use with their connection status, and the team with who is online. Call first to learn the business.
- Jenis
- Baca
- Izin koneksi
business:read- Izin role
- Semua anggota
- Hasil
- business (plan = package name, plan_source = subscription, default or builtin), you (role, whether phone numbers are masked), channels[], channel_slots, team[]
Tanpa parameter.
list_quick_replies Balasan cepat
Saved quick replies of the team (and this person's own), with their text, to reuse the business's approved wording.
- Jenis
- Baca
- Izin koneksi
business:read- Izin role
crm-chats.lihat-crm- Hasil
- quick_replies[] (title, shortcut, folder, text, attachments, uses), next_cursor
| Parameter | Tipe | Keterangan |
|---|---|---|
query | string | Text to search for. |
limit | integer 1–25 | Items per page (1-25, default 20). |
cursor | string | The next_cursor from the previous page. |
list_templates Template pesan
WhatsApp message templates approved by Meta for the WhatsApp API accounts, and the business's broadcast message templates, each where this person's role and package allow.
- Jenis
- Baca
- Izin koneksi
business:read- Izin role
- Semua anggota
- Hasil
- whatsapp_api_templates[] (name, language, category, status), message_templates[]
Tanpa parameter.
Kontak
search_contacts Cari kontak
Search contacts this person may see. Phone numbers follow the role's masking.
- Jenis
- Baca
- Izin koneksi
contacts:read- Izin role
contact-data.lihat- Hasil
- contacts[] (id, name, phone, email, company, city, status), total, next_cursor
| Parameter | Tipe | Keterangan |
|---|---|---|
query | string | Name, phone, email, company, city or username. |
limit | integer 1–25 | Items per page (1-25, default 20). |
cursor | string | The next_cursor from the previous page. |
get_contact Detail kontak
One contact: profile, custom fields, tags, stats, orders, notes, reminders and the latest conversation id.
- Jenis
- Baca
- Izin koneksi
contacts:read- Izin role
contact-data.lihat- Hasil
- profile fields, fields[], stats, money (role-gated), orders[], notes[], reminders[], latest_conversation_id
| Parameter | Tipe | Keterangan |
|---|---|---|
contact_id * | integer 1– | The contact id from a list or search result. |
list_prospect_results Hasil Cari Prospek
Saved Cari Prospek searches; with job_id, the businesses or group members it found. Numbers follow the role's masking; WhatsApp group members are always masked unless the role sees numbers.
- Jenis
- Baca
- Izin koneksi
prospects:read- Izin role
- Semua anggota
- Fitur paket
limit_scrapp_option- Hasil
- searches[] or results[] (name, category, address, phone, rating, saved_as_contact), next_cursor
| Parameter | Tipe | Keterangan |
|---|---|---|
job_id | integer 1– | The prospect search (job) id from a list or search result. |
limit | integer 1–25 | Items per page (1-25, default 20). |
cursor | string | The next_cursor from the previous page. |
upsert_contact Simpan kontak
Create a contact (name plus phone or email; refused when the phone or email already belongs to a contact, returning that contact's id) or update the given fields of contact_id. Creating needs the add-contact permission, updating the edit-contact permission; the package's contact limit applies.
- Jenis
- Ubah data
- Izin koneksi
contacts:write- Izin role
- Sesuai bagian yang diubah (lihat deskripsi)
- Hasil
- status (created, updated or exists), contact_id, changed[]
| Parameter | Tipe | Keterangan |
|---|---|---|
contact_id | integer 1– | The contact (omit to create a new contact) id from a list or search result. |
name | string | |
phone | string | Not changeable when this person's role sees masked numbers. |
email | string | |
company | string | |
city | string | |
province | string | |
address | string | |
custom_fields | object | Values by custom field key (keys from get_contact). |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
set_contact_labels Atur tag & label kontak
Add or remove a contact's tags, and set or clear its label and category.
- Jenis
- Ubah data
- Izin koneksi
contacts:write- Izin role
contact-data.edit- Hasil
- contact_id, tags[], label_id, category_id
| Parameter | Tipe | Keterangan |
|---|---|---|
contact_id * | integer 1– | The contact id from a list or search result. |
add_tags | array | Tags to add (lowercase words). |
remove_tags | array | |
label_id | integer 1– | A contact label id to set. |
clear_label | boolean | |
category_id | integer 1– | A contact category id to set. |
clear_category | boolean | |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
set_reminder Buat pengingat
Add a reminder on a contact. Klik Flow notifies the assignee when it is due.
- Jenis
- Ubah data
- Izin koneksi
contacts:write- Izin role
contact-data.edit- Hasil
- reminder_id, contact_id, due_at, assignee
| Parameter | Tipe | Keterangan |
|---|---|---|
contact_id * | integer 1– | The contact id from a list or search result. |
title * | string | What to do, e.g. "Follow up penawaran". |
due_at * | string | When: YYYY-MM-DDTHH:mm in the business time zone, or ISO 8601 with an offset. |
assignee_user_id | integer 1– | Who is reminded (default: this person) (a team member id from get_workspace). |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
reveal_phone Lihat nomor lengkap
The full phone number of a contact whose number this person sees masked, when the role may reveal numbers. Every reveal is logged on the contact and counts against the same daily limit as in the app (50). Ask only when the user needs the number itself.
- Jenis
- Baca, tercatat di riwayat kontak
- Izin koneksi
contacts:read- Izin role
contact-data.lihat- Hasil
- contact_id, phone, logged, daily_limit
| Parameter | Tipe | Keterangan |
|---|---|---|
contact_id * | integer 1– | The contact id from a list or search result. |
Chat
list_conversations Daftar chat
Chats this person may see (their chat scope and devices), newest activity first, with the last message.
- Jenis
- Baca
- Izin koneksi
conversations:read- Izin role
crm-chats.lihat-crm- Hasil
- conversations[] (id, name, channel, status, unread, assigned_to, ai_active, last_message), next_cursor
| Parameter | Tipe | Keterangan |
|---|---|---|
status | open | pending | resolved | |
queue | mine | unassigned | handoff | mine = assigned to this person; unassigned = nobody has it and the AI is not answering; handoff = handed over by the AI. |
unread_only | boolean | |
channel | string | whatsapp, waba, instagram, messenger, telegram, livechat, email… |
query | string | Text to search for. |
limit | integer 1–25 | Items per page (1-25, default 20). |
cursor | string | The next_cursor from the previous page. |
get_conversation Isi chat
One chat: contact, label, pipeline stage, assignee, AI state and summary, and its latest messages (oldest first). Customer text is marked untrusted.
- Jenis
- Baca
- Izin koneksi
conversations:read- Izin role
crm-chats.lihat-crm- Hasil
- header fields, ai, messages[] (from, author, text, media, quote), next_before_message_id
| Parameter | Tipe | Keterangan |
|---|---|---|
conversation_id * | integer 1– | The conversation id from a list or search result. |
limit | integer 1–50 | Messages (default 20, newest). |
before_message_id | integer 1– | Older messages: the next_before_message_id of the previous call. |
search_messages Cari pesan
Find messages containing words across the chats this person may see, newest first.
- Jenis
- Baca
- Izin koneksi
conversations:read- Izin role
crm-chats.lihat-crm- Hasil
- matches[] (message_id, conversation_id, chat, from, at, text), next_cursor
| Parameter | Tipe | Keterangan |
|---|---|---|
query * | string | Words to find in message text (3+ characters). |
days | integer 1–90 | How far back (default 30). |
limit | integer 1–25 | Items per page (1-25, default 20). |
cursor | string | The next_cursor from the previous page. |
update_conversation Ubah chat
Change a chat: its status, who handles it, its label, or whether the AI agent answers it. Each change needs the role permission of its button in Klik Flow (status and label: edit chat info; assigning: assign agents, or reply to take it yourself; AI: reply). Send only the fields to change; assigning and ai_mode cannot be combined.
- Jenis
- Ubah data
- Izin koneksi
conversations:manage- Izin role
- Sesuai bagian yang diubah (lihat deskripsi)
- Hasil
- conversation_id, changed[], status, handled_by, label_id, ai_active
| Parameter | Tipe | Keterangan |
|---|---|---|
conversation_id * | integer 1– | The conversation id from a list or search result. |
status | open | pending | resolved | New status. Resolving ends a handoff and may hand the chat back to the AI agent. |
assign_to_user_id | integer 1– | Who handles the chat; your own id takes it yourself (a team member id from get_workspace). |
unassign | boolean | true: nobody handles the chat any more. |
label_id | integer 1– | A contact label id (labels of type contact) to set on the chat. |
clear_label | boolean | true: remove the chat's label. |
ai_mode | ai | off | "ai": the AI agent answers this chat again (nobody holds it); "off": switch the AI off for this chat. |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
add_note Tambah catatan
Add an internal team note to a chat (conversation_id; needs the reply permission, and may mention team members) or to a contact (contact_id; needs the contact edit permission). Exactly one of the two. Customers never see notes.
- Jenis
- Ubah data
- Izin koneksi
conversations:manageataucontacts:write- Izin role
- Sesuai bagian yang diubah (lihat deskripsi)
- Hasil
- note_id, conversation_id or contact_id
| Parameter | Tipe | Keterangan |
|---|---|---|
conversation_id | integer 1– | The conversation id from a list or search result. |
contact_id | integer 1– | The contact id from a list or search result. |
text * | string | The note. Staff see it; customers never do. |
mention_user_ids | array | Team members to notify (chat notes only). |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
draft_reply Siapkan balasan
Prepare a reply in an existing chat as a draft ("Saran" card above the reply box in the Klik Flow Inbox, marked with this AI app). A staff member sends, edits or dismisses it; nothing reaches the customer from this tool. One chat keeps one draft: a newer one replaces it. Drafts wait 24 hours.
- Jenis
- Ubah data
- Izin koneksi
messages:draft- Izin role
crm-chats.balas-crm- Hasil
- status (awaiting_approval), draft_id, conversation_id, note
| Parameter | Tipe | Keterangan |
|---|---|---|
conversation_id * | integer 1– | The conversation id from a list or search result. |
text * | string | The reply as the customer would read it, in the customer's language. |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
send_reply Kirim balasan
Reply in an existing chat (by chat id, never to a free number), through the same checks as a staff reply: channel connected, not paused, the WhatsApp API 24-hour window. Customers see it: with the connection's default policy it waits as a draft for staff approval; read `status` in the result.
- Jenis
- Aksi ke pelanggan, ikut kebijakan kirim
- Izin koneksi
messages:send- Izin role
crm-chats.balas-crm- Hasil
- status (sent, failed, awaiting_approval or not_sent), message_id or draft_id, note
| Parameter | Tipe | Keterangan |
|---|---|---|
conversation_id * | integer 1– | The conversation id from a list or search result. |
text * | string | The reply as the customer will read it, in the customer's language. |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
start_conversation Chat ke nomor baru
Send a WhatsApp message to a phone number. An existing chat with that number is used; a number that never chatted counts against a small daily limit per connection, and contacts who opted out or are blocked are never messaged. Customers see it: with the connection's default policy it waits as a draft for staff approval; read `status` in the result.
- Jenis
- Aksi ke pelanggan, ikut kebijakan kirim
- Izin koneksi
messages:new- Izin role
crm-chats.balas-crm- Hasil
- status, conversation_id, new_chat, message_id or draft_id, note
| Parameter | Tipe | Keterangan |
|---|---|---|
phone * | string | WhatsApp number, e.g. 6281234567890 or 081234567890. |
text * | string | The first message, in the customer's language. |
contact_name | string | Name for a new contact (optional). |
device_id | integer 1– | Which WhatsApp number of the business sends it (from get_workspace); default: the first connected one this person may use. |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
Pipeline
get_pipeline Pipeline
Pipeline stages with totals, value, stuck deals and their cards (contact, owner, days in stage, last message), plus won/lost of the last 30 days. The first stage is Kontak Awal.
- Jenis
- Baca
- Izin koneksi
pipeline:read- Izin role
kanban.drag-drop-kanban- Hasil
- pipelines[], columns[] (stage, total, value, cards[]), closed_last_30_days
| Parameter | Tipe | Keterangan |
|---|---|---|
pipeline_id | integer 1– | The pipeline id from a list or search result. |
view | all | mine | reply | followup | stuck | hot | |
query | string | Text to search for. |
cards_per_stage | integer 1–25 | Cards per stage (default 10). |
move_pipeline_card Pindahkan kartu pipeline
Move a pipeline card to a stage, set its value, or close it as won (sent to Meta as a purchase when the business set that up) or lost. One of conversation_id or contact_id. Stage automations of the board run only from the Klik Flow app.
- Jenis
- Ubah data
- Izin koneksi
pipeline:write- Izin role
kanban.drag-drop-kanban- Hasil
- card, stage_id, outcome, value, changed
| Parameter | Tipe | Keterangan |
|---|---|---|
conversation_id | integer 1– | The conversation (the card of a chat) id from a list or search result. |
contact_id | integer 1– | The contact (the card of a contact without a chat) id from a list or search result. |
stage_id | integer 1– | Pipeline stage id from get_pipeline. |
outcome | won | lost | reopen | Close the card as won or lost, or reopen a closed card. |
value | number 0– | Deal value in IDR (for won, or to set the value). |
lost_reason | string | Required when the outcome is lost. |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
Tiket
list_tickets Daftar tiket
Support tickets this person may see, with status, priority, assignee and SLA state.
- Jenis
- Baca
- Izin koneksi
tickets:read- Izin role
ticket.lihat- Hasil
- tickets[] (id, code, subject, status, priority, assignee, sla), next_cursor
| Parameter | Tipe | Keterangan |
|---|---|---|
view | open | mine | unassigned | overdue | resolved | archived | all | |
query | string | Text to search for. |
limit | integer 1–25 | Items per page (1-25, default 20). |
cursor | string | The next_cursor from the previous page. |
get_ticket Detail tiket
One ticket with its description, contact, SLA and the timeline of notes and changes.
- Jenis
- Baca
- Izin koneksi
tickets:read- Izin role
ticket.lihat- Hasil
- ticket fields, contact, timeline[]
| Parameter | Tipe | Keterangan |
|---|---|---|
ticket_id * | integer 1– | The ticket id from a list or search result. |
create_ticket Buat tiket
Create a ticket, optionally from a chat or for a contact. Priority, assignee and SLA follow the business's ticket rules unless given.
- Jenis
- Ubah data
- Izin koneksi
tickets:write- Izin role
ticket.tambah-ticket- Hasil
- ticket_id, code, status, priority, assigned_to, due
| Parameter | Tipe | Keterangan |
|---|---|---|
subject * | string | Short summary of the issue. |
description | string | |
priority | urgent | high | normal | low | |
conversation_id | integer 1– | The conversation the ticket is about id from a list or search result. |
contact_id | integer 1– | The contact the ticket is about id from a list or search result. |
category_id | integer 1– | |
assignee_user_id | integer 1– | Who handles it (default: the business's ticket rules) (a team member id from get_workspace). |
notify_customer | boolean | true: send the business's own "ticket created" notice to the customer, as set in Tiket settings. Default false. |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
update_ticket Ubah tiket
Change a ticket's status, priority, assignee, subject or category, or add an internal note. Status needs the ticket status permission; the rest the ticket edit permission.
- Jenis
- Ubah data
- Izin koneksi
tickets:write- Izin role
- Sesuai bagian yang diubah (lihat deskripsi)
- Hasil
- ticket_id, changed[], status, priority, assigned_to
| Parameter | Tipe | Keterangan |
|---|---|---|
ticket_id * | integer 1– | The ticket id from a list or search result. |
status | open | in_progress | pending | on_hold | resolved | closed | Needs the ticket status permission; customer notices follow the business's ticket settings. |
priority | urgent | high | normal | low | |
assignee_user_id | integer 1– | New assignee (a team member id from get_workspace). |
subject | string | |
category_id | integer 1– | |
internal_note | string | A note for the team on the ticket (never sent to the customer). |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
Komentar sosial
list_comments Komentar sosial
The social comment queue (Instagram, Facebook, TikTok and others): comments, their status and label, and whether the AI drafted a reply.
- Jenis
- Baca
- Izin koneksi
comments:read- Izin role
repliz.lihat- Fitur paket
limit_repliz- Hasil
- comments[] (platform, account, author, text, status, label, needs_review), next_cursor
| Parameter | Tipe | Keterangan |
|---|---|---|
view | all | todo | question | complaint | review | drafted | spam | done | ignored | backlog | |
platform | string | |
query | string | Text to search for. |
limit | integer 1–25 | Items per page (1-25, default 20). |
cursor | string | The next_cursor from the previous page. |
reply_comment Balas komentar
Reply publicly to a social media comment from list_comments. A draft waits in Komentar › "Draf AI" for staff. Refused when someone replied in the last 15 minutes. Customers see it: with the connection's default policy it waits as a draft for staff approval; read `status` in the result.
- Jenis
- Aksi ke pelanggan, ikut kebijakan kirim
- Izin koneksi
comments:reply- Izin role
repliz.balas-komentar- Fitur paket
limit_repliz- Hasil
- status (sent, awaiting_approval or not_sent), comment_id, note
| Parameter | Tipe | Keterangan |
|---|---|---|
comment_id * | integer 1– | The comment id from a list or search result. |
text * | string | The public reply. Platform limits apply (e.g. TikTok 150, X 280 characters). |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
send_comment_dm DM pemberi komentar
Send one private message to the person who wrote a comment (Instagram and Facebook only, once per comment, within 7 days). There is no draft queue for this: listed only for connections allowed to send, and the person confirms first when the policy asks.
- Jenis
- Aksi ke pelanggan, tanpa antrean draf (Konfirmasi atau Langsung)
- Izin koneksi
comments:reply- Izin role
repliz.balas-komentar- Fitur paket
limit_repliz- Hasil
- status (sent or not_sent), comment_id, note
| Parameter | Tipe | Keterangan |
|---|---|---|
comment_id * | integer 1– | The comment id from a list or search result. |
text * | string | The private message. |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
Broadcast
list_broadcasts Daftar broadcast
Broadcasts with status, schedule, recipients, sent, failed, link clicks and attributed revenue.
- Jenis
- Baca
- Izin koneksi
broadcast:read- Izin role
whatsapp-broadcast.lihat- Fitur paket
broadcast- Hasil
- broadcasts[] (id, name, status, channel, recipients, sent, failed, clicked, revenue), next_cursor
| Parameter | Tipe | Keterangan |
|---|---|---|
status | draft | scheduled | running | done | paused | failed | |
limit | integer 1–25 | Items per page (1-25, default 20). |
cursor | string | The next_cursor from the previous page. |
get_broadcast_report Laporan broadcast
One broadcast's results: delivered, read, replied, failed (with reasons), link clicks and attributed revenue.
- Jenis
- Baca
- Izin koneksi
broadcast:read- Izin role
whatsapp-broadcast.lihat- Fitur paket
broadcast- Hasil
- totals, failure_reasons[], links[], orders, revenue
| Parameter | Tipe | Keterangan |
|---|---|---|
broadcast_id * | integer 1– | The broadcast id from a list or search result. |
create_broadcast_draft Siapkan broadcast
Save a broadcast as a draft and run the dry run: who receives it and who is left out (opted out, blocked, no number), sending numbers, estimated duration, WhatsApp API cost, the package quota left, and the links in the message. Nothing is sent.
- Jenis
- Ubah data
- Izin koneksi
broadcast:draft- Izin role
whatsapp-broadcast.tambah- Fitur paket
broadcast- Hasil
- broadcast_id, dry_run (recipients, skipped, active_numbers, duration_minutes, cost, quota_left, links[], risk, notes[])
| Parameter | Tipe | Keterangan |
|---|---|---|
name * | string | |
channel * | whatsapp | waba | "waba" sends an approved WhatsApp template only. |
message | string | Text (channel whatsapp); {nama} style fields as in the wizard. |
sender_account_id | integer 1– | WhatsApp API account (channel waba). |
template_id | integer 1– | Approved template id from list_templates (channel waba). |
template_values | object | Template fields by key (channel waba). |
device_ids | array | Sending numbers (channel whatsapp); default: those this person may use. |
label_id | integer 1– | |
category_id | integer 1– | |
stage_id | integer 1– | |
tags | array | |
segment | customers | not_customers | free_claimers | dormant | recent_chat | customers = bought (a free claim is no purchase); free_claimers = claimed a free product, never bought. |
contact_ids | array | |
media_id | integer 1– | Photo, video or document from the media library (channel whatsapp). |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
cancel_broadcast Batalkan jadwal broadcast
Turn a scheduled broadcast back into a draft. A broadcast already running is not changed here.
- Jenis
- Ubah data
- Izin koneksi
broadcast:draft- Izin role
whatsapp-broadcast.edit- Fitur paket
broadcast- Hasil
- broadcast_id, status
| Parameter | Tipe | Keterangan |
|---|---|---|
broadcast_id * | integer 1– | The broadcast id from a list or search result. |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
request_broadcast_send Minta kirim broadcast
Send or schedule a broadcast draft. Small limits per connection: broadcasts per day and recipients per broadcast (set per package; 1 and 200 by default). The package quota, safe pacing and opt-outs apply. With the connection's default policy this waits in the module's "Menunggu persetujuan" panel for a staff member; read `status` in the result.
- Jenis
- Aksi publik, ikut kebijakan kirim (antrean Menunggu persetujuan di modulnya)
- Izin koneksi
broadcast:send- Izin role
whatsapp-broadcast.edit- Fitur paket
broadcast- Hasil
- status (running, scheduled, awaiting_approval or not_sent), recipients, approval_id, note
| Parameter | Tipe | Keterangan |
|---|---|---|
broadcast_id * | integer 1– | The broadcast draft id from a list or search result. |
schedule_at | string | When: YYYY-MM-DDTHH:mm in the business time zone; omit to send now. |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
Follow-up & Upsell
list_sequences Follow-up & upsell
Follow-up sequences and upsell campaigns with their status and progress; revenue when the package and role allow.
- Jenis
- Baca
- Izin koneksi
outreach:read- Izin role
- Semua anggota
- Hasil
- follow_ups[], upsell_campaigns[], money_shown
Tanpa parameter.
get_sequence_report Laporan follow-up
Report of one follow-up sequence (per step: sent, skipped, failed, replies; deals) or upsell campaign (reach, replies, purchases).
- Jenis
- Baca
- Izin koneksi
outreach:read- Izin role
- Semua anggota
- Hasil
- steps[] or campaign totals, deals/orders, revenue (role-gated)
| Parameter | Tipe | Keterangan |
|---|---|---|
kind | follow_up | upsell | Default follow_up. |
id * | integer 1– | The sequence or campaign id from a list or search result. |
enroll_contact Masukkan ke follow-up
Start an active follow-up sequence for one chat or contact; its messages go out on the sequence's schedule. Refused for blocked or opted-out contacts, groups, resolved chats and a chat already in the sequence. There is no draft queue for enrolments: listed only for connections allowed to send. Upsell campaigns pick their own recipients.
- Jenis
- Aksi ke pelanggan, tanpa antrean draf (Konfirmasi atau Langsung)
- Izin koneksi
outreach:enroll- Izin role
crm-chats.balas-crm- Hasil
- status (enrolled or not_sent), enrollment_id, first_message_at, note
| Parameter | Tipe | Keterangan |
|---|---|---|
sequence_id * | integer 1– | The follow-up sequence from list_sequences (kind follow_up) id from a list or search result. |
conversation_id | integer 1– | The conversation id from a list or search result. |
contact_id | integer 1– | The contact (a WhatsApp chat is opened when it has none) id from a list or search result. |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
stop_enrollment Hentikan follow-up
Stop a follow-up for one chat: its waiting messages are cancelled (they can be started again later). Give enrollment_id, or sequence_id with conversation_id.
- Jenis
- Ubah data (menghentikan sesuatu)
- Izin koneksi
outreach:enroll- Izin role
crm-chats.balas-crm- Hasil
- stopped, conversation_id
| Parameter | Tipe | Keterangan |
|---|---|---|
enrollment_id | integer 1– | The enrollment id from a list or search result. |
sequence_id | integer 1– | The follow-up sequence id from a list or search result. |
conversation_id | integer 1– | The conversation id from a list or search result. |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
Landing page
list_landing_pages Daftar landing page
Landing pages with status, public address, visits, leads and the last 7 days of sessions.
- Jenis
- Baca
- Izin koneksi
landing:read- Izin role
landing-page.lihat- Fitur paket
limit_landing_pages- Hasil
- pages[] (id, title, status, url, views_all_time, leads_all_time, sessions_7d)
Tanpa parameter.
get_landing_analytics Analitik landing page
One landing page's analytics: sessions, leads, conversion, scroll, sources, devices, buttons and suggestions.
- Jenis
- Baca
- Izin koneksi
landing:read- Izin role
landing-page.lihat- Fitur paket
limit_landing_pages- Hasil
- totals, daily[], sources[], devices[], top_ctas[], insights[]
| Parameter | Tipe | Keterangan |
|---|---|---|
page_id * | integer 1– | The landing page or Bio Link page id from a list or search result. |
days | 7 | 30 | 90 | Window in days: 7, 30 or 90. |
list_landing_leads Lead landing page
Form submissions of one landing page, newest first. Phone numbers follow the role's masking.
- Jenis
- Baca
- Izin koneksi
landing:read- Izin role
landing-page.lihat- Fitur paket
limit_landing_pages- Hasil
- leads[] (name, phone, email, message, fields[], utm), next_cursor
| Parameter | Tipe | Keterangan |
|---|---|---|
page_id * | integer 1– | The landing page or Bio Link page id from a list or search result. |
limit | integer 1–25 | Items per page (1-25, default 20). |
cursor | string | The next_cursor from the previous page. |
get_landing_draft Draf landing page
The draft of a landing page: its sections with their ids, types and editable text and image fields, the draft revision to pass to update_landing_content and publish_landing_page, and a private preview link (7 days).
- Jenis
- Baca
- Izin koneksi
landing:read- Izin role
landing-page.lihat- Fitur paket
limit_landing_pages- Hasil
- page_id, title, status, mode, revision, sections[] (id, type, variant, name, hidden, fields), preview_url, url
| Parameter | Tipe | Keterangan |
|---|---|---|
page_id * | integer 1– | The landing page id from a list or search result. |
create_landing_draft Buat draf landing page
Create a new landing page as an unpublished draft, from a template or as a copy of a page. The package's page limit applies (drafts count). Nothing is public until it is published.
- Jenis
- Ubah data
- Izin koneksi
landing:write- Izin role
landing-page.tambah- Fitur paket
limit_landing_pages- Hasil
- page_id, title, revision, preview_url
| Parameter | Tipe | Keterangan |
|---|---|---|
title | string | |
template | string | Template id ("kosong" for a blank page); an unknown id returns the list. |
duplicate_of | integer 1– | The landing page to copy instead of a template id from a list or search result. |
wa_phone | string | WhatsApp number for the template's buttons. |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
update_landing_content Ubah draf landing page
Change the text, images, order and look of a landing page draft (visual pages). Rich text is sanitised like the editor; raw HTML, scripts, page settings and pixels cannot be changed here. The published page stays as it is until publish_landing_page.
- Jenis
- Ubah data
- Izin koneksi
landing:write- Izin role
landing-page.edit- Fitur paket
limit_landing_pages- Hasil
- page_id, revision, changed[], notes[]
| Parameter | Tipe | Keterangan |
|---|---|---|
page_id * | integer 1– | The landing page id from a list or search result. |
revision * | integer 0– | The draft revision from get_landing_draft; refused when someone changed the draft since. |
ops * | array | Edits in order: set_prop {id, path, value}, update_props {id, props}, set_hidden {id, hidden}, move_section {id, index}, duplicate_section {id}, add_section {type, variant?, props?, afterId?}, rename_section {id, name}, set_variant {id, variant}, set_style {id, style}, set_theme {theme}. |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
publish_landing_page Terbitkan landing page
Publish the landing page draft at the given revision (its public address does not change). With the connection's default policy this waits in the module's "Menunggu persetujuan" panel for a staff member; read `status` in the result.
- Jenis
- Aksi publik, ikut kebijakan kirim (antrean Menunggu persetujuan di modulnya)
- Izin koneksi
landing:publish- Izin role
landing-page.publikasi- Fitur paket
limit_landing_pages- Hasil
- status (published, awaiting_approval or not_sent), url, approval_id, note
| Parameter | Tipe | Keterangan |
|---|---|---|
page_id * | integer 1– | The landing page id from a list or search result. |
revision * | integer 0– | The draft revision to publish (from get_landing_draft). |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
unpublish_landing_page Tarik landing page
Take a published landing page offline (visitors get "not found"; the page and its versions stay). With the connection's default policy this waits in the module's "Menunggu persetujuan" panel for a staff member; read `status` in the result.
- Jenis
- Aksi publik, ikut kebijakan kirim (antrean Menunggu persetujuan di modulnya)
- Izin koneksi
landing:publish- Izin role
landing-page.publikasi- Fitur paket
limit_landing_pages- Hasil
- status, approval_id, note
| Parameter | Tipe | Keterangan |
|---|---|---|
page_id * | integer 1– | The landing page id from a list or search result. |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
Bio Link
list_bio_pages Halaman Bio Link
Bio Link pages (main page and extra pages) with status and public address.
- Jenis
- Baca
- Izin koneksi
biolink:read- Izin role
bio-link.lihat- Fitur paket
bio_link- Hasil
- pages[] (id, title, main_page, status, url)
Tanpa parameter.
get_bio_page Isi Bio Link
One Bio Link page: its blocks (draft), clicks per block, and whether the live page differs from the draft.
- Jenis
- Baca
- Izin koneksi
biolink:read- Izin role
bio-link.lihat- Fitur paket
bio_link- Hasil
- page fields, unpublished_changes, blocks[]
| Parameter | Tipe | Keterangan |
|---|---|---|
page_id * | integer 1– | The landing page or Bio Link page id from a list or search result. |
get_bio_stats Statistik Bio Link
Views, visitors, clicks, chats, leads, orders and revenue of one Bio Link page per day, with sources and devices.
- Jenis
- Baca
- Izin koneksi
biolink:read- Izin role
bio-link.lihat- Fitur paket
bio_link- Hasil
- totals, daily[], sources[], devices[], top_blocks[]
| Parameter | Tipe | Keterangan |
|---|---|---|
page_id * | integer 1– | The landing page or Bio Link page id from a list or search result. |
days | 7 | 30 | 90 | Window in days: 7, 30 or 90. |
list_bio_leads Lead Bio Link
Lead form submissions of one Bio Link page. Phone numbers follow the role's masking.
- Jenis
- Baca
- Izin koneksi
biolink:read- Izin role
bio-link.lihat- Fitur paket
bio_link- Hasil
- leads[] (name, phone, email, message)
| Parameter | Tipe | Keterangan |
|---|---|---|
page_id * | integer 1– | The landing page or Bio Link page id from a list or search result. |
limit | integer 1–25 | Items per page (1-25, default 20). |
update_bio_blocks Ubah draf Bio Link
Change the Bio Link draft: add, edit, hide or show blocks, and reorder them. Blocks are checked like the editor (http(s) links, allowed embeds, package features for forms, animation and schedules). Visitors see it after publish_bio_page.
- Jenis
- Ubah data
- Izin koneksi
biolink:write- Izin role
bio-link.ubah- Fitur paket
bio_link- Hasil
- page_id, changed[], blocks (id, type, enabled)
| Parameter | Tipe | Keterangan |
|---|---|---|
page_id * | integer 1– | The Bio Link page id from a list or search result. |
changes | array | Add, edit, hide or show blocks of the draft. |
order | array | All block ids of the page in the new order (optional). |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
publish_bio_page Terbitkan Bio Link
Publish the Bio Link draft (visible blocks only). With the connection's default policy this waits in the module's "Menunggu persetujuan" panel for a staff member; read `status` in the result.
- Jenis
- Aksi publik, ikut kebijakan kirim (antrean Menunggu persetujuan di modulnya)
- Izin koneksi
biolink:publish- Izin role
bio-link.terbitkan- Fitur paket
bio_link- Hasil
- status, version_id, approval_id, note
| Parameter | Tipe | Keterangan |
|---|---|---|
page_id * | integer 1– | The Bio Link page id from a list or search result. |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
Smart Link
list_smart_links Daftar Smart Link
Smart Links with status, address, CS numbers and the funnel (clicks, chats, qualified, closing, revenue).
- Jenis
- Baca
- Izin koneksi
smartlink:read- Izin role
smart-link.lihat- Fitur paket
limit_smart_links- Hasil
- links[] (id, name, status, url, cs[], funnel)
| Parameter | Tipe | Keterangan |
|---|---|---|
days | 7 | 30 | 90 | Window in days: 7, 30 or 90. |
get_smart_link_report Laporan Smart Link
One Smart Link's funnel, clicks and chats over time, results per CS, top sources and recent silent clicks (clicks with no chat).
- Jenis
- Baca
- Izin koneksi
smartlink:read- Izin role
smart-link.lihat- Fitur paket
limit_smart_links- Hasil
- funnel, series[], per_cs[], sources[], silent_clicks_recent[]
| Parameter | Tipe | Keterangan |
|---|---|---|
link_id * | integer 1– | The Smart Link id from a list or search result. |
days | 7 | 30 | 90 | Window in days: 7, 30 or 90. |
list_smart_link_leads Lead Smart Link
Leads that came through one Smart Link: who, from which source, which CS, waiting time, first message and revenue.
- Jenis
- Baca
- Izin koneksi
smartlink:read- Izin role
smart-link.lihat- Fitur paket
limit_smart_links- Hasil
- counts, leads[] (name, phone, status, source, cs, first_message, revenue), next_cursor
| Parameter | Tipe | Keterangan |
|---|---|---|
link_id * | integer 1– | The Smart Link id from a list or search result. |
days | 7 | 30 | 90 | Window in days: 7, 30 or 90. |
status | new | replied | qualified | closing | lost | |
query | string | Text to search for. |
limit | integer 1–25 | Items per page (1-25, default 20). |
cursor | string | The next_cursor from the previous page. |
smart_link_usage Smart Link dipakai di
Where one Smart Link is used: landing pages, Bio Link, store, live chat and automations.
- Jenis
- Baca
- Izin koneksi
smartlink:read- Izin role
smart-link.lihat- Fitur paket
limit_smart_links- Hasil
- used_in[] (kind, label)
| Parameter | Tipe | Keterangan |
|---|---|---|
link_id * | integer 1– | The Smart Link id from a list or search result. |
list_smart_link_numbers Nomor CS Smart Link
The business's registered WhatsApp numbers a Smart Link can rotate to, with their key for create_smart_link and update_smart_link and whether they are connected.
- Jenis
- Baca
- Izin koneksi
smartlink:read- Izin role
smart-link.lihat- Fitur paket
limit_smart_links- Hasil
- numbers[] (key, name, phone, connected, status)
Tanpa parameter.
create_smart_link Buat Smart Link
Create a new WhatsApp Smart Link that rotates visitors to the business's CS numbers. A new link is not used anywhere yet; the package's link limit applies.
- Jenis
- Ubah data
- Izin koneksi
smartlink:write- Izin role
smart-link.kelola- Fitur paket
limit_smart_links- Hasil
- link_id, slug, url
| Parameter | Tipe | Keterangan |
|---|---|---|
name * | string | |
numbers * | array | CS numbers to rotate to (connected ones only). |
message | string | Opening message; [produk] style placeholders are filled from the link's query. |
slug | string | Last part of the address (default: from the name). |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
update_smart_link Ubah Smart Link
Change a Smart Link's name, opening message, rotation or numbers, or switch it on or off. Changes to an inactive link apply at once; changing an active link (or switching one on) reaches visitors: With the connection's default policy this waits in the module's "Menunggu persetujuan" panel for a staff member; read `status` in the result.
- Jenis
- Aksi publik, ikut kebijakan kirim (antrean Menunggu persetujuan di modulnya)
- Izin koneksi
smartlink:write- Izin role
smart-link.kelola- Fitur paket
limit_smart_links- Hasil
- status (updated, awaiting_approval or not_sent), changed[], approval_id, note
| Parameter | Tipe | Keterangan |
|---|---|---|
link_id * | integer 1– | The Smart Link id from a list or search result. |
name | string | |
message | string | |
routing_mode | sequential | fair | weighted | random | |
numbers | array | The new rotation (replaces the current numbers). |
active | boolean | Switch the link on or off. |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
Konten
get_content_calendar Kalender konten
Scheduled posts in a date range (max 62 days, default this week), posts waiting for approval and unscheduled drafts, with each target account's status. Captions are whole in all three lists; only when they do not fit in one answer are the longest shortened, marked caption_truncated (get_post has the whole caption).
- Jenis
- Baca
- Izin koneksi
content:read- Izin role
content-studio.lihat- Fitur paket
limit_content_studio- Hasil
- scheduled[], waiting_approval[], unscheduled_drafts[] (id, title, caption, caption_truncated, caption_length, status, schedule_at, media_count, targets[])
| Parameter | Tipe | Keterangan |
|---|---|---|
from | string (date) | Start date YYYY-MM-DD in the business time zone (default: 7 days ago). |
to | string (date) | End date YYYY-MM-DD in the business time zone, inclusive (default: today). |
get_post Detail post
One post: the whole caption, each attached file with its media library id, each target account with its key and own caption (if it has one), status per account (published, failed with reason) and linked content tasks.
- Jenis
- Baca
- Izin koneksi
content:read- Izin role
content-studio.lihat- Fitur paket
limit_content_studio- Hasil
- post fields, media[] (position, media_id, in_library, name, kind, mime, bytes, width, height, duration_seconds, url; media_id null and in_library false = no longer in the media library), targets[] (key, platform, account, account_status, format, status, error, published_at, own_caption when the account has its own caption), tasks[]
| Parameter | Tipe | Keterangan |
|---|---|---|
post_id * | integer 1– | The post id from a list or search result. |
list_content_tasks Tugas konten
Content tasks and ideas in a date range (default 14 days). Without the 'see all' right, only tasks given to or made by this person.
- Jenis
- Baca
- Izin koneksi
content:read- Izin role
content-tasks.lihat- Fitur paket
limit_content_tasks- Hasil
- tasks[] (title, platform, date, status, priority, assignee, post_id, follows_post, post_state for a task made into a post), next_cursor
| Parameter | Tipe | Keterangan |
|---|---|---|
from | string (date) | Start date YYYY-MM-DD in the business time zone (default: 7 days ago). |
to | string (date) | End date YYYY-MM-DD in the business time zone, inclusive (default: today). |
status | todo | in_progress | ready_upload | uploaded | needs_revision | done | |
limit | integer 1–25 | Items per page (1-25, default 20). |
cursor | string | The next_cursor from the previous page. |
list_media Pustaka media
Folders and files of the media library (names, types, sizes) and storage use against the package limit. File contents are not returned.
- Jenis
- Baca
- Izin koneksi
media:read- Izin role
media-manager.lihat-media- Hasil
- folders[], files[], storage, next_cursor
| Parameter | Tipe | Keterangan |
|---|---|---|
folder_id | integer 1– | The folder id from a list or search result. |
limit | integer 1–25 | Items per page (1-25, default 20). |
cursor | string | The next_cursor from the previous page. |
list_content_accounts Akun tujuan konten
Social accounts and WhatsApp numbers (Status, Saluran) a post can go to, with their key for create_content_draft and whether they are connected.
- Jenis
- Baca
- Izin koneksi
content:read- Izin role
content-studio.lihat- Fitur paket
limit_content_studio- Hasil
- accounts[] (key, platform, name, status)
Tanpa parameter.
create_content_draft Buat draf konten
Save a post as a draft in Konten (caption, media from the library, target accounts). Nothing is scheduled; use schedule_post.
- Jenis
- Ubah data
- Izin koneksi
content:write- Izin role
content-studio.tambah- Fitur paket
limit_content_studio- Hasil
- post_id, status
| Parameter | Tipe | Keterangan |
|---|---|---|
title | string | |
caption * | string | |
accounts * | array | Account keys from list_content_accounts. |
media_ids | array | Media library file ids (list_media, upload_media or create_upload_link). One video goes out as Instagram Reels and as a TikTok video. |
link_url | string | |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
generate_captions Buat caption AI
Caption ideas written by Klik Flow AI. Uses the business's AI credits like the Konten editor (the owner can switch caption AI off).
- Jenis
- Ubah data
- Izin koneksi
content:write- Izin role
content-studio.tambah- Fitur paket
content_ai_caption- Hasil
- captions[], credits_used
| Parameter | Tipe | Keterangan |
|---|---|---|
brief * | string | What the post is about. |
tone | santai | promo | formal | lucu | |
platforms | array | |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
schedule_post Jadwalkan konten
Schedule a content draft on its accounts. Without the publish permission, a package with content approval sends it to Konten's approval queue. With the connection's default policy this waits in the module's "Menunggu persetujuan" panel for a staff member; read `status` in the result.
- Jenis
- Aksi publik, ikut kebijakan kirim (antrean Menunggu persetujuan di modulnya)
- Izin koneksi
content:publish- Izin role
content-studio.tambah- Fitur paket
limit_content_studio- Hasil
- status (scheduled, pending_approval, awaiting_approval or not_sent), schedule_at, approval_id, note
| Parameter | Tipe | Keterangan |
|---|---|---|
post_id * | integer 1– | The content draft id from a list or search result. |
at | string | When: YYYY-MM-DDTHH:mm in the business time zone; omit for as soon as possible. |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
cancel_post Batalkan jadwal konten
Cancel a scheduled post (it goes back to draft). Needs the cancel-schedule or publish permission. With the connection's default policy this waits in the module's "Menunggu persetujuan" panel for a staff member; read `status` in the result.
- Jenis
- Aksi publik, ikut kebijakan kirim (antrean Menunggu persetujuan di modulnya)
- Izin koneksi
content:publish- Izin role
- Sesuai bagian yang diubah (lihat deskripsi)
- Fitur paket
limit_content_studio- Hasil
- status, approval_id, note
| Parameter | Tipe | Keterangan |
|---|---|---|
post_id * | integer 1– | The scheduled post id from a list or search result. |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
update_post Ubah konten
Change a post in Konten, like Edit on the web: only the fields you give change. A draft stays a draft and a post waiting for approval keeps waiting, with the new text. A scheduled post keeps its time and the change reaches its accounts; this also needs content:publish, and with the connection's default policy it waits in the module's "Menunggu persetujuan" panel. A published post cannot change. Read `status` and `notes` in the result.
- Jenis
- Aksi publik, ikut kebijakan kirim (antrean Menunggu persetujuan di modulnya)
- Izin koneksi
content:write- Izin role
- Sesuai bagian yang diubah (lihat deskripsi)
- Fitur paket
limit_content_studio- Hasil
- post_id, status, changed[], schedule_at, failed_accounts[], notes[] (accounts with their own caption, formats changed for new media, accounts already published), or status awaiting_approval / not_sent with approval_id, note
| Parameter | Tipe | Keterangan |
|---|---|---|
post_id * | integer 1– | The post id from a list or search result. |
caption | string | The new main caption. |
title | string | The new title; an empty text removes it. |
link_url | string | The new link; an empty text removes it. |
media_ids | array | Media library file ids replacing the post's files, in order; [] removes them. |
accounts | array | Account keys (list_content_accounts) replacing the post's accounts. |
account_captions | object | A caption for one account by its key (get_post); null or an empty text = the main caption. |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
create_content_task Buat tugas konten
Add an idea or task to the team's content board.
- Jenis
- Ubah data
- Izin koneksi
content:write- Izin role
content-tasks.tambah- Fitur paket
limit_content_tasks- Hasil
- task_id
| Parameter | Tipe | Keterangan |
|---|---|---|
title * | string | |
description | string | |
platform | Instagram | TikTok | YouTube | Facebook | LinkedIn | Threads | Shopee | Website | Lainnya | |
scheduled_date | string (date) | |
scheduled_time | string | |
assignee_user_id | integer 1– | Team member (assigning someone else needs the assign permission). |
priority | low | normal | high | |
caption | string | |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
update_content_task Ubah tugas konten
Change a content task's fields or status.
- Jenis
- Ubah data
- Izin koneksi
content:write- Izin role
content-tasks.edit- Fitur paket
limit_content_tasks- Hasil
- task_id, status
| Parameter | Tipe | Keterangan |
|---|---|---|
task_id * | integer 1– | The content task id from a list or search result. |
status | todo | in_progress | ready_upload | uploaded | needs_revision | done | uploaded and done need a post link or proof. |
title | string | |
description | string | |
scheduled_date | string (date) | |
assignee_user_id | integer 1– | |
priority | low | normal | high | |
caption | string | |
post_url | string | |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
upload_media Unggah media
Add an image or a video to the business's media library from a public address, with the same types and limits as Konten on the web (the package's per-upload size and storage). The type is read from the file itself; QuickTime (.mov) and MKV are refused, convert them to MP4. A large video can take a minute or two to download: if the call times out, call again with the same idempotency_key. For a file on your own computer use create_upload_link instead. Use the returned media id in create_content_draft (Reels and video posts) and broadcasts, and its url in landing pages and Bio Link.
- Jenis
- Ubah data
- Izin koneksi
media:write- Izin role
media-manager.upload-media- Hasil
- media_id, kind (image or video), mime, name, url, bytes, storage_left (bytes; null = no storage limit)
| Parameter | Tipe | Keterangan |
|---|---|---|
url | string | Public http(s) address of the file itself (a direct download link, not a Google Drive or Dropbox preview page): a JPG, PNG, WebP or GIF image, or an MP4 or WebM video. Up to the package's per-upload size (at most 250 MB), as on the web. |
data_base64 | string | Or the file itself in base64 (max about 500 KB): fine for a small image; send videos by url. |
file_name | string | |
folder_id | integer 1– | Media library folder (list_media). |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
create_upload_link Buat link unggah
Get a one-use HTTPS link to send an image or a video from your own computer to the business's media library, with no public link and nothing picked on the web. Run the returned command (curl -T) where the file is; its JSON answer has the media_id for create_content_draft, then schedule_post. The link belongs to this business and this connection, lasts 15 minutes and stores one file. Same types and limits as upload_media: JPG, PNG, WebP, GIF, MP4, WebM up to the package's per-upload size (at most 250 MB); .mov, .mkv and .m4a are refused with the reason. A refused file can be fixed and sent again with the same link before it expires.
- Jenis
- Ubah data
- Izin koneksi
media:write- Izin role
media-manager.upload-media- Hasil
- upload_url, method, command (macOS/Linux), command_windows, expires_at, expires_in_seconds, max_bytes, max_mb, accepted, refused, how
| Parameter | Tipe | Keterangan |
|---|---|---|
file_name | string | The file you will send (e.g. final.mp4): put in the ready-made command and used to name it in the library. |
folder_id | integer 1– | Media library folder (list_media). |
idempotency_key * | string | A unique key you make for this action, e.g. a UUID. Reuse it only to retry the same action with the same arguments; the action never runs twice. |
Toko
search_products Produk toko
Store products with price, stock available, variants and sales. `free: true` = a variant is free (price 0, claimed without payment); `sales_count` includes free claims, `free_claims_30d` counts them apart and `revenue_30d` never includes them.
- Jenis
- Baca
- Izin koneksi
store:read- Izin role
product.lihat- Hasil
- products[] (name, status, price, free, stock_available, sales_count, free_claims_30d), next_cursor
| Parameter | Tipe | Keterangan |
|---|---|---|
query | string | Text to search for. |
status | active | draft | inactive | archived | |
limit | integer 1–25 | Items per page (1-25, default 20). |
cursor | string | The next_cursor from the previous page. |
list_orders Pesanan toko
Store orders with payment, fulfilment and delivery status, totals and buyer. A free claim has `free_claim: true`, status paid, total 0 and method Gratis: no payment, no fee and not a sale. Owner only; no payment credentials.
- Jenis
- Baca
- Izin koneksi
store:read- Izin role
product.lihat· khusus owner- Hasil
- orders[] (order_no, status, free_claim, payment_method, fulfillment, total, net, buyer), has_next_page
| Parameter | Tipe | Keterangan |
|---|---|---|
filter | all | ship | paid | pending | attention | ship = paid physical orders still to send; attention = delivery failed. |
page | integer 1– | Page of 20 (default 1). |
get_order Detail pesanan
One order: items, amounts, shipping address and shipment (courier, waybill, status). `free_claim: true` = a free product claimed without payment (total 0, not a sale). Owner only.
- Jenis
- Baca
- Izin koneksi
store:read- Izin role
product.lihat· khusus owner- Hasil
- order fields (free_claim, payment_method), items[], amounts, shipping_address, shipment
| Parameter | Tipe | Keterangan |
|---|---|---|
order_no * | string | The order_no from list_orders. |
Laporan & iklan
get_report Laporan
The Laporan report of one tab for a period, in the business time zone, as blocks (KPIs, tables, series). Money figures need the 'Lihat angka' right; tabs other than ringkasan need the advanced reports package.
- Jenis
- Baca
- Izin koneksi
reports:read- Izin role
laporan.lihat- Hasil
- period, compared_with, blocks[] (kpis, tables, series, text), money_hidden
| Parameter | Tipe | Keterangan |
|---|---|---|
tab | ringkasan | penjualan | pemasaran | pipeline | layanan | ai | operasional | Report tab (default ringkasan). |
period | today | 7d | mtd | 30d | 90d | last_month | Default 7d; mtd = month to date. |
channel | whatsapp | waba | telegram | instagram | messenger | livechat | email | |
compare | boolean | Compare with the period before (default true). |
get_signal_health Kesehatan sinyal iklan
Health of the conversion signals sent to Meta and TikTok (sent, pending, failed, rejected), problems with fixes, match coverage and setup.
- Jenis
- Baca
- Izin koneksi
ads:read- Izin role
business.lihat- Hasil
- events[], problems[], match_coverage, setup, meta_quality
| Parameter | Tipe | Keterangan |
|---|---|---|
days | 7 | 30 | 90 | Window in days: 7, 30 or 90. |
get_ads_revenue Iklan ke omzet
Which ads and campaigns brought leads, closings and revenue, with spend, CPL, CPA and ROAS, plus results per CS.
- Jenis
- Baca
- Izin koneksi
ads:read- Izin role
laporan.lihat-angka- Fitur paket
ads_insights- Hasil
- totals, unattributed, campaigns[], per_cs[]
| Parameter | Tipe | Keterangan |
|---|---|---|
days | 7 | 30 | 90 | Window in days: 7, 30 or 90. |
Otomasi & AI Agent
list_automations Otomasi
Automation flows with a plain summary, channels, runs and messages of the last 7 days and the last result.
- Jenis
- Baca
- Izin koneksi
automation:read- Izin role
otomasi.lihat- Hasil
- flows[] (name, enabled, summary, runs_7d, last_run), active_limit, history_days
Tanpa parameter.
get_automation_runs Riwayat otomasi
Recent runs of automation flows (within the package's history days) with result, reason and steps.
- Jenis
- Baca
- Izin koneksi
automation:read- Izin role
otomasi.lihat- Hasil
- runs[] (flow, status, at, who, reason, steps[])
| Parameter | Tipe | Keterangan |
|---|---|---|
flow_id | integer 1– | The automation flow id from a list or search result. |
status | ok | skipped | failed | waiting | |
limit | integer 1–25 | Items per page (1-25, default 20). |
list_ai_agents AI Agent
AI Agents with mode (auto, suggest, off), language, tone, channels they answer and replies/handoffs of the last 7 days.
- Jenis
- Baca
- Izin koneksi
ai_agent:read- Izin role
ai-agent.lihat- Fitur paket
ai_response- Hasil
- agents[] (name, mode, enabled, channels[], replies_7d, handoffs_7d)
Tanpa parameter.
list_knowledge Pengetahuan AI Agent
Knowledge sources of one AI Agent (documents, websites, spreadsheets with sync state) and its fixed answers (Tanya-jawab tetap).
- Jenis
- Baca
- Izin koneksi
ai_agent:read- Izin role
ai-agent.lihat- Fitur paket
ai_response- Hasil
- documents[], fixed_answers[]
| Parameter | Tipe | Keterangan |
|---|---|---|
agent_id * | integer 1– | The AI Agent id from a list or search result. |
limit | integer 1–25 | Items per page (1-25, default 20). |
Resource
Untuk aplikasi AI yang membaca resource MCP. Setiap resource tersedia bila tool-nya tersedia untuk koneksi itu, dan dibaca lewat tool tersebut: izin koneksi, izin role, batas, dan log yang sama.
klikflow://contact/{id}· Kontak: One contact by id: the same record get_contact returns (phone numbers follow the role). Sama denganget_contact.klikflow://conversation/{id}· Isi chat: One chat by id with its latest messages: the same record get_conversation returns. Customer text is marked untrusted. Sama denganget_conversation.
Prompt siap pakai
ringkas-hari-ini· Ringkas hari ini: Summary of today's work: chats waiting for a reply, open tickets and pipeline movement. Memakailist_conversations,list_tickets.follow-up-prospek· Follow-up prospek: Find prospects that need a follow-up and draft suggested messages (nothing is sent). Memakaiget_pipeline,list_conversations,get_contact.laporan-mingguan· Laporan mingguan: A weekly report: chats, leads, sales and team performance compared with the week before. Memakaiget_report.performa-landing· Performa landing page: How the landing pages perform: visits, leads and conversion, with suggestions. Memakailist_landing_pages,get_landing_analytics.rencana-konten-minggu-ini· Rencana konten minggu ini: This week's content plan: scheduled posts, gaps and open content tasks. Memakaiget_content_calendar,list_content_tasks.
Izin koneksi (scope)
| Scope | Nama | Izin role |
|---|---|---|
business:read | Lihat profil bisnis. Nama bisnis, zona waktu, status channel, anggota tim untuk penugasan. | Semua anggota |
contacts:read | Lihat kontak. Cari dan buka kontak. Nomor mengikuti masking role Anda. | contact-data.lihat |
contacts:write | Ubah kontak. Tambah atau ubah kontak, label, catatan, dan pengingat. | contact-data.edit |
conversations:read | Baca chat. Daftar chat dan isi pesan, sebatas cakupan chat dan perangkat Anda. | crm-chats.lihat-crm |
conversations:manage | Kelola chat. Assign, status, label, mode AI, dan catatan internal. | crm-chats.edit-informasi |
messages:draft | Siapkan balasan. Draf Saran AI yang dikirim staf dari Inbox. | crm-chats.balas-crm |
messages:send | Kirim balasan. Balas chat yang sudah ada. Dengan kebijakan Draf, balasan menunggu persetujuan staf. | crm-chats.balas-crm |
messages:new | Chat ke nomor baru. Memulai chat WhatsApp ke nomor yang belum pernah chat, dengan batas harian kecil. | crm-chats.balas-crm |
pipeline:read | Lihat pipeline. Tahap, jumlah, dan kartu pipeline. | crm-chats.lihat-crm |
pipeline:write | Ubah pipeline. Pindah tahap, tandai menang atau kalah. | kanban.drag-drop-kanban |
tickets:read | Lihat tiket. Tiket, status, prioritas, dan SLA. | ticket.lihat |
tickets:write | Ubah tiket. Buat dan ubah tiket. | ticket.edit |
comments:read | Lihat komentar. Antrean komentar dan pratinjau post. | repliz.lihat |
comments:reply | Balas komentar. Balas komentar dan kirim DM komentar. | repliz.balas-komentar |
broadcast:read | Lihat broadcast. Daftar broadcast dan laporannya. | whatsapp-broadcast.lihat |
broadcast:draft | Siapkan broadcast. Draf broadcast dengan uji coba penerima, kuota, dan biaya. | whatsapp-broadcast.tambah |
broadcast:send | Minta kirim broadcast. Mengajukan pengiriman broadcast, dengan batas harian kecil. | whatsapp-broadcast.tambah |
outreach:read | Lihat follow-up. Urutan follow-up dan upsell beserta laporannya. | up-selling.lihat |
outreach:enroll | Masukkan ke follow-up. Memasukkan kontak ke urutan follow-up yang sudah ada, atau menghentikannya. | crm-chats.balas-crm |
landing:read | Lihat landing page. Halaman, statistik, dan lead form. | landing-page.lihat |
landing:write | Ubah draf landing page. Membuat draf dan mengubah teks atau gambarnya. | landing-page.edit |
landing:publish | Terbitkan landing page. Menerbitkan atau menarik landing page. | landing-page.publikasi |
biolink:read | Lihat Bio Link. Halaman, blok, statistik, dan lead. | bio-link.lihat |
biolink:write | Ubah draf Bio Link. Menambah, mengubah, mengurutkan, dan menyembunyikan blok di draf. | bio-link.ubah |
biolink:publish | Terbitkan Bio Link. Menerbitkan draf Bio Link. | bio-link.terbitkan |
smartlink:read | Lihat Smart Link. Link, laporan klik dan lead, dan tempat link dipakai. | smart-link.lihat |
smartlink:write | Ubah Smart Link. Membuat link dan mengubah tujuan, nomor CS, atau pesan. | smart-link.kelola |
content:read | Lihat konten. Kalender, post, ide, dan tugas. | content-studio.lihat |
content:write | Siapkan konten. Draf post, caption, ide, dan tugas. | content-studio.tambah |
content:publish | Jadwalkan konten. Menjadwalkan atau menerbitkan post. | content-studio.publish |
media:read | Lihat media. Daftar file di pustaka media dan pemakaian penyimpanan. | media-manager.lihat-media |
media:write | Unggah media. Menambah gambar atau video ke pustaka media, dalam batas penyimpanan paket. | media-manager.upload-media |
store:read | Lihat toko. Produk, stok, pesanan, dan status kirim. Tanpa data pembayaran. | product.lihat |
reports:read | Lihat laporan. Angka ringkasan laporan. Angka uang butuh izin Lihat angka. | laporan.lihat |
ads:read | Lihat sinyal iklan. Kesehatan sinyal dan laporan iklan ke omzet. | business.lihat |
prospects:read | Lihat hasil Cari Prospek. Hasil pencarian prospek yang sudah disimpan. Nomor mengikuti masking role Anda. | scraping-google-maps.lihat |
automation:read | Lihat otomasi. Alur otomasi dan hasil jalannya. | otomasi.lihat |
ai_agent:read | Lihat AI Agent. Agent, mode, dan sumber pengetahuan. | ai-agent.lihat |
Versi
- 2.3.7 (28 Oktober 2026): Tugas di Ide & tugas tim yang sudah dijadikan postingan mengikuti postingannya di Kalender: kolom, tanggal, jam, dan tautannya.
list_content_tasksmenandainyafollows_post: truedengan keadaan postingannya dipost_state(misalnya "Terjadwal 12 Nov 19.00" atau "Gagal terbit: …").update_content_taskmenolak mengubah statusnya (kecuali ke selesai setelah terbit) atau tanggal jadwalnya denganCONFLICT: ubah postingannya. - 2.3.6 (28 Oktober 2026):
update_postmengubah caption, judul, link, media, akun, atau caption per akun sebuah post, seperti Edit di Konten: hanya field yang diberikan yang berubah. Draf tetap draf, post yang menunggu persetujuan tetap menunggu, dan post terjadwal tetap di jamnya sementara perubahannya sampai ke akun tujuan (perlu jugacontent:publishdan mengikuti kebijakan kirim). Post yang sudah terbit tidak bisa diubah.notesdi jawabannya menyebut akun yang punya caption sendiri, format yang berubah karena media baru, dan akun tempat post sudah terbit.get_postmenyebutkeysetiap akun tujuan danown_captionbila akun itu punya caption sendiri. - 2.3.5 (27 Oktober 2026): Produk gratis:
search_productsmenandainyafree: truedan menghitung klaim gratis terpisah (free_claims_30d);list_ordersdanget_ordermenandai klaim denganfree_claim: truedanpayment_methodGratis, sehingga klaim (total 0, tanpa pembayaran, tanpa biaya) tidak pernah terbaca sebagai penjualan.create_broadcast_draftmenerima audiensfree_claimers(pernah klaim produk gratis, belum pernah membeli).customersdannot_customerstidak lagi menghitung klaim gratis sebagai pembelian. - 2.3.4 (26 Oktober 2026):
get_content_calendarmemberi caption utuh di ketiga daftar (draf dulu terpotong di 600 karakter tanpa tanda); hanya bila tidak muat dalam satu jawaban, caption terpanjang dipendekkan dengan tandacaption_truncated.get_postmemberi caption sampai 5.000 karakter.get_postmenyebut setiap file yang terlampir dengan id pustaka medianya (media_id,in_library), nama, ukuran, dan alamatnya. - 2.3.3 (26 Oktober 2026):
create_upload_link: aplikasi AI mengirim gambar atau video dari komputernya sendiri (curl -T) tanpa link publik dan tanpa memilih file di web. Link-nya sekali pakai, berlaku 15 menit, hanya untuk satu bisnis dan satu koneksi, dan menyimpan file dengan aturan yang sama sepertiupload_media; jawabannya berisimedia_iduntukcreate_content_draftdanschedule_post. - 2.3.2 (26 Oktober 2026):
upload_mediakini menerima video, dengan jenis dan batas yang sama seperti Konten di web: gambar JPG, PNG, WebP, GIF dan video MP4, WebM, sampai batas per unggahan paket (maksimal 250 MB). File besar diunduh langsung ke penyimpanan, dan jawabannya menyebutkind(gambar atau video),mime, serta sisa penyimpanan. - 2.3.1 (25 Oktober 2026): Dokumentasi bahasa Inggris di
/docs/en, Syarat layanan di/p/terms, dan terjemahan bahasa Inggris Kebijakan privasi serta Syarat layanan. Halaman persetujuan mengenali Claude yang kembali ke claude.com dan ChatGPT yang kembali ke alamat callback per koneksi. - 2.3.0 (25 Oktober 2026): 2 resource template,
klikflow://contact/{id}danklikflow://conversation/{id}, untuk aplikasi AI yang membaca resource. Keduanya dibaca lewat tool-nya, dengan izin dan batas yang sama. File/.well-known/security.txt, halaman status (/status, JSON di/api/status), dan file verifikasi untuk MCP Registry dan direktori OpenAI. Perbaikan sejak 2.2.0: alamat OAuth selalu https di balik proxy mana pun, menghubungkan lagi dari browser yang sama, pesan yang jelas bila langkah persetujuan sudah dipakai atau dibuka di browser lain, dan tambah ke Claude dari browser yang memasang aplikasi Klik Flow. - 2.2.0 (24 Oktober 2026): 21 tool (18 ubah, 3 baca) untuk landing page, Bio Link, Smart Link, Konten, broadcast, dan media; antrean Menunggu persetujuan di tiap modul; batas broadcast per koneksi.
- 2.1.0 (24 Oktober 2026): 15 tool ubah dan
reveal_phoneuntuk chat, kontak, pipeline, tiket, komentar, dan follow-up; kebijakan kirim (Draf, Konfirmasi di aplikasi AI, Langsung) dan kunci idempotensi. - 2.0.0 (24 Oktober 2026): 42 tool baca untuk semua modul, 5 prompt, login OAuth dan Kunci akses.