Email Tag API Methods

Table of Contents:

 Note: Notice that in each API call you must provide the List ID that you are working on, otherwise the default List ID will be used. You can review the possible ways to provide List ID in this link.

Methods Summary

POST /api/email_tag

Description 

This method create new Email Tag

Request

title

Required string - the literal tag e.g., "Holiday Special"

list_id

Optional number - List ID. If you provide list ID than tag will be created in that list only. If you want to have Global Tag than use "list_id":null in email body and that tag will be created as global tag. 

Example 

List Specific Tag: 

POST URL: https://api.ongage.net/<list_id>/api/email_tag

{"title":"Holiday Special"}

Global Tag: 

POST URL: https://api.ongage.net/api/email_tag

{"title":"Holiday Special","list_id":null}

GET /api/email_tag

Description 

This method fetches a collection of email tags.

Request

title

Optional string - the literal tag e.g., "Holiday Special"

list_id

Optional number - List ID. Note that global email tags (list_id = null) will always be returned

sort

Optional string - Column name

order

Optional string - "ASC" or "DESC"

offset

Optional int

limit

Optional int

PUT /API/email_tag/<Email Tag ID>

Description 

This method updates an email tag.

Request

title

Required string

The literal string of characters you want to update. E.g., change tag contents to "Fall Special"

list_id

Optional number

email tag can be set globally for all lists, or to a specific list when "list_id" is provided

DELETE /API/email_tag/<Email Tag ID>

Description 

This method deletes an email tag.