API for Automations

📬 Pause/Resume Automation

🔐 Step 1: Get Your Api Key

Before anything else, you’ll need an Api key to authenticate your requests.
Already have one? Great! Copy it to your clipboard.
Need one? You can generate it by heading over to Settings → Api Keys → Create New Api Key.

📨 Step 2: Add Your Api Key to the Request Header

When you’re ready to make your request, add your Api key into the header like this:

x-api-key: xxxx-xxxx-xxxx-xxxx

📋 Copy

🚀 Step 3: Send a POST Request to this endpoint

You’ll be sending a POST request to:

https://inbound.messengeros.com/2.0/automation

📋 Copy

This is where the magic happens ✨

🧱 Step 4: Build your Payload

Here’s the format your JSON payload should follow:
Mandatory fields: key and status.

{
    "automation": [
        {
            "key": "xxxxxx-xxxxxx-xxxx-xxxxx-xxxxxxxxx", // can be found in Automation / Automations / View automation / Scroll to the bottom / Show Api Key
            "status": "active", // possible values: active or paused, otherwise it will be ignored 
        }
    ]
}

📋 Copy

📌 Pro tip: You can update one or more automations at once. Just repeat the object inside the automation array.

✅ Step 5: Get a Confirmation

If everything looks good and your JSON is valid, the Api will respond with:

{"status": "received"}

This means we’ve accepted the request and your subscriber is being processed in the background.

👀 Step 6: Double check in your Audience lists

Once your request goes through, head over to your Automations → Automations to confirm that your automation's status has been updated.
That’s it! 🎉

Need help or want to test it out? Let us know—we’re always here to support.

📬 Get all Automations in a Project

🔐 Step 1: Get Your Api Key

📨 Step 2: Add Your Api Key to the Request Header

When you’re ready to make your request, add your Api key into the header like this:

x-api-key: xxxx-xxxx-xxxx-xxxx

📋 Copy

🚀 Step 3: Send a GET Request to this endpoint

You’ll be sending a GET request to:

https://app.messengeros.com/external/2.0/automations?project={projectApiKey}

📋 Copy

This is where the magic happens ✨

✅ Step 4: Result

If everything looks good and your request is valid, the Api will respond with:

{
    "email": [
        {
            "key": "email automation api key 1",
            "name": "email automation name 1"
        },
        {
            "key": "email automation api key 2",
            "name": "email automation name 2"
        },
    ],
    "sms": [
        {
            "key": "sms automation api key 1",
            "name": "sms automation name 1"
        },
        {
            "key": "sms automation api key 2",
            "name": "sms automation name 2"
        },
    ]
}

Need help or want to test it out? Let us know, we’re always here to support.

📬 Unsubscribe an email recipient from an Automation

🔐 Step 1: Get Your Api Key

📨 Step 2: Add Your Api Key to the Request Header

When you’re ready to make your request, add your Api key into the header like this:

x-api-key: xxxx-xxxx-xxxx-xxxx

📋 Copy

🚀 Step 3: Send a POST Request to this endpoint

You’ll be sending a POST request to:

https://app.messengeros.com/external/2.0/automation/email/unsubscribe

📋 Copy

This is where the magic happens ✨

🧱 Step 4: Build your Payload

Here’s the format your JSON payload should follow:
Mandatory fields: automation and email.

{
    "automation": "xxxxxx-xxxxxx-xxxx-xxxxx-xxxxxxxxx" // can be found in Automation / Automations / View automation / Scroll to the bottom / Show Api Key
    "email": "email@example.com"
}

📋 Copy

✅ Step 5: Result

If everything looks good and your request is valid, the Api will respond with:

{
    "status": "success"
}

Need help or want to test it out? Let us know, we’re always here to support.