سرور MCP

خودکارسازی‌ها

ایمیل‌ها و گام‌هایی که برای هر مخاطب خودشان اجرا می‌شوند، و رویدادهایی که آن‌ها را شروع می‌کنند.

ابزارهای خودکارسازی

ابزار	چه می‌کند
listAutomations	خودکارسازی‌های فضای کاری، به ترتیب تازه‌ترین تغییر، با وضعیتشان، آنچه هر کدام را شروع می‌کند و شمار مخاطبان درون هر کدام.
getAutomation	یک خودکارسازی به‌طور کامل: وضعیت، تنظیمات و آمارش، مشکل‌های پیش‌نویسش، و تعریف پیش‌نویس به‌صورت JSON. `includePublished` نسخه‌ای را که در حال اجراست اضافه می‌کند.
listAutomationStarters	خودکارسازی‌های آماده‌ای که یک خودکارسازی تازه می‌تواند از آن‌ها آغاز شود، هر کدام با تعریفش.
createAutomation	یک پیش‌نویس از یک نقطهٔ شروع، از تعریفی که به‌صورت JSON نوشته شده، یا خالی بسازید، با هر تنظیمی. تا منتشر نشود چیزی اجرا نمی‌شود.
updateAutomation	نام و تنظیمات یک خودکارسازی را، که بی‌درنگ اعمال می‌شوند، تغییر دهید یا تعریف پیش‌نویسش را جایگزین کنید. خودکارسازی فعال همچنان نسخهٔ منتشرشده‌اش را اجرا می‌کند.
deleteAutomation	یک خودکارسازی را برای همیشه حذف کنید، با نسخه‌ها، حضورها و آمارش. مخاطبان درون آن بی‌درنگ متوقف می‌شوند.
publishAutomation	پیش‌نویس را به نسخه‌ای که اجرا می‌شود بدل کنید و خودکارسازی را روشن کنید. پیش‌نویس ناکامل همراه با هر مشکلی که جلویش را می‌گیرد رد می‌شود. به `emails:send` هم نیاز دارد.
pauseAutomation	یک خودکارسازی فعال را متوقف کنید. کس تازه‌ای وارد نمی‌شود، و همهٔ افراد درون آن همان‌جا که هستند می‌مانند.
resumeAutomation	یک خودکارسازی متوقف را با همان نسخه‌ای که اجرا می‌کرد دوباره روشن کنید. به `emails:send` هم نیاز دارد.
archiveAutomation	یک خودکارسازی را برای همیشه کنار بگذارید و سابقه‌اش را نگه دارید. همهٔ افراد درون آن خارج می‌شوند.
duplicateAutomation	یک خودکارسازی را در یک پیش‌نویس تازه کپی کنید، بدون نسخه‌ها، مخاطبان و آمارش.
sendAutomationTest	ایمیل یک گام از پیش‌نویس را برای خودتان یا به یک نشانی بفرستید. به `emails:send` هم نیاز دارد.
listAutomationVersions	نسخه‌های منتشرشده، تازه‌ترین در ابتدا، و اینکه کدام در حال اجراست. `includeDefinitions` تعریف هر نسخه را اضافه می‌کند.
restoreAutomationVersion	یک نسخهٔ قبلی را به پیش‌نویس برگردانید. تا انتشار بعدی چیزی از آنچه در حال اجراست تغییر نمی‌کند.
getAutomationStats	مخاطبانی که وارد شده‌اند، اکنون درون آن هستند، کامل کرده‌اند و خارج شده‌اند، و ایمیل‌های ارسال‌شده، تحویل‌شده، بازشده و کلیک‌شده در یک بازهٔ زمانی، در مجموع و برای هر گام.
listAutomationEnrollments	مخاطبانی که در یک خودکارسازی هستند یا بوده‌اند، صفحه‌به‌صفحه، با گامی که هر کدام در آن است و اینکه چطور تمام شد. بر پایهٔ وضعیت، گام یا بخشی از نشانی فیلتر کنید.
getAutomationEnrollment	مسیر یک مخاطب در یک خودکارسازی: هر گام برای او چه کرد، قدیمی‌ترین در ابتدا.
enrollInAutomation	یک مخاطب را از گام اول وارد یک خودکارسازی فعال کنید، صرف‌نظر از اینکه معمولاً چه چیزی آن را شروع می‌کند.
removeFromAutomation	یک مخاطب را بی‌درنگ از یک خودکارسازی خارج کنید.
sendContactEvent	ثبت کنید که برای یک مخاطب چیزی رخ داده است. این کار خودکارسازی‌های فعالی را که آغازگرشان این رویداد را نام می‌برد شروع می‌کند و انتظارهایی را که چشم‌به‌راهش بودند تمام می‌کند.
sendContactEvents	تا 100 رویداد را در یک فراخوانی ثبت کنید. شکست یکی جلوی بقیه را نمی‌گیرد.
listContactEventNames	نام رویدادهایی که فضای کاری در 90 روز گذشته ثبت کرده است.
listContactEvents	رویدادهای ثبت‌شده برای یک مخاطب، تازه‌ترین در ابتدا، صفحه‌به‌صفحه.

خواندن به automations:read و هر تغییر به automations:write نیاز دارد. انتشار، ادامه دادن و ارسال آزمایش به emails:send هم نیاز دارند، چون خودکارسازی پس از آن از طرف کسی که منتشرش کرده نامه می‌فرستد. ارسال یک رویداد به contacts:write نیاز دارد، خواندن رویدادهای یک مخاطب به contacts:read، و listContactEventNames به automations:read. کلاینتی که از طرف یک عضو عمل می‌کند فقط خودکارسازی‌هایی را می‌بیند که همان عضو ساخته و مخاطبانی را که همان عضو افزوده است.

برخی ابزارهای این سرور تغییری انجام می‌دهند که REST API آن را با کد تأیید هویت محافظت می‌کند، و همان کد را می‌خواهند. تا وقتی کلاینت در 60 دقیقهٔ گذشته کدی را تأیید نکرده باشد و شخص هم در حساب ← برنامه‌های متصل برای آن «اجازهٔ تغییرات برای 60 دقیقه» را انتخاب نکرده باشد، چنین ابزاری با نتیجه‌ای پاسخ می‌دهد که با Refused (step_up_required): شروع می‌شود و چیزی را تغییر نمی‌دهد. emptyAudience هرگز کد نمی‌خواهد. صفحهٔ احراز هویت API همهٔ ابزارهایی را که کد می‌خواهند فهرست می‌کند و نشان می‌دهد چگونه کد بخواهید و آن را تأیید کنید.

ابزارها همان قاعده‌ها و ردشدن‌های REST API را به کار می‌بندند، و صفحه‌های /automations و /events در مرجع API هر فیلد را شرح می‌دهند. تعریف به‌طور کامل به‌صورت JSON داده می‌شود: آن را با getAutomation بخوانید، تغییرش دهید و همه‌اش را به updateAutomation برگردانید.

مرجع

`listAutomations`

automations:readدستیار برنامه آن را بدون پرسیدن اجرا می‌کندجعبه‌ابزارautomations

List the automations in this workspace, the most recently changed first: name, id, status (draft, live, paused or archived), what starts each one, its steps and how many contacts are in it now, completed it or left early. Use it to find an automation by name before reading or changing it. One page at a time: when more follow, the last line gives a cursor to pass back.

ورودی‌ها

statusstring: یکی از"draft""live""paused""archived"
limitinteger: دست‌کم 1حداکثر 100
cursorstring: 1 تا 64 نویسه

همچنین در دسترس در

API: GET /automations
TypeScript: automations.list()automations.listAll()automations.iterate()
Python: automations.list()automations.list_all()automations.iterate()
Ruby: automations.listautomations.list_allautomations.iterate
PHP: automations->listautomations->listAllautomations->iterate
Go: Automations.ListAutomations.ListAllAutomations.Iterate
Java: automations().listautomations().listAllautomations().iterate
C#: Automations.ListAsyncAutomations.ListAllAsyncAutomations.IterateAsync

`getAutomation`

automations:readدستیار برنامه آن را بدون پرسیدن اجرا می‌کندجعبه‌ابزارautomations

Read one automation: its status, settings, numbers, what is wrong with its draft, and the draft definition (trigger and steps) as JSON, to change and pass back to updateAutomation. includePublished adds the definition of the version that is running, which differs from the draft while there are unpublished changes.

ورودی‌ها

idstringالزامی: The automation, by id (aut_...). listAutomations finds it by name.
1 تا 64 نویسه
includePublishedboolean: پیش‌فرضfalse

همچنین در دسترس در

API: GET /automations/{id}
TypeScript: automations.get()
Python: automations.get()
Ruby: automations.get
PHP: automations->get
Go: Automations.Get
Java: automations().get
C#: Automations.GetAsync

`listAutomationStarters`

automations:readدستیار برنامه آن را بدون پرسیدن اجرا می‌کندجعبه‌ابزارautomations

The ready-made automations a new one can begin from, such as a welcome series or a birthday note: slug, name, what each is for and its definition as JSON. Pass a slug to createAutomation as starter. A starter leaves the audience, the templates and the from address empty to fill in.

ورودی‌ها

هیچ ورودی‌ای نمی‌گیرد.

همچنین در دسترس در

API: GET /automations/starters
TypeScript: automations.listStarters()
Python: automations.list_starters()
Ruby: automations.list_starters
PHP: automations->listStarters
Go: Automations.ListStarters
Java: automations().listStarters
C#: Automations.ListStartersAsync

`createAutomation`

automations:writeدستیار برنامه اول می‌پرسد، مگر آنکه خودتان آن را خواسته باشیدجعبه‌ابزارautomations

Create an automation as a draft: from a starter (listAutomationStarters names them), from a definition written out as JSON, or empty. Nothing runs until publishAutomation. The answer lists what the draft still needs before it can be published, such as a template or a from address for each email. Find audiences with listAudiences, templates with listTemplates and forms with listForms.

ورودی‌ها

namestringالزامی: A short name for the automation. Contacts never see it.
1 تا 120 نویسه
descriptionstring: One line about what it is for.
تا 500 نویسه
starterstring: 1 تا 64 نویسه
definitionRecord<string, any> | string: The trigger and steps as JSON: {"trigger": {...}, "entry": "<key of the first step>", "steps": [...]}. Triggers: {"kind": "audience_joined", "audienceId", "includeImported": false}, {"kind": "form_submitted", "formId"}, {"kind": "event", "eventName", "filters": []}, {"kind": "date", "field": "birthday" or "joined", "audienceId", "offsetDays": 0} and {"kind": "manual"}. Every step has a unique key of 3 to 24 lowercase letters and digits starting with a letter, and points at the next step by key in next, or null to end the path. Steps: {"kind": "send_email", "key", "next", "templateId", "templateVersion": null, "from": {"email", "name"}, "replyTo": null, "subject": null, "props": {}}, {"kind": "wait", "key", "next", "wait": {"mode": "duration", "amount": 3, "unit": "days"}}, {"kind": "branch", "key", "condition": {"kind": "email_clicked", "stepKey"}, "yes", "no"}, {"kind": "add_to_audience" or "remove_from_audience", "key", "next", "audienceId"}, {"kind": "update_field", "key", "next", "field", "value": {"source": "static", "value"}}, {"kind": "webhook", "key", "next", "endpointId"} and {"kind": "exit", "key"}. A wait can also be {"mode": "until", "weekdays": [1], "hour": 9, "minute": 0} or {"mode": "event", "eventName", "timeout": {"amount": 7, "unit": "days"}}. Conditions: email_opened and email_clicked with stepKey, in_audience with audienceId, field with field, operator and value, and event with eventName and withinDays. A props value is {"source": "static", "value"}, {"source": "contact", "field"} or {"source": "event", "path"}. Paths never join or loop. getAutomation shows a saved definition in this shape, and listAutomationStarters has ready-made ones.
settingsRecord<string, any> | string: How it runs, as JSON with any of: timezone (an IANA zone such as Europe/London), sendWindow ({"days": [1, 2, 3, 4, 5], "startMinute": 540, "endMinute": 1020} or null for any time), reentryDays (days after finishing before a contact may enter again, or null for once only), exitOnLeave (true takes a contact out when they leave the audience that started it) and listAudienceId (the audience unsubscribes are recorded in).

همچنین در دسترس در

API: POST /automations
TypeScript: automations.create()
Python: automations.create()
Ruby: automations.create
PHP: automations->create
Go: Automations.Create
Java: automations().create
C#: Automations.CreateAsync

`updateAutomation`

automations:writeدستیار برنامه اول می‌پرسد، مگر آنکه خودتان آن را خواسته باشیدجعبه‌ابزارautomations

Change an automation. Its name, description and settings apply at once. definition replaces the whole draft, so start from getAutomation, change the JSON and pass all of it back. A live automation keeps running its published version until publishAutomation, and contacts already in it stay on the version they entered on. Pass only what changes.

ورودی‌ها

idstringالزامی: The automation, by id (aut_...). listAutomations finds it by name.
1 تا 64 نویسه
namestring: 1 تا 120 نویسه
descriptionstring: می‌تواند null باشدتا 500 نویسه
definitionRecord<string, any> | string: The trigger and steps as JSON: {"trigger": {...}, "entry": "<key of the first step>", "steps": [...]}. Triggers: {"kind": "audience_joined", "audienceId", "includeImported": false}, {"kind": "form_submitted", "formId"}, {"kind": "event", "eventName", "filters": []}, {"kind": "date", "field": "birthday" or "joined", "audienceId", "offsetDays": 0} and {"kind": "manual"}. Every step has a unique key of 3 to 24 lowercase letters and digits starting with a letter, and points at the next step by key in next, or null to end the path. Steps: {"kind": "send_email", "key", "next", "templateId", "templateVersion": null, "from": {"email", "name"}, "replyTo": null, "subject": null, "props": {}}, {"kind": "wait", "key", "next", "wait": {"mode": "duration", "amount": 3, "unit": "days"}}, {"kind": "branch", "key", "condition": {"kind": "email_clicked", "stepKey"}, "yes", "no"}, {"kind": "add_to_audience" or "remove_from_audience", "key", "next", "audienceId"}, {"kind": "update_field", "key", "next", "field", "value": {"source": "static", "value"}}, {"kind": "webhook", "key", "next", "endpointId"} and {"kind": "exit", "key"}. A wait can also be {"mode": "until", "weekdays": [1], "hour": 9, "minute": 0} or {"mode": "event", "eventName", "timeout": {"amount": 7, "unit": "days"}}. Conditions: email_opened and email_clicked with stepKey, in_audience with audienceId, field with field, operator and value, and event with eventName and withinDays. A props value is {"source": "static", "value"}, {"source": "contact", "field"} or {"source": "event", "path"}. Paths never join or loop. getAutomation shows a saved definition in this shape, and listAutomationStarters has ready-made ones.
settingsRecord<string, any> | string: How it runs, as JSON with any of: timezone (an IANA zone such as Europe/London), sendWindow ({"days": [1, 2, 3, 4, 5], "startMinute": 540, "endMinute": 1020} or null for any time), reentryDays (days after finishing before a contact may enter again, or null for once only), exitOnLeave (true takes a contact out when they leave the audience that started it) and listAudienceId (the audience unsubscribes are recorded in).
expectedUpdatedAtstring: The Updated time getAutomation gave. When somebody saved the automation since, the change is refused instead of written over theirs.
قالبdate-time

همچنین در دسترس در

API: PATCH /automations/{id}
TypeScript: automations.update()
Python: automations.update()
Ruby: automations.update
PHP: automations->update
Go: Automations.Update
Java: automations().update
C#: Automations.UpdateAsync

`deleteAutomation`

automations:writeدستیار برنامه همیشه اول می‌پرسدجعبه‌ابزارautomations

Delete an automation for good, with its versions, its enrollments and its numbers. Contacts in it stop at once. The emails it already sent stay. It cannot be undone: to retire one and keep its history, use archiveAutomation.

کد تأیید می‌خواهد
DELETE /automations/{id}

ورودی‌ها

idstringالزامی: The automation, by id (aut_...). listAutomations finds it by name.
1 تا 64 نویسه

همچنین در دسترس در

API: DELETE /automations/{id}
TypeScript: automations.delete()
Python: automations.delete()
Ruby: automations.delete
PHP: automations->delete
Go: Automations.Delete
Java: automations().delete
C#: Automations.DeleteAsync

`publishAutomation`

automations:writeemails:sendدستیار برنامه همیشه اول می‌پرسدجعبه‌ابزارautomations

Publish an automation: its draft becomes the version that runs and it goes live, so its trigger starts putting contacts in and its emails start going out. Use it for a first publish and to put later changes to work. The draft has to be complete, and a refusal lists every problem that blocks it. Contacts already in it stay on the version they entered on.

ورودی‌ها

idstringالزامی: The automation, by id (aut_...). listAutomations finds it by name.
1 تا 64 نویسه

همچنین در دسترس در

API: POST /automations/{id}/publish
TypeScript: automations.publish()
Python: automations.publish()
Ruby: automations.publish
PHP: automations->publish
Go: Automations.Publish
Java: automations().publish
C#: Automations.PublishAsync

`pauseAutomation`

automations:writeدستیار برنامه اول می‌پرسد، مگر آنکه خودتان آن را خواسته باشیدجعبه‌ابزارautomations

Pause a live automation. Nobody new enters, and everyone in it stays where they are and moves on when it is resumed with resumeAutomation.

ورودی‌ها

idstringالزامی: The automation, by id (aut_...). listAutomations finds it by name.
1 تا 64 نویسه

همچنین در دسترس در

API: POST /automations/{id}/pause
TypeScript: automations.pause()
Python: automations.pause()
Ruby: automations.pause
PHP: automations->pause
Go: Automations.Pause
Java: automations().pause
C#: Automations.PauseAsync

`resumeAutomation`

automations:writeemails:sendدستیار برنامه همیشه اول می‌پرسدجعبه‌ابزارautomations

Turn a paused automation back on with the version it was running, without publishing the draft. Contacts that were held move on and its emails go out again. One that was paused because something it needs went away stays paused until that is fixed, and the refusal says what.

ورودی‌ها

idstringالزامی: The automation, by id (aut_...). listAutomations finds it by name.
1 تا 64 نویسه

همچنین در دسترس در

API: POST /automations/{id}/resume
TypeScript: automations.resume()
Python: automations.resume()
Ruby: automations.resume
PHP: automations->resume
Go: Automations.Resume
Java: automations().resume
C#: Automations.ResumeAsync

`archiveAutomation`

automations:writeدستیار برنامه همیشه اول می‌پرسدجعبه‌ابزارautomations

Retire an automation for good and keep its history. Everyone in it leaves, nobody enters again and it can no longer be changed, published or resumed. Its versions, enrollments and numbers stay readable. To stop one for a while, use pauseAutomation.

ورودی‌ها

idstringالزامی: The automation, by id (aut_...). listAutomations finds it by name.
1 تا 64 نویسه

همچنین در دسترس در

API: POST /automations/{id}/archive
TypeScript: automations.archive()
Python: automations.archive()
Ruby: automations.archive
PHP: automations->archive
Go: Automations.Archive
Java: automations().archive
C#: Automations.ArchiveAsync

`duplicateAutomation`

automations:writeدستیار برنامه اول می‌پرسد، مگر آنکه خودتان آن را خواسته باشیدجعبه‌ابزارautomations

Copy an automation into a new draft with "(copy)" after its name: the same draft definition and settings, and none of its versions, contacts or numbers.

ورودی‌ها

idstringالزامی: The automation, by id (aut_...). listAutomations finds it by name.
1 تا 64 نویسه

همچنین در دسترس در

API: POST /automations/{id}/duplicate
TypeScript: automations.duplicate()
Python: automations.duplicate()
Ruby: automations.duplicate
PHP: automations->duplicate
Go: Automations.Duplicate
Java: automations().duplicate
C#: Automations.DuplicateAsync

`sendAutomationTest`

automations:writeemails:sendدستیار برنامه همیشه اول می‌پرسدجعبه‌ابزارautomations

Send the email of one step of the draft to one address, to read it before publishing. It goes to the user's own account address unless to names another. Contact values come from a sample contact, the subject starts with [Test], and nobody is enrolled. It counts toward the monthly sends.

ورودی‌ها

idstringالزامی: The automation, by id (aut_...). listAutomations finds it by name.
1 تا 64 نویسه
stepKeystringالزامی: The key of the email step, from the definition getAutomation returns.
1 تا 64 نویسه
tostring: Where the test goes, when not to the user themselves.
تا 320 نویسهقالبemail

همچنین در دسترس در

API: POST /automations/{id}/test
TypeScript: automations.sendTest()
Python: automations.send_test()
Ruby: automations.send_test
PHP: automations->sendTest
Go: Automations.SendTest
Java: automations().sendTest
C#: Automations.SendTestAsync

`listAutomationVersions`

automations:readدستیار برنامه آن را بدون پرسیدن اجرا می‌کندجعبه‌ابزارautomations

The published versions of an automation, the newest first: number, when it was published and whether it is the one running. includeDefinitions adds each definition as JSON. restoreAutomationVersion copies one back into the draft.

ورودی‌ها

idstringالزامی: The automation, by id (aut_...). listAutomations finds it by name.
1 تا 64 نویسه
includeDefinitionsboolean: پیش‌فرضfalse

همچنین در دسترس در

API: GET /automations/{id}/versions
TypeScript: automations.listVersions()
Python: automations.list_versions()
Ruby: automations.list_versions
PHP: automations->listVersions
Go: Automations.ListVersions
Java: automations().listVersions
C#: Automations.ListVersionsAsync

`restoreAutomationVersion`

automations:writeدستیار برنامه اول می‌پرسد، مگر آنکه خودتان آن را خواسته باشیدجعبه‌ابزارautomations

Copy the definition of an earlier version back into the draft, replacing what the draft holds. Nothing that is running changes until publishAutomation.

ورودی‌ها

idstringالزامی: The automation, by id (aut_...). listAutomations finds it by name.
1 تا 64 نویسه
versionintegerالزامی: The version number, from listAutomationVersions.
دست‌کم 1

همچنین در دسترس در

API: POST /automations/{id}/versions/{version}/restore
TypeScript: automations.restoreVersion()
Python: automations.restore_version()
Ruby: automations.restore_version
PHP: automations->restoreVersion
Go: Automations.RestoreVersion
Java: automations().restoreVersion
C#: Automations.RestoreVersionAsync

`getAutomationStats`

automations:readدستیار برنامه آن را بدون پرسیدن اجرا می‌کندجعبه‌ابزارautomations

How one automation did over a window, 30 days by default: contacts that entered, are in it now, completed it or left early, emails sent, delivered, opened, clicked, bounced and marked as spam, and unsubscribes, in total and for each step. Opens are a floor, because many mail apps hide them. includeDaily adds a line for each day.

ورودی‌ها

idstringالزامی: The automation, by id (aut_...). listAutomations finds it by name.
1 تا 64 نویسه
sincestring: Where the window starts, as an ISO 8601 instant.
قالبdate-time
untilstring: Where the window ends, as an ISO 8601 instant. Left out, now.
قالبdate-time
includeDailyboolean: پیش‌فرضfalse

همچنین در دسترس در

API: GET /automations/{id}/stats
TypeScript: automations.stats()
Python: automations.stats()
Ruby: automations.stats
PHP: automations->stats
Go: Automations.Stats
Java: automations().stats
C#: Automations.StatsAsync

`listAutomationEnrollments`

automations:readدستیار برنامه آن را بدون پرسیدن اجرا می‌کندجعبه‌ابزارautomations

The contacts that are in an automation or have been, the most recent entry first: which step each is at, what they are waiting for, what holds a step that is due, when they move next and how it ended. Narrow it by status, by step or by a piece of the address or name. One page at a time: when more follow, the last line gives a cursor.

ورودی‌ها

idstringالزامی: The automation, by id (aut_...). listAutomations finds it by name.
1 تا 64 نویسه
statusstring: یکی از"active""completed""exited"
stepKeystring: 1 تا 64 نویسه
qstring: تا 200 نویسه
limitinteger: دست‌کم 1حداکثر 200
cursorstring: 1 تا 64 نویسه

همچنین در دسترس در

API: GET /automations/{id}/enrollments
TypeScript: automations.listEnrollments()automations.listAllEnrollments()automations.iterateEnrollments()
Python: automations.list_enrollments()automations.list_all_enrollments()automations.iterate_enrollments()
Ruby: automations.list_enrollmentsautomations.list_all_enrollmentsautomations.iterate_enrollments
PHP: automations->listEnrollmentsautomations->listAllEnrollmentsautomations->iterateEnrollments
Go: Automations.ListEnrollmentsAutomations.ListAllEnrollmentsAutomations.IterateEnrollments
Java: automations().listEnrollmentsautomations().listAllEnrollmentsautomations().iterateEnrollments
C#: Automations.ListEnrollmentsAsyncAutomations.ListAllEnrollmentsAsyncAutomations.IterateEnrollmentsAsync

`getAutomationEnrollment`

automations:readدستیار برنامه آن را بدون پرسیدن اجرا می‌کندجعبه‌ابزارautomations

One contact's way through an automation: where they are, and what each step did for them, oldest first, such as an email sent, a wait, a yes or no at a branch, or why a step was skipped or failed.

ورودی‌ها

idstringالزامی: The automation, by id (aut_...). listAutomations finds it by name.
1 تا 64 نویسه
enrollmentIdstringالزامی: The enrollment, by id (aen_...), from listAutomationEnrollments.
1 تا 64 نویسه

همچنین در دسترس در

API: GET /automations/{id}/enrollments/{enrollmentId}
TypeScript: automations.getEnrollment()
Python: automations.get_enrollment()
Ruby: automations.get_enrollment
PHP: automations->getEnrollment
Go: Automations.GetEnrollment
Java: automations().getEnrollment
C#: Automations.GetEnrollmentAsync

`enrollInAutomation`

automations:writeدستیار برنامه همیشه اول می‌پرسدجعبه‌ابزارautomations

Put one contact into a live automation at its first step, whatever starts it normally, so its emails start going to them. The contact has to exist already. A contact is in an automation once at a time, and an address that is suppressed or unsubscribed is refused.

ورودی‌ها

idstringالزامی: The automation, by id (aut_...). listAutomations finds it by name.
1 تا 64 نویسه
emailstringالزامی: The contact to enroll, by email address.
تا 320 نویسهقالبemail
dataRecord<string, any>: Values the steps read wherever a value comes from the event, such as an order number. At most 50 keys and 4 KB of JSON.

همچنین در دسترس در

API: POST /automations/{id}/enrollments
TypeScript: automations.enroll()
Python: automations.enroll()
Ruby: automations.enroll
PHP: automations->enroll
Go: Automations.Enroll
Java: automations().enroll
C#: Automations.EnrollAsync

`removeFromAutomation`

automations:writeدستیار برنامه اول می‌پرسد، مگر آنکه خودتان آن را خواسته باشیدجعبه‌ابزارautomations

Take one contact out of an automation at once, by the id of their enrollment from listAutomationEnrollments. They get nothing more from it, and stay in the contacts and in their audiences.

ورودی‌ها

idstringالزامی: The automation, by id (aut_...). listAutomations finds it by name.
1 تا 64 نویسه
enrollmentIdstringالزامی: The enrollment, by id (aen_...), from listAutomationEnrollments.
1 تا 64 نویسه

همچنین در دسترس در

API: POST /automations/{id}/enrollments/{enrollmentId}/exit
TypeScript: automations.exitEnrollment()
Python: automations.exit_enrollment()
Ruby: automations.exit_enrollment
PHP: automations->exitEnrollment
Go: Automations.ExitEnrollment
Java: automations().exitEnrollment
C#: Automations.ExitEnrollmentAsync

`sendContactEvent`

contacts:writeدستیار برنامه همیشه اول می‌پرسدجعبه‌ابزارautomations

Record that something happened to one contact, such as order.placed or trial.started. Every live automation that starts on that event name takes the contact in, so its emails start going to them, and a wait step holding out for the name moves on. The answer says which automations it started. Events are kept for 90 days.

ورودی‌ها

namestringالزامی: What happened, such as order.placed: letters, digits, dots, colons, dashes and underscores. Names are matched exactly, case included.
1 تا 100 نویسه
emailstringالزامی: The contact the event is about, by email address.
تا 320 نویسهقالبemail
propertiesRecord<string, any>: Details of the event as a JSON object, at most 50 keys and 4 KB. An event trigger can filter on them and steps can use them.
occurredAtstring: When it happened, as an ISO 8601 instant. Left out, it is now. Not in the future, and at most 90 days ago.
قالبdate-time
createContactboolean: true adds the address to the contacts when nobody has it yet.
contactNamestring: The name to give a contact that createContact adds.
تا 200 نویسه

`sendContactEvents`

contacts:writeدستیار برنامه همیشه اول می‌پرسدجعبه‌ابزارautomations

Record up to 100 events in one call, each handled as sendContactEvent handles one, in order. One event failing does not stop the rest: the answer says which were recorded, what each started, and why any was not.

ورودی‌ها

eventsobject[]الزامی

1 تا 100 مورد

namestringالزامی: What happened, such as order.placed: letters, digits, dots, colons, dashes and underscores. Names are matched exactly, case included.
1 تا 100 نویسه
emailstringالزامی: The contact the event is about, by email address.
تا 320 نویسهقالبemail
propertiesRecord<string, any>: Details of the event as a JSON object, at most 50 keys and 4 KB. An event trigger can filter on them and steps can use them.
occurredAtstring: When it happened, as an ISO 8601 instant. Left out, it is now. Not in the future, and at most 90 days ago.
قالبdate-time
createContactboolean: true adds the address to the contacts when nobody has it yet.
contactNamestring: The name to give a contact that createContact adds.
تا 200 نویسه

`listContactEventNames`

automations:readدستیار برنامه آن را بدون پرسیدن اجرا می‌کندجعبه‌ابزارautomations

The names of the events this workspace has recorded in the last 90 days, to choose the event that starts an automation or that a wait step holds out for.

ورودی‌ها

هیچ ورودی‌ای نمی‌گیرد.

همچنین در دسترس در

API: GET /events/names
TypeScript: events.listNames()
Python: events.list_names()
Ruby: events.list_names
PHP: events->listNames
Go: Events.ListNames
Java: events().listNames
C#: Events.ListNamesAsync

`listContactEvents`

contacts:readدستیار برنامه آن را بدون پرسیدن اجرا می‌کندجعبه‌ابزارautomations

The events recorded for one contact in the last 90 days, the most recent first: name, when it happened and its properties. Narrow it to one event name. One page at a time: when more follow, the last line gives a cursor.

ورودی‌ها

emailstringالزامی: The contact the event is about, by email address.
3 تا 320 نویسه
namestring: 1 تا 100 نویسه
limitinteger: دست‌کم 1حداکثر 200
cursorstring: 1 تا 64 نویسه

همچنین در دسترس در

API: GET /contacts/{email}/events
TypeScript: contacts.listEvents()contacts.listAllEvents()contacts.iterateEvents()
Python: contacts.list_events()contacts.list_all_events()contacts.iterate_events()
Ruby: contacts.list_eventscontacts.list_all_eventscontacts.iterate_events
PHP: contacts->listEventscontacts->listAllEventscontacts->iterateEvents
Go: Contacts.ListEventsContacts.ListAllEventsContacts.IterateEvents
Java: contacts().listEventscontacts().listAllEventscontacts().iterateEvents
C#: Contacts.ListEventsAsyncContacts.ListAllEventsAsyncContacts.IterateEventsAsync

خودکارسازی‌ها

ابزارهای خودکارسازی

مرجع

ورودی‌ها

همچنین در دسترس در

ورودی‌ها

همچنین در دسترس در

ورودی‌ها

همچنین در دسترس در

ورودی‌ها

همچنین در دسترس در

ورودی‌ها

همچنین در دسترس در

ورودی‌ها

همچنین در دسترس در

ورودی‌ها

همچنین در دسترس در

ورودی‌ها

همچنین در دسترس در

ورودی‌ها

همچنین در دسترس در

ورودی‌ها

همچنین در دسترس در

ورودی‌ها

همچنین در دسترس در

ورودی‌ها

همچنین در دسترس در

ورودی‌ها

همچنین در دسترس در

ورودی‌ها

همچنین در دسترس در

ورودی‌ها

همچنین در دسترس در

ورودی‌ها

همچنین در دسترس در

ورودی‌ها

همچنین در دسترس در

ورودی‌ها

همچنین در دسترس در

ورودی‌ها

همچنین در دسترس در

ورودی‌ها

ورودی‌ها

ورودی‌ها

همچنین در دسترس در

ورودی‌ها

همچنین در دسترس در

صندوق ورودی شما،با شرایط خودتان.

صندوق ورودی شما،
با شرایط خودتان.