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 करता है, और API रेफ़रेंस के /automations और /events पेज हर फ़ील्ड का वर्णन करते हैं। परिभाषा पूरी की पूरी 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

ऑटोमेशन