How to Automate Tagging via API

Last modified: October 28, 2022
Estimated reading time: 1 min

The purpose of this manual is to add tags automatically via the API.

Simply put, you only need 2 steps to do this tagging, which include: 

  1. Create automation in the app, and
  2. Send a request to the server.

Creating Automation in The App

First, you need to create an automation workflow in the application according to your needs. To do so, simply follow the steps below:

  1. On the New Automation menu, select Custom Workflow to create an automation workflow from scratch.


     
  2. For the first trigger, please select External Trigger.


  3. After that, fill in all the available fields, including:
    1. Name : Your automation name/title
    2. Target List : List that’ll be used to store data.
    3. Subscriber Field : Fields that’ll be used to send data. The Email field must be included.
    4. Action (optional) : Fill in with the action you want to perform.
      Notes:  You can use the External triggers for several functions. One of them is to check whether an order has been paid for or not.

      For the implementation, you can fill in the Action field according to the function that’ll be run on your platform.

      For instance:
  • action cart, to run the automation when the user checkout a product or something.
  • action completed, to run the automation when the buyer has completed the payment. 

These actions are defined by your platform. So you can leave this field blank if it’s not needed.

  1. Next, copy the code provided in the How to Use section that’ll be used to send requests to the server.
  2. Click on the Save button

  1. After that, please select Add tag for the action..
  2. Decide what tags will be added to the subscribers that join the list.
    1. If there is no tag, you can add it first by clicking on the +Add button.
    2. Click on the Save button.


  3. Next, create a node/workflow according to your needs. 
  4. Click on the Save and Run button in the upper right corner of the page.


  5. Then, continue to send a request to the server.

Sending A Request to The Server

Lastly, please send a request to the server by giving the code you’ve copied to the Developer Team in order to implement the automation into your platform. 

An example of the code is like this:

curl –location –request POST ‘https://aplikasi.kirim.email/automation’ \
–user ‘automation:4yvlYTwZ3cFQsU9AGIkTufAxqmE4vOAp’ \
–form ‘action:Cart’ \
–form ’email=”EXAMPLE_DATA”‘ \
–form ‘full_name=”EXAMPLE_DATA”‘ \
–form ‘your_message=”EXAMPLE_DATA”‘ \

Note : The code you get may be different from the example above. It depends on the automation store the system provides, the fields you use, and also the action.

Finished. 

Was this article helpful?
Dislike 0 0 of 0 found this article helpful.
Views: 17

Continue reading

Previous: How to Integrate KIRIM.EMAIL Automation 2.0 with Other Platforms for Cart Abandonment