Mumara API Reference
API docs by Redocly

Mumara API Reference

Download OpenAPI specification:Download

Mumara Api secification and documentation.

Contact List

Add-Contact-List

Add Contact List.

Authorizations:
BearerAuth
query Parameters
list_name
required
string
Example: list_name=test list

Name of the contact list you're adding.

owner_name
required
string
Example: owner_name=John Lee

Owner name of the contact list.

owner_email
required
string
Example: owner_email=owner@anydomain.com

Owner email of the contact list.

reply_email
required
string
Example: reply_email=reply@anydomain.com

The email where you should get replies.

bounce_email
required
string
Example: bounce_email=bounce@anydomain.com

Return path where the failed delivery reports will be sent.

group_name
string
Example: group_name=group name

Add this list to a group.

additional_fields
string
Example: additional_fields=first_name

Assign additional fields to this list.

response
integer
Example: response=1

Get full response of the operation (default: 0).

Request Body schema: application/json
required

Add Contact List.

list_name
required
string

Name of the contact list you're adding.

owner_name
required
string

Owner name of the contact list.

owner_email
required
string

Owner email of the contact list.

reply_email
required
string

The email where you should get replies.

bounce_email
required
string

Return path where the failed delivery reports will be sent.

group_name
string

Add this list to a group.

additional_fields
string

Assign additional fields to this list.

response
integer

Get full response of the operation (default: 0).

Responses

Request samples

Content type
application/json
{
  • "list_name": "test list",
  • "owner_name": "John Lee",
  • "owner_email": "owner@anydomain.com",
  • "reply_email": "reply@anydomain.com",
  • "bounce_email": "bounce@anydomain.com",
  • "group_name": "group name",
  • "additional_fields": "first_name",
  • "response": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Success: List has been successfully created.",
  • "response": {
    }
}

Get-Contact-List-Details

Retrieve a contact list details.

Authorizations:
BearerAuth
path Parameters
id
required
integer
Example: 2

Required to retrieve the specific list from the system, $id is the value here which refers to the ID of that list you want to retrieve.

Responses

Request samples 

curl -X GET -G https://demo.campaigns.mumara.com/api/getList/{id} \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Get-List-Groups

Get List Groups.

Authorizations:
BearerAuth
query Parameters
id
integer
Example: id=14

id of the List Group to fetch details.

user_id
integer
Example: user_id=2

Get List Group of a particular user.(Note user_id is used for super admin and staff only)

limit_start
integer
Example: limit_start=0

Starting row of result. Default: 0.

limit_count
integer
Example: limit_count=25

Number of records to get. Default: 25.

Responses

Request samples 

curl -X GET -G https://demo.campaigns.mumara.com/api/getListGroups \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
-d {
     "id":"14"  \
     "user_id":"2"  \
     "limit_start":"0"  \
     "limit_count":"25"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": [
    ]
}

Update-Contact-List

Update Contact List

Authorizations:
BearerAuth
path Parameters
id
required
integer
Example: 2

List ID.

query Parameters
list_name
string
Example: list_name=test list

Update contact list name.

owner_name
string
Example: owner_name=John Lee

Update owner name.

owner_email
string
Example: owner_email=owner@anydomain.com

Update owner email address.

reply_email
string
Example: reply_email=reply@anydomain.com

Update reply email address.

bounce_email
string
Example: bounce_email=bounce@anydomain.com

Update return-path email address where you want to receive bounced emails.

group_name
string
Example: group_name=group name

Update contact list group.

additional_fields
string
Example: additional_fields=first_name

Re-assign custom fields. If skipped then no change will apply to the pre-assigned custom fields.

response
integer
Example: response=1

Get full response of the operation (default: 0).

Request Body schema: application/json
required

Update Contact List

list_name
string

Update contact list name.

owner_name
string

Update owner name.

owner_email
string

Update owner email address.

reply_email
string

Update reply email address.

bounce_email
string

Update return-path email address where you want to receive bounced emails.

group_name
string

Update contact list group.

additional_fields
string

Re-assign custom fields. If skipped then no change will apply to the pre-assigned custom fields.

response
integer

Get full response of the operation (default: 0).

Responses

Request samples

Content type
application/json
{
  • "list_name": "test list",
  • "owner_name": "John Lee",
  • "owner_email": "owner@anydomain.com",
  • "reply_email": "reply@anydomain.com",
  • "bounce_email": "bounce@anydomain.com",
  • "group_name": "group name",
  • "additional_fields": "first_name",
  • "response": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Success: List has been successfully updated.",
  • "data": {
    }
}

Get-Contact-Lists

Get Contact Lists

Authorizations:
BearerAuth
query Parameters
list_id
integer
Example: list_id=3

Get details of a specific contact list.

user_id
integer
Example: user_id=2

Get contact lists of a specific user.

group_id
integer
Example: group_id=23

Get contact lists for a specific group.

limit_start
integer
Example: limit_start=0

Starting row of result. Default: 0.

limit_count
integer
Example: limit_count=25

Number of records to get. Default: 25.

Responses

Request samples 

curl -X GET -G https://demo.campaigns.mumara.com/api/getLists \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
-d {
     "list_id":"3"  \
     "user_id":"2"  \
     "group_id":"23"  \
     "limit_start":"0"  \
     "limit_count":"25"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Delete-Contact-List

Delete Contact List

Authorizations:
BearerAuth
path Parameters
id
required
integer
Example: 3

id of the list to be deleted.

type
required
string
Example: soft

soft = soft delete, hard = hard delete.

Responses

Request samples 

curl -X DELETE https://demo.campaigns.mumara.com/api/deleteList/{id}/{type} \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Success: List has been successfully deleted."
}

Delete-List-Group

Delete List Group

Authorizations:
BearerAuth
path Parameters
group_id
required
integer
Example: 3

id of the group to be deleted.

delete_lists
integer
Example: 1

1 = Also delete all contact lists inside the group. Otherwise, contact lists will be moved to unsorted.

Responses

Request samples 

curl -X DELETE https://demo.campaigns.mumara.com/api/deleteListGroup/{group_id}/{delete_lists} \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Success: Contact List Group has been successfully deleted."
}

Contact

Add-a-Contact

Add a Contact.

Authorizations:
BearerAuth
query Parameters
email
required
string
Example: email=test@anydomain.com

Email address of the contact.

list_id
required
integer
Example: list_id=2

id of the contact list where this contact will be added.

format
string
Example: format=HTML

Which format this contact should receive the email: HTML = Will receive HTML version of the email, TEXT = WIll receive simple text versiont.

is_confirmed
integer
Example: is_confirmed=1

Confirmation status of the contact: 0 = Add this contact as unconfirmed, 1 = Add this contact as confirmed.

is_active
integer
Example: is_active=1

Status of the contact: 0 = Mark as inactive (will not receive emails), 1 = Mark as active.

bounced
integer
Example: bounced=0

Bounced status of the contact: 0 = Add as not bounced, 1 = Add as soft bounced 2 = Add as hard bounced.

is_unsubscribed
integer
Example: is_unsubscribed=0

Subscription status of the contact: 0 = Mark as subscribed, 1 = Mark as unsubscribed.

is_spam
integer
Example: is_spam=0

If this contact has produced a spam complaint: 0 = Mark as spam, 1 = Don't mark as spam.

additional_field
string

Example: first_name=John . Add details to additional fields.

response
integer
Example: response=1

Get full response of the operation (default: 0).

Request Body schema: application/json
required

Add a Contact.

email
required
string

Email address of the contact.

list_id
required
integer

id of the contact list where this contact will be added.

format
string

Which format this contact should receive the email: HTML = Will receive HTML version of the email, TEXT = WIll receive simple text versiont.

is_confirmed
integer

Confirmation status of the contact: 0 = Add this contact as unconfirmed, 1 = Add this contact as confirmed.

is_active
integer

Status of the contact: 0 = Mark as inactive (will not receive emails), 1 = Mark as active.

bounced
integer

Bounced status of the contact: 0 = Add as not bounced, 1 = Add as soft bounced 2 = Add as hard bounced.

is_unsubscribed
integer

Subscription status of the contact: 0 = Mark as subscribed, 1 = Mark as unsubscribed.

is_spam
integer

If this contact has produced a spam complaint: 0 = Mark as spam, 1 = Don't mark as spam.

additional_field
string

Add details to additional fields.

response
integer

Get full response of the operation (default: 0).

Responses

Request samples

Content type
application/json
{
  • "email": "test@anydomain.com",
  • "list_id": 2,
  • "format": "HTML",
  • "is_confirmed": 1,
  • "is_active": 1,
  • "bounced": 0,
  • "is_unsubscribed": 0,
  • "is_spam": 0,
  • "first_name": "John",
  • "response": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Success: Contact has been successfully created.",
  • "data": {
    }
}

Import-Contact-list

Note: The headers of the CSV file to be imported should reflect the custom field tags. e.g. the column with header first_name will be imported into First Name.

Authorizations:
BearerAuth
query Parameters
import_file_selection
required
string
Example: import_file_selection=computer

Source from where the file will be picked, i.e. computer or server. In the case of server, you'll need to upload the file here /storage/users/userid/files/imports/subscribers/.

list_id
required
integer
Example: list_id=2

The id of the contact list in which the contacts will be imported.

file_import
required
file

Select the file from your computer to be uploaded. If the import_file_selection is set to computer then this field is required.

format
string
Example: format=HTML

The variation of the broadcast these contacts should receive, i.e. HTML or TEXT

is_confirmed
integer
Example: is_confirmed=1

Import these contacts with confirmed status. Unconfirmed contacts will not receive the emails.

is_active
integer
Example: is_active=1

Import these contacts with an active status. Inactive contacts will not receive the emails.

file_format
string
Example: file_format=csv

Format of the file to be imported. Supported values: csv txt

duplicates
string
Example: duplicates=skip

What to do with the duplicate emails? Supported values: skip, update, overwrite

file_name
string
Example: file_name=Nutrition.csv

The file name to be fetched from the 'server' when 'import_file_selection' is set to server. This field is required if 'server' option is used for 'import_file_selection'

Request Body schema: application/json
required

Import Contact list.

import_file_selection
required
string

Source from where the file will be picked, i.e. computer or server. In the case of server, you'll need to upload the file here /storage/users/userid/files/imports/subscribers/.

list_id
required
integer

The id of the contact list in which the contacts will be imported.

file_import
required
file

Select the file from your computer to be uploaded. If the import_file_selection is set to computer then this field is required.

format
string

The variation of the broadcast these contacts should receive, i.e. HTML or TEXT

is_confirmed
integer

Import these contacts with confirmed status. Unconfirmed contacts will not receive the emails.

is_active
integer

Import these contacts with an active status. Inactive contacts will not receive the emails.

file_format
string

Format of the file to be imported. Supported values: csv, txt

duplicates
string

What to do with the duplicate emails? Supported values: skip, update, overwrite

file_name
string

The file name to be fetched from the 'server' when 'import_file_selection' is set to server. This field is required if 'server' option is used for 'import_file_selection'

Responses

Request samples

Content type
application/json
{
  • "import_file_selection": "computer",
  • "list_id": 2,
  • "format": "HTML",
  • "file_import": "file",
  • "is_confirmed": 1,
  • "is_active": 1,
  • "file_format": "csv",
  • "duplicates": "skip",
  • "file_name": "Nutritions.csv"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "The import has been started in background"
}

Update-Contact-Details

Update Contact Details.

Authorizations:
BearerAuth
path Parameters
id
required
integer
Example: 2

Subscriber ID.

query Parameters
email
string
Example: email=test@anydomain.com

Change email address of the contact.

format
string
Example: format=HTML

Which format this contact should receive the email: HTML = Will receive HTML version of the email, TEXT = WIll receive simple text versiont.

is_confirmed
integer
Example: is_confirmed=1

Confirmation status of the contact: 0 = Add this contact as unconfirmed, 1 = Add this contact as confirmed.

is_active
integer
Example: is_active=1

Status of the contact: 0 = Mark as inactive (will not receive emails), 1 = Mark as active.

bounced
integer
Example: bounced=0

Bounced status of the contact: 0 = Add as not bounced, 1 = Add as soft bounced, 2 = Add as hard bounced.

is_unsubscribed
integer
Example: is_unsubscribed=0

Subscription status of the contact: 0 = Mark as subscribed, 1 = Mark as unsubscribed.

is_spam
integer
Example: is_spam=0

If this contact has produced a spam complaint: 0 = Mark as spam, 1 = Don't mark as spam.

additional_field
string

Example: first_name=John .Add details to additional fields.

response
integer
Example: response=1

Get full response of the operation (default: 0).

Request Body schema: application/json
required

Update Contact Details.

email
string

Change email address of the contact.

format
string

Which format this contact should receive the email: HTML = Will receive HTML version of the email, TEXT = WIll receive simple text versiont.

is_confirmed
integer

Confirmation status of the contact: 0 = Add this contact as unconfirmed, 1 = Add this contact as confirmed.

is_active
integer

Status of the contact: 0 = Mark as inactive (will not receive emails), 1 = Mark as active.

bounced
integer

Bounced status of the contact: 0 = Add as not bounced, 1 = Add as soft bounced, 2 = Add as hard bounced.

is_unsubscribed
integer

Subscription status of the contact: 0 = Mark as subscribed, 1 = Mark as unsubscribed.

is_spam
integer

If this contact has produced a spam complaint: 0 = Mark as spam, 1 = Don't mark as spam.

additional_field
string

Add details to additional fields.

response
integer

Get full response of the operation (default: 0).

Responses

Request samples

Content type
application/json
{
  • "email": "test@anydomain.com",
  • "format": "HTML",
  • "is_confirmed": 1,
  • "is_active": 1,
  • "bounced": 0,
  • "is_unsubscribed": 0,
  • "is_spam": 0,
  • "additional_field": "last_name",
  • "response": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Success: Contact has been successfully updated.",
  • "data": {
    }
}

Update-Contact-By-Email

Update Contact By Email.

Authorizations:
BearerAuth
path Parameters
email
required
string
Example: test@anydomain.com

Subscriber Email.

query Parameters
list_id
integer
Example: list_id=2

If no list id has been given, it will work globally on all lists.

recursive
integer
Example: recursive=0

Update all matching contacts globally. If set to 0, it will just update the first matching contact.

format
string
Example: format=HTML

Which format this contact should receive the email: HTML = Will receive HTML version of the email, TEXT = WIll receive simple text versiont.

is_confirmed
integer
Example: is_confirmed=1

Confirmation status of the contact: 0 = Add this contact as unconfirmed, 1 = Add this contact as confirmed.

is_active
integer
Example: is_active=1

Status of the contact: 0 = Mark as inactive (will not receive emails), 1 = Mark as active.

bounced
integer
Example: bounced=0

Bounced status of the contact: 0 = Add as not bounced, 1 = Add as soft bounced, 2 = Add as hard bounced.

is_unsubscribed
integer
Example: is_unsubscribed=0

Subscription status of the contact: 0 = Mark as subscribed, 1 = Mark as unsubscribed.

is_spam
integer
Example: is_spam=0

If this contact has produced a spam complaint: 0 = Mark as spam, 1 = Don't mark as spam.

additional_field
string

Example: first_name=John .Add details to additional fields.

response
integer
Example: response=1

Get full response of the operation (default: 0).

Request Body schema: application/json
required

Update Contact By Email.

list_id
integer

If no list id has been given, it will work globally on all lists.

recursive
integer

Update all matching contacts globally. If set to 0, it will just update the first matching contact.

format
string

Which format this contact should receive the email: HTML = Will receive HTML version of the email, TEXT = WIll receive simple text versiont.

is_confirmed
integer

Confirmation status of the contact: 0 = Add this contact as unconfirmed, 1 = Add this contact as confirmed.

is_active
integer

Status of the contact: 0 = Mark as inactive (will not receive emails), 1 = Mark as active.

bounced
integer

Bounced status of the contact: 0 = Add as not bounced, 1 = Add as soft bounced, 2 = Add as hard bounced.

is_unsubscribed
integer

Subscription status of the contact: 0 = Mark as subscribed, 1 = Mark as unsubscribed.

is_spam
integer

If this contact has produced a spam complaint: 0 = Mark as spam, 1 = Don't mark as spam.

additional_field
string

Add details to additional fields.

response
integer

Get full response of the operation (default: 0).

Responses

Request samples

Content type
application/json
{
  • "list_id": 2,
  • "recursive": 0,
  • "format": "HTML",
  • "is_confirmed": 1,
  • "is_active": 1,
  • "bounced": 0,
  • "is_unsubscribed": 0,
  • "is_spam": 0,
  • "additional_field": "first_name",
  • "response": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": {
    }
}

Get-Contact-Details

Get Contact Details.

Authorizations:
BearerAuth
path Parameters
id
required
integer
Example: 22

Subscriber ID.

Responses

Request samples 

curl -X GET -G https://demo.campaigns.mumara.com/api/getContact/{id} \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": [
    ]
}

Get-Contacts

Get Contacts.

Authorizations:
BearerAuth
query Parameters
list_id
integer
Example: list_id=2

Contact list id which contacts you want to get.

user_id
integer
Example: user_id=2

Get contacts of a particular user.

email
string
Example: email=email@domain.com

Get contacts by email.

bounced
integer
Example: bounced=0

Bounced status of the contact: 0 = Add as not bounced, 1 = Add as soft bounced, 2 = Add as hard bounced.

is_confirmed
integer
Example: is_confirmed=1

Confirmation status of the contact: 0 = Add this contact as unconfirmed, 1 = Add this contact as confirmed.

is_active
integer
Example: is_active=1

Status of the contact: 0 = Mark as inactive (will not receive emails), 1 = Mark as active.

is_unsubscribed
integer
Example: is_unsubscribed=0

Subscription status of the contact: 0 = Mark as subscribed, 1 = Mark as unsubscribed: first_name.

is_spam
integer
Example: is_spam=0

If this contact has produced a spam complaint: 0 = Mark as spam, 1 = Don't mark as spam.

format
string
Example: format=HTML

Which format this contact should receive the email: HTML = Will receive HTML version of the email, TEXT = WIll receive simple text versiont.

limit_start
string
Example: limit_start=0

Starting row of result. Default: 0.

limit_count
string
Example: limit_count=25

Number of records to get. Default: 25.

full_details
string
Example: full_details=1

If 1 It will get full details of the contacts along with custom fields. Otherwise, just contact id and email address will be returned.

response
integer
Example: response=1

Get full response of the operation (default: 0).

Responses

Request samples 

curl -X GET -G https://demo.campaigns.mumara.com/api/getContacts \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
-d {
     "list_id":"2"  \
     "user_id":"2"  \
     "email":"email@domain.com"  \
     "bounced":"0"  \
     "is_confirmed":"1"  \
     "is_active":"1"  \
     "is_unsubscribed":"0"  \
     "is_spam":"0"  \
     "format":"HTML"  \
     "limit_start":"0"  \
     "limit_count":"25"  \
     "full_details":"1"  \
     "response":"1"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": [
    ]
}

Delete-Contact

Delete Contact.

Authorizations:
BearerAuth
path Parameters
id
required
integer
Example: 25

Subscriber ID.

Responses

Request samples 

curl -X DELETE https://demo.campaigns.mumara.com/api/deleteContact/{id} \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Success: Contact has been successfully deleted."
}

Delete-Contact-By-Email

Delete Contact By Email.

Authorizations:
BearerAuth
path Parameters
email
required
string
Example: email@domain.com

Subscriber Email.

recursive
required
integer
Example: 1

Delete first entry or all contacts having this email address: 0 = Delete first result of the operation, 1 = Delete all contacts having this email address.

query Parameters
list_id
integer
Example: list_id=2

ID of the list where you want to delete the contact.

Responses

Request samples 

curl -X DELETE https://demo.campaigns.mumara.com/api/deleteContactByEmail/{email}/{recursive} \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json"\
 -d {
     "list_id":"2"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Success: Contact has been successfully deleted."
}

Mark-as-Complaint

Mark as Complaint.

Authorizations:
BearerAuth
path Parameters
id
required
integer
Example: 43

It refers to the contact ID, the status of which you want to turn to complaint/abuse. The contacts you mark as a complaint (abuse/spam) will no longer be able to receive emails from the system.

Request Body schema: application/json
required

Mark as Complaint.

object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Success: Contact successfully Updated."
}

Mark-as-Unsubscribed

Mark as Unsubscribed.

Authorizations:
BearerAuth
path Parameters
id
required
integer
Example: 29

It refers to contact ID of the email address which you want to be set as unsubscribed.

Request Body schema: application/json
required

Mark as Unsubscribed.

object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Success: Contact has been successfully marked as Unsubscribed."
}

Mark-as-Soft/Hard-Bounce

Mark as Soft/Hard Bounce.

Authorizations:
BearerAuth
path Parameters
id
required
integer
Example: 22

It refers to the contact ID, the status of the email address which you want to set as soft or hard bounced.

query Parameters
type
required
string
Example: type=soft

The value of this parameter needs to be filled with the type of bounce you want to mark the contact as it should be either "hard" or "soft" (all small letters when writing the value).

Request Body schema: application/json
required

Mark as Soft/Hard Bounce.

type
required
string

The value of this parameter needs to be filled with the type of bounce you want to mark the contact as it should be either "hard" or "soft" (all small letters when writing the value).

Responses

Request samples

Content type
application/json
{
  • "type": "soft"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Success: Contact successfully Updated."
}

Campaign

Add-a-Broadcast

Add a Broadcast.

Authorizations:
BearerAuth
query Parameters
group_name
required
string
Example: group_name=test Group

Sort this broadcast in specific group.

broadcast_name
string
Example: broadcast_name=Test Broadcast

Name your broadcast.

email_subject
required
string
Example: email_subject=Big Discount Offer

Email subject of this broadcast.

content_html
required
string
Example: content_html=<p>Rush to the stores and get 50% discount on your next purchase.</p>

HTML content for the broadcast.

content_text
required
string
Example: content_text=Rush to the stores and get 50% discount on your next purchase

TEXT version of the broadcast.

response
integer
Example: response=1

Get full response of the operation (default: 0).

Request Body schema: application/json
required

Add a Broadcast.

group_name
required
string

Sort this broadcast in specific group.

broadcast_name
string

Name your broadcast.

email_subject
required
string

Email subject of this broadcast.

content_html
required
string

HTML content for the broadcast.

content_text
required
string

TEXT version of the broadcast.

response
integer

Get full response of the operation (default: 0).

Responses

Request samples

Content type
application/json
{
  • "group_name": "test Group",
  • "broadcast_name": "Test Broadcast",
  • "email_subject": "Big Discount Offer",
  • "content_html": "<p>Rush to the stores and get 50% discount on your next purchase.</p>",
  • "content_text": "Rush to the stores and get 50% discount on your next purchase",
  • "response": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Success: Broadcast successfully created.",
  • "response": {
    }
}

Update-Broadcast

Update Broadcast.

Authorizations:
BearerAuth
path Parameters
id
required
integer
Example: 14

Broadcast id.

query Parameters
group_name
string
Example: group_name=test Group

Sort this broadcast in specific group.

broadcast_name
string
Example: broadcast_name=Test Broadcast

Name your broadcast.

email_subject
string
Example: email_subject=Big Discount Offer

Email subject of this broadcast.

content_html
string
Example: content_html=<p>Rush to the stores and get 50% discount on your next purchase.</p>

HTML content for the broadcast.

content_text
string
Example: content_text=Rush to the stores and get 50% discount on your next purchase

TEXT version of the broadcast.

response
integer
Example: response=1

Get full response of the operation (default: 0).

Request Body schema: application/json
required

Update Broadcast.

group_name
string

Sort this broadcast in specific group.

broadcast_name
string

Name your broadcast.

email_subject
string

Email subject of this broadcast.

content_html
string

HTML content for the broadcast.

content_text
string

TEXT version of the broadcast.

response
integer

Get full response of the operation (default: 0).

Responses

Request samples

Content type
application/json
{
  • "group_name": "test Group",
  • "broadcast_name": "Test Broadcast",
  • "email_subject": "Big Discount Offer",
  • "content_html": "<p>Rush to the stores and get 50% discount on your next purchase.</p>",
  • "content_text": "Rush to the stores and get 50% discount on your next purchase",
  • "response": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Success: Broadcast successfully updated.",
  • "response": {
    }
}

Get-Broadcasts

Get Broadcasts.

Authorizations:
BearerAuth
query Parameters
id
integer
Example: id=14

id of the broadcast to fetch details.

user_id
integer
Example: user_id=2

Get broadcasts of a particular user.

group_id
integer
Example: group_id=43

Group id of the broadcasts you want to get.

limit_start
integer
Example: limit_start=0

Starting row of result. Default: 0.

limit_count
integer
Example: limit_count=25

Number of records to get. Default: 25.

Responses

Request samples 

curl -X GET -G https://demo.campaigns.mumara.com/api/getBroadcasts \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
-d {
     "id":"14"  \
     "user_id":"2"  \
     "group_id":"43"  \
     "limit_start":"0"  \
     "limit_count":"25"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": [
    ]
}

Get-Scheduled-Broadcasts

Get Scheduled Broadcasts.

Authorizations:
BearerAuth
query Parameters
id
integer
Example: id=14

id of the broadcast to fetch details.

user_id
integer
Example: user_id=2

Get broadcasts of a particular user.(Note user_id is used for super admin and staff only)

limit_start
integer
Example: limit_start=0

Starting row of result. Default: 0.

limit_count
integer
Example: limit_count=25

Number of records to get. Default: 25.

t_start
timestamps
Example: t_start=2022-10-20 14:01:00

The start time from when to fetch the scheduled broadcasts. Supported format (dd-mm-yyyy_hh-mm-ss)

t_end
timestamps
Example: t_end=2022-10-20 14:01:00

The end time till when to fetch the scheduled broadcasts. Supported format (dd-mm-yyyy_hh-mm-ss)

Responses

Request samples 

curl -X GET -G https://demo.campaigns.mumara.com/api/getScheduledBroadcasts \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
-d {
     "id":"14"  \
     "user_id":"2"  \
     "limit_start":"0"  \
     "limit_count":"25"  \
     "t_start":"2022-10-20 14:01:00"  \
     "t_end":"2022-10-20 14:01:00"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": [
    ]
}

Get-Broadcast-Groups

Get Broadcast Groups.

Authorizations:
BearerAuth
query Parameters
id
integer
Example: id=14

id of the broadcast Group to fetch details.

user_id
integer
Example: user_id=2

Get broadcasts Group of a particular user.(Note user_id is used for super admin and staff only)

limit_start
integer
Example: limit_start=0

Starting row of result. Default: 0.

limit_count
integer
Example: limit_count=25

Number of records to get. Default: 25.

Responses

Request samples 

curl -X GET -G https://demo.campaigns.mumara.com/api/getBroadcastGroups \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
-d {
     "id":"14"  \
     "user_id":"2"  \
     "limit_start":"0"  \
     "limit_count":"25"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": [
    ]
}

Delete-Broadcasts

Delete Broadcasts.

Authorizations:
BearerAuth
path Parameters
ids
integer
Example: 14

Broadcast id(s) to be deleted.

Responses

Request samples 

curl -X DELETE https://demo.campaigns.mumara.com/api/deleteBroadcasts/{ids} \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Success: Broadcasts have been successfully deleted."
}

Broadcast-Schedule

Broadcast Schedule.

Authorizations:
BearerAuth
query Parameters
name
required
string
Example: name=new year campaign

Title for schedule broadcast.

type
required
string
Example: type=subscriber

subscriber = scheduling on lists, segment = scheduling on segment.

broadcast_ids
required
string
Example: broadcast_ids=1,4

Name your broadcast.

smtp_ids
required
string
Example: smtp_ids=7,9

Node id(s) of Sending Nodes you want to use to send emails.

list_ids
string
Example: list_ids=17,98

List id(s) of Lists you want to schedule on.

segment_ids
string
Example: segment_ids=12,38

Segment id(s) of segments you want to schedule on.

smtp_sequence
required
string
Example: smtp_sequence=batch

batch = a node will create connection once for a batch of contacts, loop = one node for each contact.

sending_pattern
required
string
Example: sending_pattern=random

random = system will use random node from selected node list for sending sequential = system will use node in sequential order from selected node list for sending.

sending_time
required
string
Example: sending_time=now

now = send broadcast now later = schedule in future.

send_datetime
string
Example: send_datetime=2021-03-30 19:11:15

value must be greater than current datetime.

sender_type
required
string
Example: sender_type=smtp

smtp = use sender information from smtp list = use sender information from list.

track_opens
integer
Example: track_opens=1

0 = open tracking disabled 1 = open tracking enabled.

track_clicks
integer
Example: track_clicks=1

0 = clicks tracking disabled 1 = clicks tracking enabled.

unsub_show
integer
Example: unsub_show=1

Show unsubscribe link in broadcast 0 = don't show 1 = show.

track_duplicate
integer
Example: track_duplicate=1

0 = duplicate tracking disabled 1 = duplicate tracking enabled.

threads
integer
Example: threads=2

0 = unsubscribe headers disabled 1 = unsubscribe headers enabled.

unsubscriber_by_email
integer
Example: unsubscriber_by_email=1

0 = unsubscriber by email disabled 1 = unsubscriber by email enabled.

unsubscribe_email
string
Example: unsubscribe_email=email@domain.com

email.

unsubscribe_link
integer
Example: unsubscribe_link=1

0 = unsubscribe link disabled 1 = unsubscriber by email enabled.

hourly_speed
integer
Example: hourly_speed=100

rate of emails/hour.

from_name
string
Example: from_name=Richard

From name to use in email.

from_email
string
Example: from_email=email@domain.com

From email to use in email.

bounce_email
string
Example: bounce_email=bounce@gmail.com

Bounce Account to use in email.

reply_email
string
Example: reply_email=reply@gmail.com

Reply email to use in email.

Request Body schema: application/json
required

Broadcast Schedule.

name
required
string

Title for schedule broadcast.

type
required
string

subscriber = scheduling on lists, segment = scheduling on segment.

broadcast_ids
required
string

Name your broadcast.

smtp_ids
required
string

Node id(s) of Sending Nodes you want to use to send emails.

list_ids
string

List id(s) of Lists you want to schedule on.

segment_ids
string

Segment id(s) of segments you want to schedule on.

smtp_sequence
required
string

batch = a node will create connection once for a batch of contacts, loop = one node for each contact.

sending_pattern
required
string

random = system will use random node from selected node list for sending sequential = system will use node in sequential order from selected node list for sending.

sending_time
required
string

now = send broadcast now later = schedule in future.

send_datetime
string

value must be greater than current datetime.

sender_type
required
string

smtp = use sender information from smtp list = use sender information from list.

track_opens
integer

0 = open tracking disabled 1 = open tracking enabled.

track_clicks
integer

0 = clicks tracking disabled 1 = clicks tracking enabled.

unsub_show
integer

show unsubscribe link in broadcast 0 = don't show 1 = show.

track_duplicate
integer

0 = duplicate tracking disabled 1 = duplicate tracking enabled.

threads
integer

0 = unsubscribe headers disabled 1 = unsubscribe headers enabled.

unsubscriber_by_email
integer

0 = unsubscriber by email disabled 1 = unsubscriber by email enabled.

unsubscribe_email
string

email.

unsubscribe_link
integer

0 = unsubscribe link disabled 1 = unsubscriber by email enabled.

hourly_speed
integer

rate of emails/hour.

from_name
string

From name to use in email.

from_email
string

From email to use in email.

bounce_email
string

Bounce Account to use in email.

reply_email
string

Reply email to use in email.

Responses

Request samples

Content type
application/json
{
  • "name": "new year campaign",
  • "type": "subscriber",
  • "broadcast_ids": "1,4",
  • "smtp_ids": "7,9",
  • "list_ids": "17,98",
  • "segment_ids": "12,38",
  • "smtp_sequence": "batch",
  • "sending_pattern": "random",
  • "sending_time": "now",
  • "send_datetime": "2021-03-30 19:11:15",
  • "sender_type": "smtp",
  • "track_opens": 1,
  • "track_clicks": 1,
  • "unsub_show": 1,
  • "track_duplicate": 1,
  • "threads": 2,
  • "unsubscriber_by_email": 1,
  • "unsubscribe_email": "email@domain.com",
  • "unsubscribe_link": 1,
  • "hourly_speed": 100,
  • "from_name": "Richard",
  • "from_email": "email@domain.com",
  • "bounce_email": "bounce@gmail.com",
  • "reply_email": "reply@gmail.com"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Success: A broadcast has been scheduled successfully.",
  • "response": [
    ]
}

Get-Broadcast-Complaint-Stats

Get Broadcast Complaint Stats.

Authorizations:
BearerAuth
path Parameters
schedule_id
required
integer
Example: 14

Schedule id of schedule to get clicked stats.

query Parameters
limit_start
integer
Example: limit_start=0

Starting row of result. Default: 0.

limit_count
integer
Example: limit_count=25

Number of records to get. Default: 25.

Responses

Request samples 

curl -X GET -G https://demo.campaigns.mumara.com/api/getBroadcastStatsComplaints/{schedule_id} \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
-d {
     "limit_start":"0"  \
     "limit_count":"25"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": [
    ]
}

Send-Email

Send Email.

Authorizations:
BearerAuth
query Parameters
recipient
required
string
Example: recipient=david@gmail.com

Email of contact to whom to you want to send email.

from_name
required
string
Example: from_name=Rachel

From name.

from_email
required
string
Example: from_email=rachel@mumara.com

From email.

reply_to
string
Example: reply_to=reply@mumara.com

Reply to email

bounce_email
string
Example: bounce_email=bounce@mumara.com

Return path where the failed delivery reports will be send.

body
required
string
Example: body=This is Test Email

Body of email content.

subject
required
string
Example: subject=Test Subject

Email subject.

node_id
required
integer
Example: node_id=30

Sending node id of node you want to use for sending email.

Request Body schema: application/json
required

Send Email.

recipient
required
string

Email of contact to whom to you want to send email.

from_name
required
string

From name.

from_email
required
string

From email.

reply_to
string

Reply to email

bounce_email
string

Return path where the failed delivery reports will be send.

body
required
string

Body of email content.

subject
required
string

Email subject.

node_id
required
integer

Sending node id of node you want to use for sending email.

Responses

Request samples

Content type
application/json
{
  • "recipient": "david@gmail.com",
  • "from_name": "Rachel",
  • "from_email": "rachel@mumara.com",
  • "reply_to": "reply@mumara.com",
  • "bounce_email": "bounce@mumara.com",
  • "body": "This is Test Email",
  • "subject": "Test Subject",
  • "node_id": 30
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": {
    }
}

Custom Field

Add-Custom-Field

Add Custom Field.

Authorizations:
BearerAuth
query Parameters
name
required
string
Example: name=Designation

Custom field name goes here.

type
required
string
Example: type=Text Field

Type of the custom field, Text Field = text Multi-line Text Field = textarea Checkboxes = checkbox Dropdown = select Radio Button = radio Date Field = date JSON = json.

values
string
Example: values=1,2

Required yes for type checkbox,select,radio, Comma separated values.

required
integer
Example: required=1

While adding a contact, do you want to make it a required additional field? 0 = Not required while adding a contact 1 = Required field while adding a contact.

list_id
required
integer
Example: list_id=14

ids of the contact lists to assign this field to them.

field_order
required
integer
Example: field_order=13

Position of the custom field which adding a contact.

response
integer
Example: response=1

Get full response of the operation.

Request Body schema: application/json
required

Add Custom Field.

name
required
string

Custom field name goes here.

type
required
string

Type of the custom field, Text Field = text Multi-line Text Field = textarea Checkboxes = checkbox Dropdown = select Radio Button = radio Date Field = date JSON = json.

values
string

Required yes for type checkbox,select,radio, Comma separated values.

required
integer

While adding a contact, do you want to make it a required additional field? 0 = Not required while adding a contact 1 = Required field while adding a contact.

list_id
required
integer

ids of the contact lists to assign this field to them.

field_order
required
integer

Position of the custom field which adding a contact.

response
integer

Get full response of the operation.

Responses

Request samples

Content type
application/json
{
  • "name": "Designation",
  • "type": "Text Field",
  • "values": "1,2",
  • "required": 1,
  • "list_id": 14,
  • "field_order": 13,
  • "response": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Success: Broadcast successfully created.",
  • "data": {
    }
}

Update-Custom-Field

Update Custom Field.

Authorizations:
BearerAuth
path Parameters
id
required
integer
Example: 14

Custom Field id.

query Parameters
values
string
Example: values=1,2

Comma separated values.

required
integer
Example: required=1

While adding a contact, do you want to make it a required additional field? 0 = Not required while adding a contact 1 = Required field while adding a contact.

list_id
integer
Example: list_id=14

ids of the contact lists to assign this field to them.

field_order
integer
Example: field_order=13

Position of the custom field which adding a contact.

response
integer
Example: response=1

Get full response of the operation.

Request Body schema: application/json
required

Update Custom Field.

values
string

Comma separated values.

required
integer

While adding a contact, do you want to make it a required additional field? 0 = Not required while adding a contact 1 = Required field while adding a contact.

list_id
integer

ids of the contact lists to assign this field to them.

field_order
integer

Position of the custom field which adding a contact.

response
integer

Get full response of the operation.

Responses

Request samples

Content type
application/json
{
  • "values": "1,2",
  • "required": 1,
  • "list_id": 14,
  • "field_order": 13,
  • "response": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Success: Custom field updated successfully.",
  • "data": {
    }
}

Delete-Custom-Field

Delete Custom Field.

Authorizations:
BearerAuth
path Parameters
id
required
integer
Example: 14

Custom Field ID.

force
required
integer
Example: 1

1 = delete forcefully, 0 = not forcefully.

Responses

Request samples 

curl -X DELETE https://demo.campaigns.mumara.com/api/deleteCustomField/{id}/{force} \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Success: Custom field has been successfully deleted."
}

Get-List-Custom-Fields

Get List Custom Fields.

Authorizations:
BearerAuth
path Parameters
id
required
integer
Example: 14

id here refers to List ID to retrieve custom fields belonging to that specific list. To know the id of particular list you want to retrieve the custom fields of, go to View Lists page and click Edit from the Actions. The Edit page URL has the list ID and it appears like my.mumara.host/list/4/edit, in this URL 4 is the list ID.

Responses

Request samples 

curl -X GET -G https://demo.campaigns.mumara.com/api/getListCustomFields/{id} \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": [
    ]
}

Get-Custom-Fields

Get Custom Fields.

Authorizations:
BearerAuth
query Parameters
id
integer
Example: id=11

id of the specific custom field.

user_id
integer
Example: user_id=2

Get custom fields of a particular user.

limit_start
integer
Example: limit_start=0

Starting row of result. Default: 0.

limit_count
integer
Example: limit_count=25

Number of records to get. Default: 25.

Responses

Request samples 

curl -X GET -G https://demo.campaigns.mumara.com/api/getCustomFields \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
-d {
     "id":"11"  \
     "user_id":"2"  \
     "limit_start":"0"  \
     "limit_count":"25"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": [
    ]
}

Suppression

Suppress

Suppress.

Authorizations:
BearerAuth
query Parameters
type
required
integer
Example: type=1

0 = Global suppression, 1 = List based suppression.

reference
required
string
Example: reference=emailSuppression

Reference for the suppression.

email
required
string
Example: email=email@domain.com

Email address, domain and ip you want to add in suppression.

list_id
integer
Example: list_id=32

id of the contact list in which you want to suppress (0 will add in global).

user_id
integer
Example: user_id=2

Suppress emails, domains & ips in a specified user.

response
integer
Example: response=1

Get full response of the operation.

Request Body schema: application/json
required

Suppress.

type
required
integer

0 = Global suppression, 1 = List based suppression.

reference
required
string

Reference for the suppression.

email
required
string

Email address, domain and ip you want to add in suppression.

list_id
integer

id of the contact list in which you want to suppress (0 will add in global).

user_id
integer

Suppress emails, domains & ips in a specified user.

response
integer

Get full response of the operation.

Responses

Request samples

Content type
application/json
{
  • "type": 1,
  • "reference": "emailSuppression",
  • "email": "email@domain.com",
  • "list_id": 32,
  • "user_id": 2,
  • "response": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Success: Email has been successfully added to suppression list",
  • "response": {
    }
}

Get-Suppressed

Get Suppressed

Authorizations:
BearerAuth
query Parameters
type
required
string
Example: type=email

Select type of suppression list you want to get.

id
integer
Example: id=3

id of the suppressed entry.

reference
string
Example: reference=emailSuppression

Get suppressed records according to this reference.

user_id
integer
Example: user_id=2

Get suppressed records of a particular user.

limit_start
integer
Example: limit_start=0

Starting row of result. Default: 0.

limit_count
integer
Example: limit_count=25

Number of records to get. Default: 25.

Responses

Request samples 

curl -X GET -G https://demo.campaigns.mumara.com/api/getSuppressed \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
-d {
     "type":"email"  \
     "id":"3"  \
     "reference":"emailSuppression"  \
     "user_id":"2"  \
     "limit_start":"0"  \
     "limit_count":"25"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": [
    ]
}

Delete-Suppressed

Delete Suppressed

Authorizations:
BearerAuth
path Parameters
type
required
string
Example: email

Select type of suppression list you want to get.

query Parameters
id
integer
Example: id=3

id of the suppressed entry.

reference
string
Example: reference=emailSuppression

Get suppressed records according to this reference.

user_id
integer
Example: user_id=2

Get suppressed records of a particular user.

Responses

Request samples 

curl -X DELETE https://demo.campaigns.mumara.com/api/deleteSuppressed/{type} \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
-d {
     "id":"3"  \
     "reference":"emailSuppression"  \
     "user_id":"2"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Error: Record has been successfully deleted."
}

Bounce

Add-Bounce-Address

Add Bounce Address.

Authorizations:
BearerAuth
query Parameters
email
required
string
Example: email=bounce@domain.com

Email of bounce account.

hostname
required
string
Example: hostname=anydomain.com

Host of provider .

port
required
integer
Example: port=110

Port to connect to the bounce account.

username
required
string
Example: username=james

Username of bounce account.

method
required
string
Example: method=pop

Method to connect to the bounce account.

password
string
Example: password=drV"xwrbSDwz

Get full response of the operation.

folder
string
Example: folder=INBOX

Folder name for your bounce account where bounce email exists.

delete_emails
integer
Example: delete_emails=0

0 = Do not delete proccessed emails, 1 = Delete processed emails .

validate_certificates
interger
Example: validate_certificates=1

0 = Don not validate certificate, 1 = Validate certificate.

process_bounces
interger
Example: process_bounces=1

0 = Do not process bounce via bounce account, 1 = Process bounce via bounce account.

is_active
interger
Example: is_active=1

Status of bounce account 0 = Inctive, 1 = Active.

encryption
string
Example: encryption=none

Encryption method for bonce account.

response
integer
Example: response=1

Get full response of the operation.

Request Body schema: application/json
required

Add Bounce Address.

email
required
string

Email of bounce account.

hostname
required
string

Host of provider .

port
required
integer

Port to connect to the bounce account.

username
required
string

Username of bounce account.

method
required
string

Method to connect to the bounce account.

password
string

Get full response of the operation.

folder
string

Folder name for your bounce account where bounce email exists.

delete_emails
integer

0 = Do not delete proccessed emails, 1 = Delete processed emails .

validate_certificates
interger

0 = Don not validate certificate, 1 = Validate certificate.

process_bounces
interger

0 = Do not process bounce via bounce account, 1 = Process bounce via bounce account.

is_active
interger

Status of bounce account 0 = Inctive, 1 = Active.

encryption
string

Encryption method for bonce account.

response
integer

Get full response of the operation.

Responses

Request samples

Content type
application/json
{
  • "email": "bounce@domain.com",
  • "hostname": "anydomain.com",
  • "port": 110,
  • "username": "james",
  • "method": "pop",
  • "password": "KT&9SDAkd{vg",
  • "folder": "INBOX",
  • "delete_emails": 0,
  • "validate_certificates": "1",
  • "process_bounces": "1",
  • "is_active": "1",
  • "encryption": "none",
  • "response": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Success: Bounce Address has been successfully added.",
  • "response": {
    }
}

Update-Bounce-Address

Update Bounce Address.

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 5

id of bounce account which you want to update.

query Parameters
email
string
Example: email=bounce@domain.com

Email of bounce account.

hostname
string
Example: hostname=anydomain.com

Host of provider .

port
integer
Example: port=110

Port to connect to the bounce account.

username
string
Example: username=james

Username of bounce account.

method
string
Example: method=pop

Method to connect to the bounce account.

password
string
Example: password=MVXVsWM}aX5k

Get full response of the operation.

folder
string
Example: folder=INBOX

Folder name for your bounce account where bounce email exists.

delete_emails
integer
Example: delete_emails=0

0 = Do not delete proccessed emails, 1 = Delete processed emails .

validate_certificates
interger
Example: validate_certificates=1

0 = Don not validate certificate, 1 = Validate certificate.

process_bounces
interger
Example: process_bounces=1

0 = Do not process bounce via bounce account, 1 = Process bounce via bounce account.

is_active
interger
Example: is_active=1

Status of bounce account 0 = Inctive, 1 = Active.

encryption
string
Example: encryption=none

Encryption method for bonce account.

response
integer
Example: response=1

Get full response of the operation.

Request Body schema: application/json
required

Update Bounce Address.

email
string

Email of bounce account.

hostname
string

Host of provider .

port
integer

Port to connect to the bounce account.

username
string

Username of bounce account.

method
string

Method to connect to the bounce account.

password
string

Get full response of the operation.

folder
string

Folder name for your bounce account where bounce email exists.

delete_emails
integer

0 = Do not delete proccessed emails, 1 = Delete processed emails .

validate_certificates
interger

0 = Don not validate certificate, 1 = Validate certificate.

process_bounces
interger

0 = Do not process bounce via bounce account, 1 = Process bounce via bounce account.

is_active
interger

Status of bounce account 0 = Inctive, 1 = Active.

encryption
string

Encryption method for bonce account.

response
integer

Get full response of the operation.

Responses

Request samples

Content type
application/json
{
  • "email": "bounce@domain.com",
  • "hostname": "anydomain.com",
  • "port": 110,
  • "username": "james",
  • "method": "pop",
  • "password": "i\"=D0W.>:X&~",
  • "folder": "INBOX",
  • "delete_emails": 0,
  • "validate_certificates": "1",
  • "process_bounces": "1",
  • "is_active": "1",
  • "encryption": "none",
  • "response": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Success: Bounce Address has been successfully updated.",
  • "response": {
    }
}

Delete-Bounce-Address

Delete Bounce Address.

Authorizations:
BearerAuth
path Parameters
ids
required
string
Example: 5,9

Bounce account id(s) to be deleted.

Responses

Request samples 

curl -X DELETE https://demo.campaigns.mumara.com/api/deleteBounceAddresses/{ids} \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Success: Bounce Addresses have been successfully deleted."
}

Get-Bounce-Address

Get Bounce Address.

Authorizations:
BearerAuth
path Parameters
id
integer
Example: 5

Bounce Account id which account you want to get.

user_id
integer
Example: 2

Get Bounce Account of a particular user.

limit_start
integer
Example: 0

Starting row of result. Default: 0.

limit_count
integer
Example: 25

Number of records to get. Default: 25.

Responses

Request samples 

curl -X GET -G https://demo.campaigns.mumara.com/api/getBounceAddresses \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Success: Bounce Addresses have been successfully deleted."
}

Bounce Rule

Add-Bounce-Rule

Add Bounce Rule.

Authorizations:
BearerAuth
query Parameters
label
required
string
Example: label=5.1.1 label

Label for bounce rule.

code
required
string
Example: code=5.1.1

Bounce Code i.e (5.1.1) .

code_condition
required
string
Example: code_condition=is

is = where bounce code is.

type
required
string
Example: type=soft

Action to mark as bounce no_process = not bounced, hard = hard bounced, soft = soft bounces.

reason_condition
string
Example: reason_condition=is

is = where bounce details_reason is contains = where bounce details_reason contains specfic character(s).

details
string
Example: details=unknown

Bounce details.

details_condition
string
Example: details_condition=contains

is = where bounce details is contains = where details contains specfic character(s).

details_reason
string
Example: details_reason=details_reason

Bounce detailed reason.

status
interger
Example: status=1

0 = Inactive, 1 = Active.

Request Body schema: application/json
required

Add Bounce Rule.

label
required
string

Label for bounce rule.

code
required
string

Bounce Code i.e (5.1.1) .

code_condition
required
string

is = where bounce code is.

type
required
string

Action to mark as bounce no_process = not bounced, hard = hard bounced, soft = soft bounces.

reason_condition
string

is = where bounce details_reason is contains = where bounce details_reason contains specfic character(s).

details
string

Bounce details.

details_condition
string

is = where bounce details is contains = where details contains specfic character(s).

details_reason
string

Bounce detailed reason.

status
interger

0 = Inactive, 1 = Active.

Responses

Request samples

Content type
application/json
{
  • "label": "5.1.1 label",
  • "code": "5.1.1",
  • "code_condition": "is",
  • "type": "soft",
  • "reason_condition": "is",
  • "details": "unknown",
  • "details_condition": "contains",
  • "details_reason": "details_reason",
  • "status": "1"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Success: Bounce Rule successfully added.",
  • "response": {
    }
}

Update-Bounce-Rule

Update Bounce Rule.

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 2

id of bounce rule which you want to update.

query Parameters
label
string
Example: label=5.1.1 label

Label for bounce rule.

code
string
Example: code=5.1.1

Bounce Code i.e (5.1.1) .

code_condition
string
Example: code_condition=is

is = where bounce code is.

type
string
Example: type=soft

Action to mark as bounce no_process = not bounced, hard = hard bounced, soft = soft bounces.

reason_condition
string
Example: reason_condition=is

is = where bounce details_reason is contains = where bounce details_reason contains specfic character(s).

details
string
Example: details=unknown

Bounce details.

details_condition
string
Example: details_condition=contains

is = where bounce details is contains = where details contains specfic character(s).

details_reason
string
Example: details_reason=details_reason

Bounce detailed reason.

status
interger
Example: status=1

0 = Inactive, 1 = Active.

Request Body schema: application/json
required

Update Bounce Rule.

label
string

Label for bounce rule.

code
string

Bounce Code i.e (5.1.1) .

code_condition
string

is = where bounce code is.

type
string

Action to mark as bounce no_process = not bounced, hard = hard bounced, soft = soft bounces.

reason_condition
string

is = where bounce details_reason is contains = where bounce details_reason contains specfic character(s).

details
string

Bounce details.

details_condition
string

is = where bounce details is contains = where details contains specfic character(s).

details_reason
string

Bounce detailed reason.

status
interger

0 = Inactive, 1 = Active.

Responses

Request samples

Content type
application/json
{
  • "label": "5.1.1 label",
  • "code": "5.1.1",
  • "code_condition": "is",
  • "type": "soft",
  • "reason_condition": "is",
  • "details": "unknown",
  • "details_condition": "contains",
  • "details_reason": "details_reason",
  • "status": "1"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Success: Bounce Rule has been successfully updated.",
  • "response": {
    }
}

Get-Bounce-Rule

Get Bounce Rule.

Authorizations:
BearerAuth
query Parameters
id
integer
Example: id=2

Bounce rule id which rule you want to get.

limit_start
integer
Example: limit_start=0

Starting row of result. Default: 0.

limit_count
integer
Example: limit_count=25

Number of records to get. Default: 25.

Responses

Request samples 

curl -X GET -G https://demo.campaigns.mumara.com/api/getBounceRules \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
-d {
     "id":"2"  \
     "limit_start":"0"  \
     "limit_count":"25"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": [
    ]
}

Delete-Bounce-Rule

Delete Bounce Rule.

Authorizations:
BearerAuth
path Parameters
ids
required
string
Example: 10,11

Bounce rule id(s) to be deleted.

Responses

Request samples 

curl -X DELETE https://demo.campaigns.mumara.com/api/deleteBounceRules/{ids} \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Success: Bounce Rules have been successfully deleted."
}

FBL Account

Add-FBL-Account

Add FBL Account.

Authorizations:
BearerAuth
query Parameters
email
required
string
Example: email=johnlee@yahoo.com

Email of FBL account.

host
required
string
Example: host=yahoo.com

Host of provider.

port
required
integer
Example: port=110

Port to connect to the FBL account.

username
required
string
Example: username=johnlee

Username of FBL account.

method
required
string
Example: method=pop

Method to connect to the FBL account.

password
string
Example: password=Y0L)REo75y,<

Password of FBL account.

folder
string
Example: folder=INBOX

Folder name for your bounce account where complaint emails exist.

delete_emails
integer
Example: delete_emails=1

0 = Do not delete proccessed emails, 1 = Delete processed emails.

validate_certificates
integer
Example: validate_certificates=1

0 = Don not validate certificate 1 = Validate certificate.

status
interger
Example: status=1

Status of bounce account 0 = Inctive, 1 = Active.

encryption
string
Example: encryption=ssl

Encryption method for FBL account.

response
interger
Example: response=1

Get full response of the operation.

Request Body schema: application/json
required

Add FBL Account.

email
required
string

Email of FBL account.

host
required
string

Host of provider.

port
required
integer

Port to connect to the FBL account.

username
required
string

Username of FBL account.

method
required
string

Method to connect to the FBL account.

password
string

Password of FBL account.

folder
string

Folder name for your bounce account where complaint emails exist.

delete_emails
integer

0 = Do not delete proccessed emails, 1 = Delete processed emails.

validate_certificates
integer

0 = Don not validate certificate 1 = Validate certificate.

status
interger

Status of bounce account 0 = Inctive, 1 = Active.

encryption
string

Encryption method for FBL account.

response
interger

Get full response of the operation.

Responses

Request samples

Content type
application/json
{
  • "email": "johnlee@yahoo.com",
  • "host": "yahoo.com",
  • "port": 110,
  • "username": "johnlee",
  • "method": "pop",
  • "password": "l%Z-YtW;ky>a",
  • "folder": "INBOX",
  • "delete_emails": 1,
  • "validate_certificates": 1,
  • "status": "1",
  • "encryption": "ssl",
  • "response": "1"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Success: Bounce Rule successfully added.",
  • "response": {
    }
}

Update-FBL-Account

Update FBL Account.

Authorizations:
BearerAuth
path Parameters
id
required
integer
Example: 13

id of FBLaccount which you want to update.

query Parameters
email
string
Example: email=johnlee@yahoo.com

Email of FBL account.

host
string
Example: host=yahoo.com

Host of provider.

port
integer
Example: port=110

Port to connect to the FBL account.

username
string
Example: username=johnlee

Username of FBL account.

method
string
Example: method=pop

Method to connect to the FBL account.

password
string
Example: password=+2fz0Z5G8E#*

Password of FBL account.

folder
string
Example: folder=INBOX

Folder name for your bounce account where complaint emails exist.

delete_emails
integer
Example: delete_emails=1

0 = Do not delete proccessed emails, 1 = Delete processed emails.

validate_certificates
integer
Example: validate_certificates=1

0 = Don not validate certificate 1 = Validate certificate.

status
interger
Example: status=1

Status of bounce account 0 = Inctive, 1 = Active.

encryption
string
Example: encryption=ssl

Encryption method for FBL account.

response
interger
Example: response=1

Get full response of the operation.

Request Body schema: application/json
required

Update FBL Account.

email
string

Email of FBL account.

host
string

Host of provider.

port
integer

Port to connect to the FBL account.

username
string

Username of FBL account.

method
string

Method to connect to the FBL account.

password
string

Password of FBL account.

folder
string

Folder name for your bounce account where complaint emails exist.

delete_emails
integer

0 = Do not delete proccessed emails, 1 = Delete processed emails.

validate_certificates
integer

0 = Don not validate certificate 1 = Validate certificate.

status
interger

Status of bounce account 0 = Inctive, 1 = Active.

encryption
string

Encryption method for FBL account.

response
interger

Get full response of the operation.

Responses

Request samples

Content type
application/json
{
  • "email": "johnlee@yahoo.com",
  • "host": "yahoo.com",
  • "port": 110,
  • "username": "johnlee",
  • "method": "pop",
  • "password": "ohJvpho@Ji?[",
  • "folder": "INBOX",
  • "delete_emails": 1,
  • "validate_certificates": 1,
  • "status": "1",
  • "encryption": "ssl",
  • "response": "1"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Success: FBL Account has been successfully updated.",
  • "response": {
    }
}

Get-FBL-Account

Get FBL Account.

Authorizations:
BearerAuth
query Parameters
id
integer
Example: id=13

FBL Account id which account you want to get.

limit_start
integger
Example: limit_start=0

EStarting row of result. Default: 0.

limit_count
integer
Example: limit_count=25

Number of records to get. Default: 25.

Responses

Request samples 

curl -X GET -G https://demo.campaigns.mumara.com/api/getFBLAccounts \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
-d {
     "id":"13"  \
     "limit_start":"0"  \
     "limit_count":"25"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": {
    }
}

Delete-FBL-Account

Delete FBL Account.

Authorizations:
BearerAuth
query Parameters
ids
required
string
Example: ids=17,89

FBL account id(s) to be deleted.

Responses

Request samples 

curl -X DELETE https://demo.campaigns.mumara.com/api/deleteFBLAccounts/{ids} \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
-d {
     "ids":"17,89"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "response": "Success: FBL Accounts have been successfully deleted."
}

SpinTags

Add-SpinTags

Add SpinTags.

Authorizations:
BearerAuth
query Parameters
place_holder
required
string
Example: place_holder=Test List via Api

A unique title for spintag.

word_list
required
string
Example: word_list=John Lee

List of values for a spintag.

response
integer
Example: response=1

Get full response of the operation.

Request Body schema: application/json
required

Add SpinTags.

place_holder
required
string

A unique title for spintag.

word_list
required
string

List of values for a spintag.

response
integer

Get full response of the operation.

Responses

Request samples

Content type
application/json
{
  • "place_holder": "Test List via Api",
  • "word_list": "John Lee",
  • "response": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Success: Spintag has been successfully added.",
  • "response": {
    }
}

Update-SpinTags

Update SpinTags.

Authorizations:
BearerAuth
path Parameters
id
required
interger
Example: 4

id of spintag which you want to update.

query Parameters
word_list
string
Example: word_list=John Lee

List of values for a spintag.

response
integer
Example: response=1

Get full response of the operation.

Request Body schema: application/json
required

Update SpinTags.

word_list
string

List of values for a spintag.

response
integer

Get full response of the operation.

Responses

Request samples

Content type
application/json
{
  • "place_holder": "Test List via Api",
  • "word_list": "John Lee",
  • "response": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Success: Spintag has been successfully updated.",
  • "response": {
    }
}

Get-SpinTags

Get SpinTags.

Authorizations:
BearerAuth
query Parameters
id
interger
Example: id=4

Spintag id which you want to get.

user_id
interger
Example: user_id=2

Get spintags of a particular user.

limit_start
integer
Example: limit_start=0

Starting row of result. Default: 0.

limit_count
integer
Example: limit_count=25

Number of records to get. Default: 25.

Responses

Request samples 

curl -X GET -G https://demo.campaigns.mumara.com/api/getSpinTags \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
-d {
     "id":"4"  \
     "user_id":"2"  \
     "limit_start":"0"  \
     "limit_count":"25"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "response": [
    ]
}

Delete-SpinTags

Delete SpinTags.

Authorizations:
BearerAuth
path Parameters
ids
interger
Example: 4,8

Spintags id(s) to be deleted.

Responses

Request samples 

curl -X DELETE https://demo.campaigns.mumara.com/api/deleteSpinTags/{ids} \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \

Response samples

Content type
application/json
{
  • "status": "success",
  • "response": "Success: Spintags have been successfully deleted."
}

Activity Logs

Get-Activity-Logs

Get Activity Logs.

Authorizations:
BearerAuth
query Parameters
user_id
integer
Example: user_id=2

Get activity logs of a particular user.

limit_start
integer
Example: limit_start=0

Starting row of result. Default: 0.

limit_count
integer
Example: limit_count=25

Number of records to get. Default: 25.

Responses

Request samples 

curl -X GET -G https://demo.campaigns.mumara.com/api/getActivityLogs \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
-d {
     "user_id":"2"  \
     "limit_start":"0"  \
     "limit_count":"25"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": [
    ]
}

Broadcast Statistic

Get-Broadcast-Stats-Summary

Get Broadcast Stats Summary.

Authorizations:
BearerAuth
path Parameters
schedule_id
required
integer
Example: 22

Schedule id of schedule to get stats summary.

Responses

Request samples 

curl -X GET -G https://demo.campaigns.mumara.com/api/getBroadcastStatsSummary/{schedule_id} \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": {
    }
}

Get-Broadcast-Bounced-Stats

Get Broadcast Bounced Stats.

Authorizations:
BearerAuth
path Parameters
schedule_id
required
integer
Example: 24

Schedule id of schedule to get bounced stats.

query Parameters
limit_start
integer
Example: limit_start=0

Starting row of result. Default: 0.

limit_count
integer
Example: limit_count=25

Number of records to get. Default: 25.

Responses

Request samples 

curl -X GET -G https://demo.campaigns.mumara.com/api/getBroadcastStatsBounced/{schedule_id} \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
-d {
     "limit_start":"0"  \
     "limit_count":"25"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": [
    ]
}

Get-Broadcast-Opened-Stats

Get Broadcast Opened Stats.

Authorizations:
BearerAuth
path Parameters
schedule_id
required
integer
Example: 27

Schedule id of schedule to get Opened stats.

query Parameters
limit_start
integer
Example: limit_start=0

Starting row of result. Default: 0.

limit_count
integer
Example: limit_count=25

Number of records to get. Default: 25.

Responses

Request samples 

curl -X GET -G https://demo.campaigns.mumara.com/api/getBroadcastStatsOpened/{schedule_id} \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
-d {
     "limit_start":"0"  \
     "limit_count":"25"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": [
    ]
}

Get-Broadcast-Clicked-Stats

Get Broadcast Clicked Stats.

Authorizations:
BearerAuth
path Parameters
schedule_id
required
integer
Example: 27

Schedule id of schedule to get Opened stats.

query Parameters
limit_start
integer
Example: limit_start=0

Starting row of result. Default: 0.

limit_count
integer
Example: limit_count=25

Number of records to get. Default: 25.

Responses

Request samples 

curl -X GET -G https://demo.campaigns.mumara.com/api/getBroadcastStatsClicked/{schedule_id} \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
-d {
     "limit_start":"0"  \
     "limit_count":"25"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": []
}

Get-Broadcast-Unsubscribed-Stats

Get Broadcast Unsubscribed Stats.

Authorizations:
BearerAuth
path Parameters
schedule_id
required
integer
Example: 27

Schedule id of schedule to get Opened stats.

query Parameters
limit_start
integer
Example: limit_start=0

Starting row of result. Default: 0.

limit_count
integer
Example: limit_count=25

Number of records to get. Default: 25.

Responses

Request samples 

curl -X GET -G https://demo.campaigns.mumara.com/api/getBroadcastStatsUnsubscribed/{schedule_id} \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
-d {
     "limit_start":"0"  \
     "limit_count":"25"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": [
    ]
}

Get-Broadcast-Stats-Logs

Get Broadcast Stats Logs.

Authorizations:
BearerAuth
path Parameters
schedule_id
required
integer
Example: 27

Schedule id of schedule to get Opened stats.

query Parameters
limit_start
integer
Example: limit_start=0

Starting row of result. Default: 0.

limit_count
integer
Example: limit_count=25

Number of records to get. Default: 25.

Responses

Request samples 

curl -X GET -G https://demo.campaigns.mumara.com/api/getBroadcastStatsLogs/{schedule_id} \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
-d {
     "limit_start":"0"  \
     "limit_count":"25"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": [
    ]
}

Get-Logs-By-ID(s)

Get Logs By ID(s).

Authorizations:
BearerAuth
path Parameters
campaign_schedule_logs_ids
required
string
Example: 22,43,55

Campaigns schedule logs IDs to get the record from table campaign_schedule_logs.

query Parameters
user_id
integer
Example: user_id=21

Get schedule Logs of a particular user. (Note user_id is used for super admin and staff only)

Responses

Request samples 

curl -X GET -G https://demo.campaigns.mumara.com/api/getLogsByIds/{campaign_schedule_logs_ids} \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
-d {
     "user_id":"21"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": [
    ]
}

Get-Broadcast-Stats-Global

Get Broadcast Stats Global.

Authorizations:
BearerAuth
query Parameters
limit_start
integer
Example: limit_start=0

Starting row of result. Default: 0.

limit_count
integer
Example: limit_count=25

Number of records to get. Default: 25.

type
required
string
Example: type=opened

Select the type of which you want to get the global Broadcast stats. You can select one of the following required type: bounced, opened, clicked, unsubscribed, logs.

t_date
date
Example: t_date=2022-09-19

The date on which you want to fetch the global Broadcast stats. Supported format (dd-mm-yyyy)

t_start
timestamps
Example: t_start=2022-10-19 14:01:00

The start time from when to fetch the global Broadcast stats. Supported format (dd-mm-yyyy_hh-mm-ss)

t_end
timestamps
Example: t_end=2022-10-20 14:01:00

The end time till when to fetch the global Broadcast stats. Supported format (dd-mm-yyyy_hh-mm-ss)

t_pastminutes
integer
Example: t_pastminutes=34

The time duration for which you want to get global broadcast statistics. Supported format (xx)

Responses

Request samples 

curl -X GET -G https://demo.campaigns.mumara.com/api/getBroadcastStatsGlobal \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
-d {
     "limit_start":"0"  \
     "limit_count":"25"
     "type":"opened"
     "t_date":"2022-09-19"
     "t_start":"t_start=2022-10-19 14:01:00"
     "t_end":"2022-10-20 14:01:00"
     "t_pastminutes":"34"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": [
    ]
}

User

Add-User

Add User.

Authorizations:
BearerAuth
query Parameters
name
required
string
Example: name=Jon

Name of the user you're adding.

email
required
string
Example: email=email@domain.com

Email of the user you're adding.

password
required
string
Example: password=0AT'}d5piG]K

Password of the user you're adding.

package_id
required
integer
Example: package_id=3

Package id for user .

timezone
string
Example: timezone=+05:00

Timezone of user you're adding.

login_ips
string
Example: login_ips=192.168.1.1,192.168.1.2

Restrict access to user your account by adding a range of trusted IP addresses.

hashed
integer
Example: hashed=0

Setting it to 1 means, Mumara will not encrypt the password.

response
integer
Example: response=1

Get full response of the operation.

Request Body schema: application/json
required

Add User.

name
required
string

Name of the user you're adding.

email
required
string

Email of the user you're adding.

password
required
string

Password of the user you're adding.

package_id
required
integer

Package id for user.

timezone
string

Timezone of user you're adding.

login_ips
string

Restrict access to user your account by adding a range of trusted IP addresses.

hashed
integer

Setting it to 1 means, Mumara will not encrypt the password.

response
integer

Get full response of the operation.

Responses

Request samples

Content type
application/json
{
  • "name": "Jon",
  • "email": "email@domain.com",
  • "password": "/:2E$Ej4n~A-",
  • "package_id": 3,
  • "timezone": "+05:00",
  • "login_ips": "192.168.1.1,192.168.1.2",
  • "hashed": 0,
  • "response": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "User has been successfully created.",
  • "response": [
    ]
}

Update-User

Update User.

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 3

id or email you want to update.

query Parameters
name
string
Example: name=Richard

Name of the user you're updating.

email
string
Example: email=email@domain.com

Email of the user you're updating.

password
string
Example: password=_gIx3QmcC?''

Password of the user you're updating.

package_id
integer
Example: package_id=3

Package id for user .

country_code
string
Example: country_code=US

Country code of user i.e (PK,US).

address_line_1
string
Example: address_line_1=St # 1

Address 1 of user.

address_line_2
string
Example: address_line_2=St # 2

Address 2 of user.

city
string
Example: city=New York

Residential city of user.

state
string
Example: state=state

State of user where he is living.

post_code
string
Example: post_code=1232

Postal/Zip code of user.

phone
integer
Example: phone=3317667

Phone number of user.

mobile
integer
Example: mobile=33327667

Mobile number of user.

mobile_country_code
string
Example: mobile_country_code=91

Mobile Country Code of user, i.e (92,1,91).

timezone
string
Example: timezone=+05:00

Timezone of user you're adding.

login_ips
string
Example: login_ips=192.168.1.1,192.168.1.2

Restrict access to user your account by adding a range of trusted IP addresses.

hashed
integer
Example: hashed=0

Setting it to 1 means, Mumara will not encrypt the password.

response
integer
Example: response=1

Get full response of the operation.

Request Body schema: application/json
required

Update User.

name
string

Name of the user you're updating.

email
string

Email of the user you're updating.

password
string

Password of the user you're updating.

package_id
integer

Package id for user .

country_code
string

Country code of user i.e (PK,US).

address_line_1
string

Address 1 of user.

address_line_2
string

Address 2 of user.

city
string

Residential city of user.

state
string

State of user where he is living.

post_code
string

Postal/Zip code of user.

phone
integer

Phone number of user.

mobile
integer

Mobile number of user.

mobile_country_code
string

Mobile Country Code of user, i.e (92,1,91).

timezone
string

Timezone of user you're adding.

login_ips
string

Restrict access to user your account by adding a range of trusted IP addresses.

hashed
integer

Setting it to 1 means, Mumara will not encrypt the password.

response
integer

Get full response of the operation.

Responses

Request samples

Content type
application/json
{
  • "name": "Richard",
  • "email": "email@domain.com",
  • "password": "B#C6cJ\\#8\\Hx",
  • "package_id": 3,
  • "country_code": "US",
  • "address_line_1": "St # 1",
  • "address_line_2": "St # 2",
  • "city": "New York",
  • "state": "state",
  • "post_code": "1232",
  • "phone": 3317667,
  • "mobile": 33327667,
  • "mobile_country_code": "91",
  • "timezone": "+05:00",
  • "login_ips": "192.168.1.1,192.168.1.2",
  • "hashed": 0,
  • "response": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "User has been successfully created.",
  • "response": [
    ]
}

Delete-User

Delete User.

Authorizations:
BearerAuth
path Parameters
id
required
integer
Example: 5

Id or email of use which you want to delete.

type
required
string
Example: hard

soft = soft delete, hard = hard delete.

Responses

Request samples 

curl -X DELETE https://demo.campaigns.mumara.com/api/deleteUser/{idOrEmail}/{type} \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "User has been successfully deleted."
}

Sending Domain

Add-Sending-Domain

Add Sending Domain.

Authorizations:
BearerAuth
query Parameters
domain
required
string
Example: domain=domain.com

Complete address of the domain you are looking to add as sending domain.

masking_type
required
string
Example: masking_type=cname

Preferred option between the available option, cloak, htaccess, cname (default: cname).

enable_tracking
required
integer
Example: enable_tracking=1

Flag to turn on tracking status. 1 = Active, 0 = Inactive (default: 0).

generate_dkim
integer
Example: generate_dkim=0

Flag to generate dkim keys. 1 = Generate dkim keys, 0 = Do not generate dkim keys (default: 0). Required Yes if enable_signing = 1.

enable_signing
integer
Example: enable_signing=1

Flag to enable/disable dkim signing 1 = Enable 0 = Disable (default: 0).

response
integer
Example: response=1

Get full response of operation 0, 1 (default: 0).

Request Body schema: application/json
required

Add Sending Domain.

domain
required
string

Complete address of the domain you are looking to add as sending domain.

masking_type
required
string

Preferred option between the available option, cloak, htaccess, cname (default: cname).

enable_tracking
required
integer

Flag to turn on tracking status. 1 = Active, 0 = Inactive (default: 0).

generate_dkim
integer

Flag to generate dkim keys. 1 = Generate dkim keys, 0 = Do not generate dkim keys (default: 0). Required Yes if enable_signing = 1.

enable_signing
integer

Flag to enable/disable dkim signing 1 = Enable 0 = Disable (default: 0).

response
integer

Get full response of operation 0, 1 (default: 0).

Responses

Request samples

Content type
application/json
{
  • "domain": "domain.com",
  • "masking_type": "cname",
  • "enable_tracking": 1,
  • "generate_dkim": 0,
  • "enable_signing": 1,
  • "response": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Success: Sending Domain has been successfully added.",
  • "response": {
    }
}

Get-Sending-Domains

Get Sending Domains.

Authorizations:
BearerAuth
query Parameters
id
integer
Example: id=12

Sending domain id.

user_id
integer
Example: user_id=2

User id.

limit_start
integer
Example: limit_start=1

Starting row of result. Default: 0.

limit_count
integer
Example: limit_count=25

Number of records to get. Default: 25.

Responses

Request samples 

curl -X GET -G https://demo.campaigns.mumara.com/api/getSendingDomains \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
-d {
     "id":"12"  \
     "user_id":"2"  \
     "limit_start":"1"  \
     "limit_count":"25"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "response": [
    ]
}

Delete-Sending-Domain

Delete Sending Domain

Authorizations:
BearerAuth
path Parameters
id
required
integer
Example: 3

id of the Sending domain to be deleted.

Responses

Request samples 

curl -X DELETE https://demo.campaigns.mumara.com/api/deleteList/{id} \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": "Success: Sending Domain has been successfully deleted."
}

Sending Node

Add-Sending-Node-SMTP

Add Sending Node SMTP.

Authorizations:
BearerAuth
query Parameters
name
required
string
Example: name=Mumara

Friendly name of the sending node for identification purpose.

group_id
required
integer
Example: group_id=21

specify the Group ID in which you intend to list your sending node.

host
required
string
Example: host=smtp.mumara.com

Hostname of the SMTP server to connect with.

username
required
string
Example: username=alpha

Username of the SMTP.

password
required
string
Example: password=Mumara123**

Password of the SMTP.

port
required
integer
Example: port=25

Port number of the SMTP server to connect with.

encryption_method
string
Example: encryption_method=ssl

It's the encryption of the email message to protect the content of the email from being read by entities other than the original recipients. None: The SMTP server doesn't require any encryption. TLS: TLS is a cryptographic protocol that provides end-to-end communications security over networks and is widely used for internet communications and online transactions. SSL: It is a layer over the plaintext communication, allowing email servers to upgrade their plaintext communication to encrypted communication.

mail_encoding
string
Example: mail_encoding=8bit

Select the encoding of the outgoing messages.

allow_self_signed
integer
Example: allow_self_signed=1

Allow Self-signed Certificates enables the acceptance of digital certificates signed by the entity creating them, rather than a recognized certificate authority. Enabling this option permits the system to accept and validate self-signed certificates for secure connections. The value will be: 0 = No, 1 = yes.

verify_peer
integer
Example: verify_peer=0

Verify Peer Certificate entails validating the authenticity of certificates presented by connected peers during secure communication. The value will be: 0 = No, 1 = yes.

verify_peer_name
integer
Example: verify_peer_name=1

Verify Peer Name refers to the validation process that confirms the presented certificate's name against the expected peer identity during secure connections.The value will be: 0 = No, 1 = yes.

from_name
required
string
Example: from_name=alex

Name that the email will appear to be sent from.

from_email
required
string
Example: from_email=alex@domain.com

The email will appear to be sent from this email address at the recipient's server. (Responsible for DKIM Authentication).

reply_email
string
Example: reply_email=reply@domain.com

The email address where you want to receive the replies from the recipients.

bounce_email
string
Example: bounce_email=bounce@domain.com

The email address where you want to receive the delivery reports of the failed messages. You need to add this email address to bounce addresses first.

tracking_domain
string
Example: tracking_domain=click.domain.com

The domain/subdomain that appears in all hyperlinks and images.

status
required
integer
Example: status=1

Active: Active sending nodes are ready to relay the emails, Inactive: Inactive sending nodes don't appear in the scheduling process. The value will be: 0 = Inactive, 1 = Active.

Request Body schema: application/json
required

Add Sending Node SMTP.

name
required
string

Friendly name of the sending node for identification purpose.

group_id
required
integer

specify the Group ID in which you intend to list your sending node.

host
required
string

Hostname of the SMTP server to connect with.

username
required
string

Username of the SMTP.

password
required
string

Password of the SMTP.

port
required
integer

Port number of the SMTP server to connect with.

encryption_method
string

It's the encryption of the email message to protect the content of the email from being read by entities other than the original recipients. None: The SMTP server doesn't require any encryption. TLS: TLS is a cryptographic protocol that provides end-to-end communications security over networks and is widely used for internet communications and online transactions. SSL: It is a layer over the plaintext communication, allowing email servers to upgrade their plaintext communication to encrypted communication.

mail_encoding
string

Select the encoding of the outgoing messages.

allow_self_signed
integer

Allow Self-signed Certificates enables the acceptance of digital certificates signed by the entity creating them, rather than a recognized certificate authority. Enabling this option permits the system to accept and validate self-signed certificates for secure connections. The value will be: 0 = No, 1 = yes.

verify_peer
integer

Verify Peer Certificate entails validating the authenticity of certificates presented by connected peers during secure communication. The value will be: 0 = No, 1 = yes.

verify_peer_name
integer

Verify Peer Name refers to the validation process that confirms the presented certificate's name against the expected peer identity during secure connections.The value will be: 0 = No, 1 = yes.

from_name
required
string

Name that the email will appear to be sent from.

from_email
required
string

The email will appear to be sent from this email address at the recipient's server. (Responsible for DKIM Authentication).

reply_email
string

The email address where you want to receive the replies from the recipients.

bounce_email
string

The email address where you want to receive the delivery reports of the failed messages. You need to add this email address to bounce addresses first.

tracking_domain
string

The domain/subdomain that appears in all hyperlinks and images.

status
required
integer

Active: Active sending nodes are ready to relay the emails, Inactive: Inactive sending nodes don't appear in the scheduling process. The value will be: 0 = Inactive, 1 = Active.

Responses

Request samples

Content type
application/json
{
  • "name": "Mumara",
  • "group_id": 21,
  • "host": "smtp.mumara.com",
  • "username": "alpha",
  • "password": "Mumara123**",
  • "port": 25,
  • "encryption_method": "ssl",
  • "mail_encoding": "8bit",
  • "allow_self_signed": 1,
  • "verify_peer": 0,
  • "verify_peer_name": 1,
  • "from_name": "alex",
  • "from_email": "alex@domain.com",
  • "reply_email": "reply@domain.com",
  • "bounce_email": "bounce@domain.com",
  • "tracking_domain": "click.domain.com",
  • "status": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "node": {
    },
  • "response": "Node has been successfully added."
}

Add-Sending-Node-MumaraOne

Add Sending Node Mumara One.

Authorizations:
BearerAuth
query Parameters
name
required
string
Example: name=Mumara

Friendly name of the sending node for identification purpose.

group_id
required
integer
Example: group_id=21

specify the Group ID in which you intend to list your sending node.

api_token
required
string
Example: api_token=your_api_token

The API key is an essential credential used for establishing connectivity with Mumara One.

from_name
required
string
Example: from_name=alex

Name that the email will appear to be sent from.

from_email
required
string
Example: from_email=alex@domain.com

The email will appear to be sent from this email address at the recipient's server. (Responsible for DKIM Authentication).

reply_email
string
Example: reply_email=reply@domain.com

The email address where you want to receive the replies from the recipients.

bounce_email
string
Example: bounce_email=bounce@domain.com

The email address where you want to receive the delivery reports of the failed messages. You need to add this email address to bounce addresses first.

tracking_domain
string
Example: tracking_domain=click.domain.com

The domain/subdomain that appears in all hyperlinks and images.

process_delivery_status
integer
Example: process_delivery_status=1

Enable it if you want to process delivery status reports for all recipients.

status
required
integer
Example: status=1

Active: Active sending nodes are ready to relay the emails, Inactive: Inactive sending nodes don't appear in the scheduling process. The value will be: 0 = Inactive, 1 = Active.

Request Body schema: application/json
required

Add Sending Node Mumara One.

name
required
string

Friendly name of the sending node for identification purpose.

group_id
required
integer

specify the Group ID in which you intend to list your sending node.

api_token
required
string

The API key is an essential credential used for establishing connectivity with Mumara One.

from_name
required
string

Name that the email will appear to be sent from.

from_email
required
string

The email will appear to be sent from this email address at the recipient's server. (Responsible for DKIM Authentication).

reply_email
string

The email address where you want to receive the replies from the recipients.

bounce_email
string

The email address where you want to receive the delivery reports of the failed messages. You need to add this email address to bounce addresses first.

tracking_domain
string

The domain/subdomain that appears in all hyperlinks and images.

process_delivery_status
integer

Enable it if you want to process delivery status reports for all recipients.

status
required
integer

Active: Active sending nodes are ready to relay the emails, Inactive: Inactive sending nodes don't appear in the scheduling process. The value will be: 0 = Inactive, 1 = Active.

Responses

Request samples

Content type
application/json
{
  • "name": "Mumara",
  • "group_id": 21,
  • "api_token": "your_api_token",
  • "from_name": "alex",
  • "from_email": "alex@domain.com",
  • "reply_email": "reply@domain.com",
  • "bounce_email": "bounce@domain.com",
  • "tracking_domain": "click.domain.com",
  • "process_delivery_status": 1,
  • "status": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "node": {
    },
  • "response": "Node has been successfully added."
}

Add-Sending-Node-Gmail

Add Sending Node Gmail.

Authorizations:
BearerAuth
query Parameters
name
required
string
Example: name=Mumara

Friendly name of the sending node for identification purpose.

group_id
required
integer
Example: group_id=21

specify the Group ID in which you intend to list your sending node.

host
required
string
Example: host=smtp.gmail.com

Hostname of the SMTP server to connect with.

username
required
string
Example: username=alpha

Username of the SMTP.

password
required
string
Example: password=Mumara123**

Password of the SMTP.

port
required
integer
Example: port=25

Port number of the SMTP server to connect with.

encryption_method
string
Example: encryption_method=ssl

It's the encryption of the email message to protect the content of the email from being read by entities other than the original recipients. None: The SMTP server doesn't require any encryption. TLS: TLS is a cryptographic protocol that provides end-to-end communications security over networks and is widely used for internet communications and online transactions. SSL: It is a layer over the plaintext communication, allowing email servers to upgrade their plaintext communication to encrypted communication.

mail_encoding
string
Example: mail_encoding=8bit

Select the encoding of the outgoing messages.

allow_self_signed
integer
Example: allow_self_signed=1

Allow Self-signed Certificates enables the acceptance of digital certificates signed by the entity creating them, rather than a recognized certificate authority. Enabling this option permits the system to accept and validate self-signed certificates for secure connections. The value will be: 0 = No, 1 = yes.

verify_peer
integer
Example: verify_peer=0

Verify Peer Certificate entails validating the authenticity of certificates presented by connected peers during secure communication. The value will be: 0 = No, 1 = yes.

verify_peer_name
integer
Example: verify_peer_name=1

Verify Peer Name refers to the validation process that confirms the presented certificate's name against the expected peer identity during secure connections.The value will be: 0 = No, 1 = yes.

from_name
required
string
Example: from_name=alex

Name that the email will appear to be sent from.

reply_email
string
Example: reply_email=reply@domain.com

The email address where you want to receive the replies from the recipients.

tracking_domain
string
Example: tracking_domain=click.domain.com

The domain/subdomain that appears in all hyperlinks and images.

status
required
integer
Example: status=1

Active: Active sending nodes are ready to relay the emails, Inactive: Inactive sending nodes don't appear in the scheduling process. The value will be: 0 = Inactive, 1 = Active.

Request Body schema: application/json
required

Add Sending Node Gmail.

name
required
string

Friendly name of the sending node for identification purpose.

group_id
required
integer

specify the Group ID in which you intend to list your sending node.

host
required
string

Hostname of the SMTP server to connect with.

username
required
string

Username of the SMTP.

password
required
string

Password of the SMTP.

port
required
integer

Port number of the SMTP server to connect with.

encryption_method
string

It's the encryption of the email message to protect the content of the email from being read by entities other than the original recipients. None: The SMTP server doesn't require any encryption. TLS: TLS is a cryptographic protocol that provides end-to-end communications security over networks and is widely used for internet communications and online transactions. SSL: It is a layer over the plaintext communication, allowing email servers to upgrade their plaintext communication to encrypted communication.

mail_encoding
string

Select the encoding of the outgoing messages.

allow_self_signed
integer

Allow Self-signed Certificates enables the acceptance of digital certificates signed by the entity creating them, rather than a recognized certificate authority. Enabling this option permits the system to accept and validate self-signed certificates for secure connections. The value will be: 0 = No, 1 = yes.

verify_peer
integer

Verify Peer Certificate entails validating the authenticity of certificates presented by connected peers during secure communication. The value will be: 0 = No, 1 = yes.

verify_peer_name
integer

Verify Peer Name refers to the validation process that confirms the presented certificate's name against the expected peer identity during secure connections.The value will be: 0 = No, 1 = yes.

from_name
required
string

Name that the email will appear to be sent from.

reply_email
string

The email address where you want to receive the replies from the recipients.

tracking_domain
string

The domain/subdomain that appears in all hyperlinks and images.

status
required
integer

Active: Active sending nodes are ready to relay the emails, Inactive: Inactive sending nodes don't appear in the scheduling process. The value will be: 0 = Inactive, 1 = Active.

Responses

Request samples

Content type
application/json
{
  • "name": "Mumara",
  • "group_id": 21,
  • "host": "smtp.gmail.com",
  • "username": "alpha",
  • "password": "Mumara123**",
  • "port": 25,
  • "encryption_method": "ssl",
  • "mail_encoding": "8bit",
  • "allow_self_signed": 1,
  • "verify_peer": 0,
  • "verify_peer_name": 1,
  • "from_name": "alex",
  • "reply_email": "reply@domain.com",
  • "tracking_domain": "click.domain.com",
  • "status": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "node": {
    },
  • "response": "Node has been successfully added."
}

Add-Sending-Node-Amazon

Add Sending Node Amazon.

Authorizations:
BearerAuth
query Parameters
name
required
string
Example: name=Amazon

Friendly name of the sending node for identification purpose.

group_id
required
integer
Example: group_id=21

specify the Group ID in which you intend to list your sending node.

access_key_id
required
string
Example: access_key_id=your_access_key_id

Access keys are long-term credentials for an IAM user or the AWS account root user.

secret_access_key
required
string
Example: secret_access_key=your_secret_access_key

Your Secret Access key that used to connect your account.

amazon_region
required
string
Example: amazon_region=us-east-2

AWS Regions are separate geographic areas that AWS uses to house its infrastructure.

config_name
required
string
Example: config_name=Mumara-Report

Configuration Set Name.

from_name
required
string
Example: from_name=alex

Name that the email will appear to be sent from.

from_email
required
string
Example: from_email=alex@domain.com

The email will appear to be sent from this email address at the recipient's server. (Responsible for DKIM Authentication).

reply_email
string
Example: reply_email=reply@domain.com

The email address where you want to receive the replies from the recipients.

bounce_email
string
Example: bounce_email=bounce@domain.com

The email address where you want to receive the delivery reports of the failed messages. You need to add this email address to bounce addresses first.

tracking_domain
string
Example: tracking_domain=click.domain.com

The domain/subdomain that appears in all hyperlinks and images.

process_delivery_status
integer
Example: process_delivery_status=1

Enable it if you want to process delivery status reports for all recipients.

status
required
integer
Example: status=1

Active: Active sending nodes are ready to relay the emails, Inactive: Inactive sending nodes don't appear in the scheduling process. The value will be: 0 = Inactive, 1 = Active.

Request Body schema: application/json
required

Add Sending Node Amazon.

name
required
string

Friendly name of the sending node for identification purpose.

group_id
required
integer

specify the Group ID in which you intend to list your sending node.

access_key_id
required
string

Access keys are long-term credentials for an IAM user or the AWS account root user.

secret_access_key
required
string

Your Secret Access key that used to connect your account.

amazon_region
required
string

AWS Regions are separate geographic areas that AWS uses to house its infrastructure.

config_name
required
string

Configuration Set Name.

from_name
required
string

Name that the email will appear to be sent from.

from_email
required
string

The email will appear to be sent from this email address at the recipient's server. (Responsible for DKIM Authentication).

reply_email
string

The email address where you want to receive the replies from the recipients.

bounce_email
string

The email address where you want to receive the delivery reports of the failed messages. You need to add this email address to bounce addresses first.

tracking_domain
string

The domain/subdomain that appears in all hyperlinks and images.

process_delivery_status
integer

Enable it if you want to process delivery status reports for all recipients.

status
required
integer

Active: Active sending nodes are ready to relay the emails, Inactive: Inactive sending nodes don't appear in the scheduling process. The value will be: 0 = Inactive, 1 = Active.

Responses

Request samples

Content type
application/json
{
  • "name": "Amazon",
  • "group_id": 21,
  • "access_key_id": "your_access_key_id",
  • "secret_access_key": "your_secret_access_key",
  • "amazon_region": "us-east-2",
  • "config_name": "Mumara-Report",
  • "from_name": "alex",
  • "from_email": "alex@domain.com",
  • "reply_email": "reply@domain.com",
  • "bounce_email": "bounce@domain.com",
  • "tracking_domain": "click.domain.com",
  • "process_delivery_status": 1,
  • "status": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "node": {
    },
  • "response": "Node has been successfully added."
}

Add-Sending-Node-AOL

Add Sending Node AOL.

Authorizations:
BearerAuth
query Parameters
name
required
string
Example: name=Mumara

Friendly name of the sending node for identification purpose.

group_id
required
integer
Example: group_id=21

specify the Group ID in which you intend to list your sending node.

host
required
string
Example: host=smtp.AOL.com

Hostname of the SMTP server to connect with.

username
required
string
Example: username=alpha

Username of the SMTP.

password
required
string
Example: password=Mumara123**

Password of the SMTP.

port
required
integer
Example: port=25

Port number of the SMTP server to connect with.

encryption_method
string
Example: encryption_method=ssl

It's the encryption of the email message to protect the content of the email from being read by entities other than the original recipients. None: The SMTP server doesn't require any encryption. TLS: TLS is a cryptographic protocol that provides end-to-end communications security over networks and is widely used for internet communications and online transactions. SSL: It is a layer over the plaintext communication, allowing email servers to upgrade their plaintext communication to encrypted communication.

mail_encoding
string
Example: mail_encoding=8bit

Select the encoding of the outgoing messages.

allow_self_signed
integer
Example: allow_self_signed=1

Allow Self-signed Certificates enables the acceptance of digital certificates signed by the entity creating them, rather than a recognized certificate authority. Enabling this option permits the system to accept and validate self-signed certificates for secure connections. The value will be: 0 = No, 1 = yes.

verify_peer
integer
Example: verify_peer=0

Verify Peer Certificate entails validating the authenticity of certificates presented by connected peers during secure communication. The value will be: 0 = No, 1 = yes.

verify_peer_name
integer
Example: verify_peer_name=1

Verify Peer Name refers to the validation process that confirms the presented certificate's name against the expected peer identity during secure connections.The value will be: 0 = No, 1 = yes.

from_name
required
string
Example: from_name=alex

Name that the email will appear to be sent from.

reply_email
string
Example: reply_email=reply@domain.com

The email address where you want to receive the replies from the recipients.

tracking_domain
string
Example: tracking_domain=click.domain.com

The domain/subdomain that appears in all hyperlinks and images.

status
required
integer
Example: status=1

Active: Active sending nodes are ready to relay the emails, Inactive: Inactive sending nodes don't appear in the scheduling process. The value will be: 0 = Inactive, 1 = Active.

Request Body schema: application/json
required

Add Sending Node AOL.

name
required
string

Friendly name of the sending node for identification purpose.

group_id
required
integer

specify the Group ID in which you intend to list your sending node.

host
required
string

Hostname of the SMTP server to connect with.

username
required
string

Username of the SMTP.

password
required
string

Password of the SMTP.

port
required
integer

Port number of the SMTP server to connect with.

encryption_method
string

It's the encryption of the email message to protect the content of the email from being read by entities other than the original recipients. None: The SMTP server doesn't require any encryption. TLS: TLS is a cryptographic protocol that provides end-to-end communications security over networks and is widely used for internet communications and online transactions. SSL: It is a layer over the plaintext communication, allowing email servers to upgrade their plaintext communication to encrypted communication.

mail_encoding
string

Select the encoding of the outgoing messages.

allow_self_signed
integer

Allow Self-signed Certificates enables the acceptance of digital certificates signed by the entity creating them, rather than a recognized certificate authority. Enabling this option permits the system to accept and validate self-signed certificates for secure connections. The value will be: 0 = No, 1 = yes.

verify_peer
integer

Verify Peer Certificate entails validating the authenticity of certificates presented by connected peers during secure communication. The value will be: 0 = No, 1 = yes.

verify_peer_name
integer

Verify Peer Name refers to the validation process that confirms the presented certificate's name against the expected peer identity during secure connections.The value will be: 0 = No, 1 = yes.

from_name
required
string

Name that the email will appear to be sent from.

reply_email
string

The email address where you want to receive the replies from the recipients.

tracking_domain
string

The domain/subdomain that appears in all hyperlinks and images.

status
required
integer

Active: Active sending nodes are ready to relay the emails, Inactive: Inactive sending nodes don't appear in the scheduling process. The value will be: 0 = Inactive, 1 = Active.

Responses

Request samples

Content type
application/json
{
  • "name": "Mumara",
  • "group_id": 21,
  • "host": "smtp.AOL.com",
  • "username": "alpha",
  • "password": "Mumara123**",
  • "port": 25,
  • "encryption_method": "ssl",
  • "mail_encoding": "8bit",
  • "allow_self_signed": 1,
  • "verify_peer": 0,
  • "verify_peer_name": 1,
  • "from_name": "alex",
  • "reply_email": "reply@domain.com",
  • "tracking_domain": "click.domain.com",
  • "status": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "node": {
    },
  • "response": "Node has been successfully added."
}

Add-Sending-Node-Elastic-Email

Add Sending Node Elastic Email.

Authorizations:
BearerAuth
query Parameters
name
required
string
Example: name=Mumara

Friendly name of the sending node for identification purpose.

group_id
required
integer
Example: group_id=21

specify the Group ID in which you intend to list your sending node.

api_token
required
string
Example: api_token=your_api_token

The API key is an essential credential used for establishing connectivity with Elastic Email.

from_name
required
string
Example: from_name=alex

Name that the email will appear to be sent from.

from_email
required
string
Example: from_email=alex@domain.com

The email will appear to be sent from this email address at the recipient's server. (Responsible for DKIM Authentication).

reply_email
string
Example: reply_email=reply@domain.com

The email address where you want to receive the replies from the recipients.

bounce_email
string
Example: bounce_email=bounce@domain.com

The email address where you want to receive the delivery reports of the failed messages. You need to add this email address to bounce addresses first.

tracking_domain
string
Example: tracking_domain=click.domain.com

The domain/subdomain that appears in all hyperlinks and images.

process_delivery_status
integer
Example: process_delivery_status=1

Enable it if you want to process delivery status reports for all recipients.

status
required
integer
Example: status=1

Active: Active sending nodes are ready to relay the emails, Inactive: Inactive sending nodes don't appear in the scheduling process. The value will be: 0 = Inactive, 1 = Active.

Request Body schema: application/json
required

Add Sending Node Elastic Email.

name
required
string

Friendly name of the sending node for identification purpose.

group_id
required
integer

specify the Group ID in which you intend to list your sending node.

api_token
required
string

The API key is an essential credential used for establishing connectivity with Elastic Email.

from_name
required
string

Name that the email will appear to be sent from.

from_email
required
string

The email will appear to be sent from this email address at the recipient's server. (Responsible for DKIM Authentication).

reply_email
string

The email address where you want to receive the replies from the recipients.

bounce_email
string

The email address where you want to receive the delivery reports of the failed messages. You need to add this email address to bounce addresses first.

tracking_domain
string

The domain/subdomain that appears in all hyperlinks and images.

process_delivery_status
integer

Enable it if you want to process delivery status reports for all recipients.

status
required
integer

Active: Active sending nodes are ready to relay the emails, Inactive: Inactive sending nodes don't appear in the scheduling process. The value will be: 0 = Inactive, 1 = Active.

Responses

Request samples

Content type
application/json
{
  • "name": "Mumara",
  • "group_id": 21,
  • "api_token": "your_api_token",
  • "from_name": "alex",
  • "from_email": "alex@domain.com",
  • "reply_email": "reply@domain.com",
  • "bounce_email": "bounce@domain.com",
  • "tracking_domain": "click.domain.com",
  • "process_delivery_status": 1,
  • "status": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "node": {
    },
  • "response": "Node has been successfully added."
}

Add-Sending-Node-Mailgun

Add Sending Node Mailgun.

Authorizations:
BearerAuth
query Parameters
name
required
string
Example: name=Mumara

Friendly name of the sending node for identification purpose.

group_id
required
integer
Example: group_id=21

specify the Group ID in which you intend to list your sending node.

api_token
required
string
Example: api_token=your_api_token

The API key is an essential credential used for establishing connectivity with Mailgun.

region
required
string
Example: region=region

Mailgun allows the ability to send and receive email in either our US region or our EU region. Be sure to use the appropriate base URL based on which region you've created your domain in.

from_name
required
string
Example: from_name=alex

Name that the email will appear to be sent from.

from_email
required
string
Example: from_email=alex@domain.com

The email will appear to be sent from this email address at the recipient's server. (Responsible for DKIM Authentication).

reply_email
string
Example: reply_email=reply@domain.com

The email address where you want to receive the replies from the recipients.

bounce_email
string
Example: bounce_email=bounce@domain.com

The email address where you want to receive the delivery reports of the failed messages. You need to add this email address to bounce addresses first.

tracking_domain
string
Example: tracking_domain=click.domain.com

The domain/subdomain that appears in all hyperlinks and images.

process_delivery_status
integer
Example: process_delivery_status=1

Enable it if you want to process delivery status reports for all recipients.

status
required
integer
Example: status=1

Active: Active sending nodes are ready to relay the emails, Inactive: Inactive sending nodes don't appear in the scheduling process. The value will be: 0 = Inactive, 1 = Active.

Request Body schema: application/json
required

Add Sending Node Mailgun.

name
required
string

Friendly name of the sending node for identification purpose.

group_id
required
integer

specify the Group ID in which you intend to list your sending node.

api_token
required
string

The API key is an essential credential used for establishing connectivity with Mailgun.

region
required
string

Mailgun allows the ability to send and receive email in either our US region or our EU region. Be sure to use the appropriate base URL based on which region you've created your domain in.

from_name
required
string

Name that the email will appear to be sent from.

from_email
required
string

The email will appear to be sent from this email address at the recipient's server. (Responsible for DKIM Authentication).

reply_email
string

The email address where you want to receive the replies from the recipients.

bounce_email
string

The email address where you want to receive the delivery reports of the failed messages. You need to add this email address to bounce addresses first.

tracking_domain
string

The domain/subdomain that appears in all hyperlinks and images.

process_delivery_status
integer

Enable it if you want to process delivery status reports for all recipients.

status
required
integer

Active: Active sending nodes are ready to relay the emails, Inactive: Inactive sending nodes don't appear in the scheduling process. The value will be: 0 = Inactive, 1 = Active.

Responses

Request samples

Content type
application/json
{
  • "name": "Mumara",
  • "group_id": 21,
  • "api_token": "your_api_token",
  • "region": "us",
  • "from_name": "alex",
  • "from_email": "alex@domain.com",
  • "reply_email": "reply@domain.com",
  • "bounce_email": "bounce@domain.com",
  • "tracking_domain": "click.domain.com",
  • "process_delivery_status": 1,
  • "status": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "node": {
    },
  • "response": "Node has been successfully added."
}

Add-Sending-Node-Mailjet

Add Sending Node Mailjet.

Authorizations:
BearerAuth
query Parameters
name
required
string
Example: name=Mumara

Friendly name of the sending node for identification purpose.

group_id
required
integer
Example: group_id=21

specify the Group ID in which you intend to list your sending node.

public_key
required
string
Example: public_key=your_public_key

Add your Mailjet public key.

secret_key
required
string
Example: secret_key=your_secret_key

Add your Mailjet secret key.

from_name
required
string
Example: from_name=alex

Name that the email will appear to be sent from.

from_email
required
string
Example: from_email=alex@domain.com

The email will appear to be sent from this email address at the recipient's server. (Responsible for DKIM Authentication).

reply_email
string
Example: reply_email=reply@domain.com

The email address where you want to receive the replies from the recipients.

bounce_email
string
Example: bounce_email=bounce@domain.com

The email address where you want to receive the delivery reports of the failed messages. You need to add this email address to bounce addresses first.

tracking_domain
string
Example: tracking_domain=click.domain.com

The domain/subdomain that appears in all hyperlinks and images.

process_delivery_status
integer
Example: process_delivery_status=1

Enable it if you want to process delivery status reports for all recipients.

status
required
integer
Example: status=1

Active: Active sending nodes are ready to relay the emails, Inactive: Inactive sending nodes don't appear in the scheduling process. The value will be: 0 = Inactive, 1 = Active.

Request Body schema: application/json
required

Add Sending Node Mailjet.

name
required
string

Friendly name of the sending node for identification purpose.

group_id
required
integer

specify the Group ID in which you intend to list your sending node.

public_key
required
string

Add your Mailjet public key.

secret_key
required
string

Add your Mailjet secret key.

from_name
required
string

Name that the email will appear to be sent from.

from_email
required
string

The email will appear to be sent from this email address at the recipient's server. (Responsible for DKIM Authentication).

reply_email
string

The email address where you want to receive the replies from the recipients.

bounce_email
string

The email address where you want to receive the delivery reports of the failed messages. You need to add this email address to bounce addresses first.

tracking_domain
string

The domain/subdomain that appears in all hyperlinks and images.

process_delivery_status
integer

Enable it if you want to process delivery status reports for all recipients.

status
required
integer

Active: Active sending nodes are ready to relay the emails, Inactive: Inactive sending nodes don't appear in the scheduling process. The value will be: 0 = Inactive, 1 = Active.

Responses

Request samples

Content type
application/json
{
  • "name": "Mumara",
  • "group_id": 21,
  • "public_key": "your_public_key",
  • "secret_key": "your_secret_key",
  • "from_name": "alex",
  • "from_email": "alex@domain.com",
  • "reply_email": "reply@domain.com",
  • "bounce_email": "bounce@domain.com",
  • "tracking_domain": "click.domain.com",
  • "process_delivery_status": 1,
  • "status": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "node": {
    },
  • "response": "Node has been successfully added."
}

Add-Sending-Node-Outlook

Add Sending Node Outlook.

Authorizations:
BearerAuth
query Parameters
name
required
string
Example: name=Mumara

Friendly name of the sending node for identification purpose.

group_id
required
integer
Example: group_id=21

specify the Group ID in which you intend to list your sending node.

host
required
string
Example: host=smtp.Outlook.com

Hostname of the SMTP server to connect with.

username
required
string
Example: username=alpha

Username of the SMTP.

password
required
string
Example: password=Mumara123**

Password of the SMTP.

port
required
integer
Example: port=25

Port number of the SMTP server to connect with.

encryption_method
string
Example: encryption_method=ssl

It's the encryption of the email message to protect the content of the email from being read by entities other than the original recipients. None: The SMTP server doesn't require any encryption. TLS: TLS is a cryptographic protocol that provides end-to-end communications security over networks and is widely used for internet communications and online transactions. SSL: It is a layer over the plaintext communication, allowing email servers to upgrade their plaintext communication to encrypted communication.

mail_encoding
string
Example: mail_encoding=8bit

Select the encoding of the outgoing messages.

allow_self_signed
integer
Example: allow_self_signed=1

Allow Self-signed Certificates enables the acceptance of digital certificates signed by the entity creating them, rather than a recognized certificate authority. Enabling this option permits the system to accept and validate self-signed certificates for secure connections. The value will be: 0 = No, 1 = yes.

verify_peer
integer
Example: verify_peer=0

Verify Peer Certificate entails validating the authenticity of certificates presented by connected peers during secure communication. The value will be: 0 = No, 1 = yes.

verify_peer_name
integer
Example: verify_peer_name=1

Verify Peer Name refers to the validation process that confirms the presented certificate's name against the expected peer identity during secure connections.The value will be: 0 = No, 1 = yes.

from_name
required
string
Example: from_name=alex

Name that the email will appear to be sent from.

reply_email
string
Example: reply_email=reply@domain.com

The email address where you want to receive the replies from the recipients.

tracking_domain
string
Example: tracking_domain=click.domain.com

The domain/subdomain that appears in all hyperlinks and images.

status
required
integer
Example: status=1

Active: Active sending nodes are ready to relay the emails, Inactive: Inactive sending nodes don't appear in the scheduling process. The value will be: 0 = Inactive, 1 = Active.

Request Body schema: application/json
required

Add Sending Node Outlook.

name
required
string

Friendly name of the sending node for identification purpose.

group_id
required
integer

specify the Group ID in which you intend to list your sending node.

host
required
string

Hostname of the SMTP server to connect with.

username
required
string

Username of the SMTP.

password
required
string

Password of the SMTP.

port
required
integer

Port number of the SMTP server to connect with.

encryption_method
string

It's the encryption of the email message to protect the content of the email from being read by entities other than the original recipients. None: The SMTP server doesn't require any encryption. TLS: TLS is a cryptographic protocol that provides end-to-end communications security over networks and is widely used for internet communications and online transactions. SSL: It is a layer over the plaintext communication, allowing email servers to upgrade their plaintext communication to encrypted communication.

mail_encoding
string

Select the encoding of the outgoing messages.

allow_self_signed
integer

Allow Self-signed Certificates enables the acceptance of digital certificates signed by the entity creating them, rather than a recognized certificate authority. Enabling this option permits the system to accept and validate self-signed certificates for secure connections. The value will be: 0 = No, 1 = yes.

verify_peer
integer

Verify Peer Certificate entails validating the authenticity of certificates presented by connected peers during secure communication. The value will be: 0 = No, 1 = yes.

verify_peer_name
integer

Verify Peer Name refers to the validation process that confirms the presented certificate's name against the expected peer identity during secure connections.The value will be: 0 = No, 1 = yes.

from_name
required
string

Name that the email will appear to be sent from.

reply_email
string

The email address where you want to receive the replies from the recipients.

tracking_domain
string

The domain/subdomain that appears in all hyperlinks and images.

status
required
integer

Active: Active sending nodes are ready to relay the emails, Inactive: Inactive sending nodes don't appear in the scheduling process. The value will be: 0 = Inactive, 1 = Active.

Responses

Request samples

Content type
application/json
{
  • "name": "Mumara",
  • "group_id": 21,
  • "host": "smtp.Outlook.com",
  • "username": "alpha",
  • "password": "Mumara123**",
  • "port": 25,
  • "encryption_method": "ssl",
  • "mail_encoding": "8bit",
  • "allow_self_signed": 1,
  • "verify_peer": 0,
  • "verify_peer_name": 1,
  • "from_name": "alex",
  • "reply_email": "reply@domain.com",
  • "tracking_domain": "click.domain.com",
  • "status": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "node": {
    },
  • "response": "Node has been successfully added."
}

Add-Sending-Node-PostMark

Add Sending Node PostMark.

Authorizations:
BearerAuth
query Parameters
name
required
string
Example: name=Mumara

Friendly name of the sending node for identification purpose.

group_id
required
integer
Example: group_id=21

specify the Group ID in which you intend to list your sending node.

api_token
required
string
Example: api_token=your_api_token

The API key is an essential credential used for establishing connectivity with PostMark.

from_name
required
string
Example: from_name=alex

Name that the email will appear to be sent from.

from_email
required
string
Example: from_email=alex@domain.com

The email will appear to be sent from this email address at the recipient's server. (Responsible for DKIM Authentication).

reply_email
string
Example: reply_email=reply@domain.com

The email address where you want to receive the replies from the recipients.

bounce_email
string
Example: bounce_email=bounce@domain.com

The email address where you want to receive the delivery reports of the failed messages. You need to add this email address to bounce addresses first.

tracking_domain
string
Example: tracking_domain=click.domain.com

The domain/subdomain that appears in all hyperlinks and images.

process_delivery_status
integer
Example: process_delivery_status=1

Enable it if you want to process delivery status reports for all recipients.

status
required
integer
Example: status=1

Active: Active sending nodes are ready to relay the emails, Inactive: Inactive sending nodes don't appear in the scheduling process. The value will be: 0 = Inactive, 1 = Active.

Request Body schema: application/json
required

Add Sending Node PostMark.

name
required
string

Friendly name of the sending node for identification purpose.

group_id
required
integer

specify the Group ID in which you intend to list your sending node.

api_token
required
string

The API key is an essential credential used for establishing connectivity with PostMark.

from_name
required
string

Name that the email will appear to be sent from.

from_email
required
string

The email will appear to be sent from this email address at the recipient's server. (Responsible for DKIM Authentication).

reply_email
string

The email address where you want to receive the replies from the recipients.

bounce_email
string

The email address where you want to receive the delivery reports of the failed messages. You need to add this email address to bounce addresses first.

tracking_domain
string

The domain/subdomain that appears in all hyperlinks and images.

process_delivery_status
integer

Enable it if you want to process delivery status reports for all recipients.

status
required
integer

Active: Active sending nodes are ready to relay the emails, Inactive: Inactive sending nodes don't appear in the scheduling process. The value will be: 0 = Inactive, 1 = Active.

Responses

Request samples

Content type
application/json
{
  • "name": "Mumara",
  • "group_id": 21,
  • "api_token": "your_api_token",
  • "from_name": "alex",
  • "from_email": "alex@domain.com",
  • "reply_email": "reply@domain.com",
  • "bounce_email": "bounce@domain.com",
  • "tracking_domain": "click.domain.com",
  • "process_delivery_status": 1,
  • "status": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "node": {
    },
  • "response": "Node has been successfully added."
}

Add-Sending-Node-Sendgrid

Add Sending Node Sendgrid.

Authorizations:
BearerAuth
query Parameters
name
required
string
Example: name=Mumara

Friendly name of the sending node for identification purpose.

group_id
required
integer
Example: group_id=21

specify the Group ID in which you intend to list your sending node.

api_token
required
string
Example: api_token=your_api_token

The API key is an essential credential used for establishing connectivity with Sendgrid.

from_name
required
string
Example: from_name=alex

Name that the email will appear to be sent from.

from_email
required
string
Example: from_email=alex@domain.com

The email will appear to be sent from this email address at the recipient's server. (Responsible for DKIM Authentication).

reply_email
string
Example: reply_email=reply@domain.com

The email address where you want to receive the replies from the recipients.

bounce_email
string
Example: bounce_email=bounce@domain.com

The email address where you want to receive the delivery reports of the failed messages. You need to add this email address to bounce addresses first.

tracking_domain
string
Example: tracking_domain=click.domain.com

The domain/subdomain that appears in all hyperlinks and images.

process_delivery_status
integer
Example: process_delivery_status=1

Enable it if you want to process delivery status reports for all recipients.

status
required
integer
Example: status=1

Active: Active sending nodes are ready to relay the emails, Inactive: Inactive sending nodes don't appear in the scheduling process. The value will be: 0 = Inactive, 1 = Active.

Request Body schema: application/json
required

Add Sending Node Sendgrid.

name
required
string

Friendly name of the sending node for identification purpose.

group_id
required
integer

specify the Group ID in which you intend to list your sending node.

api_token
required
string

The API key is an essential credential used for establishing connectivity with Sendgrid.

from_name
required
string

Name that the email will appear to be sent from.

from_email
required
string

The email will appear to be sent from this email address at the recipient's server. (Responsible for DKIM Authentication).

reply_email
string

The email address where you want to receive the replies from the recipients.

bounce_email
string

The email address where you want to receive the delivery reports of the failed messages. You need to add this email address to bounce addresses first.

tracking_domain
string

The domain/subdomain that appears in all hyperlinks and images.

process_delivery_status
integer

Enable it if you want to process delivery status reports for all recipients.

status
required
integer

Active: Active sending nodes are ready to relay the emails, Inactive: Inactive sending nodes don't appear in the scheduling process. The value will be: 0 = Inactive, 1 = Active.

Responses

Request samples

Content type
application/json
{
  • "name": "Mumara",
  • "group_id": 21,
  • "api_token": "your_api_token",
  • "from_name": "alex",
  • "from_email": "alex@domain.com",
  • "reply_email": "reply@domain.com",
  • "bounce_email": "bounce@domain.com",
  • "tracking_domain": "click.domain.com",
  • "process_delivery_status": 1,
  • "status": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "node": {
    },
  • "response": "Node has been successfully added."
}

Add-Sending-Node-SMTP2Go

Add Sending Node SMTP2Go.

Authorizations:
BearerAuth
query Parameters
name
required
string
Example: name=Mumara

Friendly name of the sending node for identification purpose.

group_id
required
integer
Example: group_id=21

specify the Group ID in which you intend to list your sending node.

api_token
required
string
Example: api_token=your_api_token

The API key is an essential credential used for establishing connectivity with SMTP2Go.

from_name
required
string
Example: from_name=alex

Name that the email will appear to be sent from.

from_email
required
string
Example: from_email=alex@domain.com

The email will appear to be sent from this email address at the recipient's server. (Responsible for DKIM Authentication).

reply_email
string
Example: reply_email=reply@domain.com

The email address where you want to receive the replies from the recipients.

bounce_email
string
Example: bounce_email=bounce@domain.com

The email address where you want to receive the delivery reports of the failed messages. You need to add this email address to bounce addresses first.

tracking_domain
string
Example: tracking_domain=click.domain.com

The domain/subdomain that appears in all hyperlinks and images.

process_delivery_status
integer
Example: process_delivery_status=1

Enable it if you want to process delivery status reports for all recipients.

status
required
integer
Example: status=1

Active: Active sending nodes are ready to relay the emails, Inactive: Inactive sending nodes don't appear in the scheduling process. The value will be: 0 = Inactive, 1 = Active.

Request Body schema: application/json
required

Add Sending Node SMTP2Go.

name
required
string

Friendly name of the sending node for identification purpose.

group_id
required
integer

specify the Group ID in which you intend to list your sending node.

api_token
required
string

The API key is an essential credential used for establishing connectivity with SMTP2Go.

from_name
required
string

Name that the email will appear to be sent from.

from_email
required
string

The email will appear to be sent from this email address at the recipient's server. (Responsible for DKIM Authentication).

reply_email
string

The email address where you want to receive the replies from the recipients.

bounce_email
string

The email address where you want to receive the delivery reports of the failed messages. You need to add this email address to bounce addresses first.

tracking_domain
string

The domain/subdomain that appears in all hyperlinks and images.

process_delivery_status
integer

Enable it if you want to process delivery status reports for all recipients.

status
required
integer

Active: Active sending nodes are ready to relay the emails, Inactive: Inactive sending nodes don't appear in the scheduling process. The value will be: 0 = Inactive, 1 = Active.

Responses

Request samples

Content type
application/json
{
  • "name": "Mumara",
  • "group_id": 21,
  • "api_token": "your_api_token",
  • "from_name": "alex",
  • "from_email": "alex@domain.com",
  • "reply_email": "reply@domain.com",
  • "bounce_email": "bounce@domain.com",
  • "tracking_domain": "click.domain.com",
  • "process_delivery_status": 1,
  • "status": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "node": {
    },
  • "response": "Node has been successfully added."
}

Add-Sending-Node-Sparkpost

Add Sending Node Sparkpost.

Authorizations:
BearerAuth
query Parameters
name
required
string
Example: name=Mumara

Friendly name of the sending node for identification purpose.

group_id
required
integer
Example: group_id=21

specify the Group ID in which you intend to list your sending node.

api_token
required
string
Example: api_token=your_api_token

The API key is an essential credential used for establishing connectivity with Sparkpost.

region
required
string
Example: region=region

Sparkpost allows the ability to send and receive email in either our US region or our EU region. Be sure to use the appropriate base URL based on which region you've created your domain in.

from_name
required
string
Example: from_name=alex

Name that the email will appear to be sent from.

from_email
required
string
Example: from_email=alex@domain.com

The email will appear to be sent from this email address at the recipient's server. (Responsible for DKIM Authentication).

reply_email
string
Example: reply_email=reply@domain.com

The email address where you want to receive the replies from the recipients.

bounce_email
string
Example: bounce_email=bounce@domain.com

The email address where you want to receive the delivery reports of the failed messages. You need to add this email address to bounce addresses first.

tracking_domain
string
Example: tracking_domain=click.domain.com

The domain/subdomain that appears in all hyperlinks and images.

process_delivery_status
integer
Example: process_delivery_status=1

Enable it if you want to process delivery status reports for all recipients.

status
required
integer
Example: status=1

Active: Active sending nodes are ready to relay the emails, Inactive: Inactive sending nodes don't appear in the scheduling process. The value will be: 0 = Inactive, 1 = Active.

Request Body schema: application/json
required

Add Sending Node Sparkpost.

name
required
string

Friendly name of the sending node for identification purpose.

group_id
required
integer

specify the Group ID in which you intend to list your sending node.

api_token
required
string

The API key is an essential credential used for establishing connectivity with Sparkpost.

region
required
string

Sparkpost allows the ability to send and receive email in either our US region or our EU region. Be sure to use the appropriate base URL based on which region you've created your domain in.

from_name
required
string

Name that the email will appear to be sent from.

from_email
required
string

The email will appear to be sent from this email address at the recipient's server. (Responsible for DKIM Authentication).

reply_email
string

The email address where you want to receive the replies from the recipients.

bounce_email
string

The email address where you want to receive the delivery reports of the failed messages. You need to add this email address to bounce addresses first.

tracking_domain
string

The domain/subdomain that appears in all hyperlinks and images.

process_delivery_status
integer

Enable it if you want to process delivery status reports for all recipients.

status
required
integer

Active: Active sending nodes are ready to relay the emails, Inactive: Inactive sending nodes don't appear in the scheduling process. The value will be: 0 = Inactive, 1 = Active.

Responses

Request samples

Content type
application/json
{
  • "name": "Mumara",
  • "group_id": 21,
  • "api_token": "your_api_token",
  • "region": "us",
  • "from_name": "alex",
  • "from_email": "alex@domain.com",
  • "reply_email": "reply@domain.com",
  • "bounce_email": "bounce@domain.com",
  • "tracking_domain": "click.domain.com",
  • "process_delivery_status": 1,
  • "status": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "node": {
    },
  • "response": "Node has been successfully added."
}

Add-Sending-Node-Yahoo

Add Sending Node Yahoo.

Authorizations:
BearerAuth
query Parameters
name
required
string
Example: name=Mumara

Friendly name of the sending node for identification purpose.

group_id
required
integer
Example: group_id=21

specify the Group ID in which you intend to list your sending node.

host
required
string
Example: host=smtp.Yahoo.com

Hostname of the SMTP server to connect with.

username
required
string
Example: username=alpha

Username of the SMTP.

password
required
string
Example: password=Mumara123**

Password of the SMTP.

port
required
integer
Example: port=25

Port number of the SMTP server to connect with.

encryption_method
string
Example: encryption_method=ssl

It's the encryption of the email message to protect the content of the email from being read by entities other than the original recipients. None: The SMTP server doesn't require any encryption. TLS: TLS is a cryptographic protocol that provides end-to-end communications security over networks and is widely used for internet communications and online transactions. SSL: It is a layer over the plaintext communication, allowing email servers to upgrade their plaintext communication to encrypted communication.

mail_encoding
string
Example: mail_encoding=8bit

Select the encoding of the outgoing messages.

allow_self_signed
integer
Example: allow_self_signed=1

Allow Self-signed Certificates enables the acceptance of digital certificates signed by the entity creating them, rather than a recognized certificate authority. Enabling this option permits the system to accept and validate self-signed certificates for secure connections. The value will be: 0 = No, 1 = yes.

verify_peer
integer
Example: verify_peer=0

Verify Peer Certificate entails validating the authenticity of certificates presented by connected peers during secure communication. The value will be: 0 = No, 1 = yes.

verify_peer_name
integer
Example: verify_peer_name=1

Verify Peer Name refers to the validation process that confirms the presented certificate's name against the expected peer identity during secure connections.The value will be: 0 = No, 1 = yes.

from_name
required
string
Example: from_name=alex

Name that the email will appear to be sent from.

reply_email
string
Example: reply_email=reply@domain.com

The email address where you want to receive the replies from the recipients.

tracking_domain
string
Example: tracking_domain=click.domain.com

The domain/subdomain that appears in all hyperlinks and images.

status
required
integer
Example: status=1

Active: Active sending nodes are ready to relay the emails, Inactive: Inactive sending nodes don't appear in the scheduling process. The value will be: 0 = Inactive, 1 = Active.

Request Body schema: application/json
required

Add Sending Node Yahoo.

name
required
string

Friendly name of the sending node for identification purpose.

group_id
required
integer

specify the Group ID in which you intend to list your sending node.

host
required
string

Hostname of the SMTP server to connect with.

username
required
string

Username of the SMTP.

password
required
string

Password of the SMTP.

port
required
integer

Port number of the SMTP server to connect with.

encryption_method
string

It's the encryption of the email message to protect the content of the email from being read by entities other than the original recipients. None: The SMTP server doesn't require any encryption. TLS: TLS is a cryptographic protocol that provides end-to-end communications security over networks and is widely used for internet communications and online transactions. SSL: It is a layer over the plaintext communication, allowing email servers to upgrade their plaintext communication to encrypted communication.

mail_encoding
string

Select the encoding of the outgoing messages.

allow_self_signed
integer

Allow Self-signed Certificates enables the acceptance of digital certificates signed by the entity creating them, rather than a recognized certificate authority. Enabling this option permits the system to accept and validate self-signed certificates for secure connections. The value will be: 0 = No, 1 = yes.

verify_peer
integer

Verify Peer Certificate entails validating the authenticity of certificates presented by connected peers during secure communication. The value will be: 0 = No, 1 = yes.

verify_peer_name
integer

Verify Peer Name refers to the validation process that confirms the presented certificate's name against the expected peer identity during secure connections.The value will be: 0 = No, 1 = yes.

from_name
required
string

Name that the email will appear to be sent from.

reply_email
string

The email address where you want to receive the replies from the recipients.

tracking_domain
string

The domain/subdomain that appears in all hyperlinks and images.

status
required
integer

Active: Active sending nodes are ready to relay the emails, Inactive: Inactive sending nodes don't appear in the scheduling process. The value will be: 0 = Inactive, 1 = Active.

Responses

Request samples

Content type
application/json
{
  • "name": "Mumara",
  • "group_id": 21,
  • "host": "smtp.Yahoo.com",
  • "username": "alpha",
  • "password": "Mumara123**",
  • "port": 25,
  • "encryption_method": "ssl",
  • "mail_encoding": "8bit",
  • "allow_self_signed": 1,
  • "verify_peer": 0,
  • "verify_peer_name": 1,
  • "from_name": "alex",
  • "reply_email": "reply@domain.com",
  • "tracking_domain": "click.domain.com",
  • "status": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "node": {
    },
  • "response": "Node has been successfully added."
}

Get-Sending-Node

Get Sending Node

Authorizations:
BearerAuth
path Parameters
id
required
integer
Example: 10

Sending Node ID.

Responses

Request samples 

curl -X DELETE https://demo.campaigns.mumara.com/api/getSendingNode/{id} \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": {
    }
}

Get-Sending-Nodes

Get Sending Nodes.

Authorizations:
BearerAuth
query Parameters
user_id
integer
Example: user_id=2

Get Sending Nodes of a particular user.

limit_start
integer
Example: limit_start=1

Starting row of result. Default: 0.

limit_count
integer
Example: limit_count=25

Number of records to get. Default: 25.

Responses

Request samples 

curl -X GET -G https://demo.campaigns.mumara.com/api/getSendingNodes \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
-d {
     "user_id":"2"  \
     "limit_start":"1"  \
     "limit_count":"25"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": [
    ]
}

Update-Sending-Node

Update Sending Node.

Authorizations:
BearerAuth
query Parameters
name
string
Example: name=Mumara SMTP

Friendly name of the sending node for identification purpose.

group_id
integer
Example: group_id=21

specify the Group ID in which you intend to list your sending node.

host
string
Example: host=smtp.mumara.com

Hostname of the SMTP server to connect with.

username
string
Example: username=admin@mumara.com

Username.

password
string
Example: password=Mumara123**

Password required to connect.

api_key
string
Example: api_key=api_key

Required only for certain ESPs such as Mumara One, Elastic Email, and others.

region
string
Example: region=US

Required only for certain ESPs such as Mailgun, Sparkpost, and others.

access_key_id
string
Example: access_key_id=your_access_key_id

Required only for Amazon SES.

secret_access_key
string
Example: secret_access_key=your_secret_access_key

Required only for Amazon SES.

amazon_region
string
Example: amazon_region=us-east-2

Required only for Amazon SES.

from_name
string
Example: from_name=alex

Name that the email will appear to be sent from.

from_email
string
Example: from_email=alex@domain.com

The email will appear to be sent from this email address at the recipient's server. (Responsible for DKIM Authentication).

reply_email
string
Example: reply_email=reply@domain.com

The email address where you want to receive the replies from the recipients.

bounce_email
string
Example: bounce_email=bounce@domain.com

The email address where you want to receive the delivery reports of the failed messages. You need to add this email address to bounce addresses first.

tracking_domain
string
Example: tracking_domain=click.domain.com

The domain/subdomain that appears in all hyperlinks and images.

process_delivery_status
integer
Example: process_delivery_status=1

Enable it if you want to process delivery status reports for all recipients.

status
required
integer
Example: status=1

Active: Active sending nodes are ready to relay the emails, Inactive: Inactive sending nodes don't appear in the scheduling process. The value will be: 0 = Inactive, 1 = Active.

Request Body schema: application/json
required

Update Sending Node.

name
string

Friendly name of the sending node for identification purpose.

group_id
integer

specify the Group ID in which you intend to list your sending node.

host
string

Hostname of the SMTP server to connect with.

username
string

Username.

password
string

Password required to connect.

api_key
string

Required only for certain ESPs such as Mumara One, Elastic Email, and others.

region
string

Required only for certain ESPs such as Mailgun, Sparkpost, and others.

access_key_id
string

Required only for Amazon SES.

secret_access_key
string

Required only for Amazon SES.

amazon_region
string

Required only for Amazon SES.

from_name
string

Name that the email will appear to be sent from.

from_email
string

The email will appear to be sent from this email address at the recipient's server. (Responsible for DKIM Authentication).

reply_email
string

The email address where you want to receive the replies from the recipients.

bounce_email
string

The email address where you want to receive the delivery reports of the failed messages. You need to add this email address to bounce addresses first.

tracking_domain
string

The domain/subdomain that appears in all hyperlinks and images.

process_delivery_status
integer

Enable it if you want to process delivery status reports for all recipients.

status
required
integer

Active: Active sending nodes are ready to relay the emails, Inactive: Inactive sending nodes don't appear in the scheduling process. The value will be: 0 = Inactive, 1 = Active.

Responses

Request samples

Content type
application/json
{
  • "name": "Mumara",
  • "group_id": 21,
  • "host": "smtp.mumara.com",
  • "username": "alpha",
  • "password": "Mumara123**",
  • "port": 25,
  • "encryption_method": "ssl",
  • "mail_encoding": "8bit",
  • "allow_self_signed": 1,
  • "verify_peer": 0,
  • "verify_peer_name": 1,
  • "from_name": "alex",
  • "from_email": "alex@domain.com",
  • "reply_email": "reply@domain.com",
  • "bounce_email": "bounce@domain.com",
  • "tracking_domain": "click.domain.com",
  • "status": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "node": {
    },
  • "result": "node updated"
}

Delete-Sending-Nodes

Delete Sending Nodes.

Authorizations:
BearerAuth
path Parameters
id
required
integer
Example: 10

Sending Node ID(s) to be deleted.

Responses

Request samples 

curl -X DELETE https://demo.campaigns.mumara.com/api/deleteSendingNodes/{id} \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \

Response samples

Content type
application/json
{
  • "status": "success",
  • "response": "A sending nodes has been successfully deleted."
}

Trigger

Add-a-Trigger

Add a Trigger.

Authorizations:
BearerAuth
query Parameters
name
required
string
Example: name=Welcome trigger

Name of the trigger you're adding.

event_type
required
integer
Example: event_type=2

Event type must be one of these values (1,2,3) where 1 = when a contact is added to list, 2 = when a contact is added to a segment, 3 = when a field value changed.

adding_method
string
Example: adding_method=manual

If you select event_type -> 1 then this field is required. The adding method must be one of these values (manual, api, import, webform, all), Where manual = Subscriber is manually added to a list, api = Subscriber is added via API, import = Subscriber is imported to a list, webform = Subscriber is added via web form, all = Apply all.

segment_ids
integer
Example: segment_ids=32

If you select event_type 2 then this field is required. The ID of the segment which will be linked with the trigger.

list_type
string
Example: list_type=custom

If you select event_type -> 1 then this field is required. list type must be one of these values (all, custom), Where all = any list, custom = selected lists.

list_ids
integer
Example: list_ids=3

If you select event_type 1 then this field is required. The ID of the single or multiple lists will be linked with the trigger.

when_to_send
required
string
Example: when_to_send=on_event

When to send must be one of these values (on_event, after), where on_event = instant trigger fire, after = trigger fire later i.e. specific time.

trigger_action
required
string
Example: trigger_action=send_notify_to_admin

Trigger action must be one of these values (send_broadcast, send_notify_to_admin, start_drip_group, change_contact_status, change_contact_format, update_field, move_contact, copy_contact, remove_contact, add_to_suppression)

time_frequency
string
Example: time_frequency=hours

If you select after in 'when_to_send' this field is required. The value of time frequency must be one of these values (minutes, hours, days, weeks, months, years).

time_duration
integer
Example: time_duration=23

If you select after in “when_to_send' this field is required. The time duration must be an integer.

suppression_type
string
Example: suppression_type=global

If you select add_to_suppression in “trigger_action” then this field is required. Suppression type must be one of these values (global, list), where global = all list, list = specific list.

list_id
integer
Example: list_id=43

If you select: move_contact, copy_contact, remove_contact, add_to_suppression, in “trigger_action” then this field is required. The ID of the list.

action_for_duplicate
integer
Example: action_for_duplicate=1

The action for duplicate must be one of these values (1,2,3) where 1 = Skip duplicate, 2 = Overwrite duplicate, 3 = Update duplicate.

move_recursively
integer
Example: move_recursively=0

The value of move_recursively must be one of these values (1,0).

custom_field
string
Example: custom_field=first_name

Tag name of the custom field.

custom_field_value
string
Example: custom_field_value=Adrian

Value of the custom field.

contact_format
string
Example: contact_format=html

The value of contact_format must be one of these values (html, text).

contact_status
string
Example: contact_status=active

The value of contact_status must be one of these values (active, inactive).

drip_group_id
integer
Example: drip_group_id=8

Provide drip group id.

subject
string
Example: subject=Forget Password

Subject of the email in case of sending notification to admin.

content_html
string
Example: content_html=<html><head><title></title></head><body>send_notify_to_admin</body></html>

HTML content of the email in case of sending notification to admin.

to_email
string
Example: to_email=toemail@domain.com

This is the email address where the admin gets a notification email when a user is added to the list

remove_recursively
integer
Example: remove_recursively=0

By selecting this option, the trigger will not just find the newly qualified contacts but it will run recursively on all contacts of the selected lists

trigger_campaign
integer
Example: trigger_campaign=43

In case of ‘Send a Broadcast’ provide broadcast ID.

smtp_ids
integer
Example: smtp_ids=9

Provide SMTP ID.

sender_option
string
Example: sender_option=list

Sender option must be one of these values: list, custom, smtp.

track_open
integer
Example: track_open=1

To track opens these values must be used (1,0).

track_click
integer
Example: track_click=0

To track clicks these values must be used (1,0).

unsubscribe_link
integer
Example: unsubscribe_link=1

To insert unsubscribe links these values must be used (1,0).

skip_unconfirmed
integer
Example: skip_unconfirmed=1

To skip unconfirmed emails these values must be used (1,0).

from_name
string
Example: from_name=john

From name is required if you select custom in 'sender_option'.

from_email
string
Example: from_email=from@domain.com

From email is required if you select custom in 'sender_option'.

bounce_email
string
Example: bounce_email=bounce@domain.com

Bounce email is required if you select custom in 'sender_option'.

reply_email
string
Example: reply_email=reply@domain.com

Reply email is required if you select custom in 'sender_option'.

field_type
string
Example: field_type=specific

Field type must be one of these values(any, specific).

when_values_is
string
Example: when_values_is=any

When values are must be one of these values(any, specific).

value
string
Example: value=Charles

Value of the custom field.

status
integer
Example: status=1

To keep the trigger enabled/disabled status must be one of these values (1,0).

Request Body schema: application/json
required

Add a Trigger.

name
required
string

Name of the trigger you're adding.

event_type
required
integer

Event type must be one of these values (1,2,3) where 1 = when a contact is added to list, 2 = when a contact is added to a segment, 3 = when a field value changed

adding_method
string

If you select event_type -> 1 then this field is required. The adding method must be one of these values (manual, api, import, webform, all), Where manual = Subscriber is manually added to a list, api = Subscriber is added via API, import = Subscriber is imported to a list, webform = Subscriber is added via web form, all = Apply all

segment_ids
integer

If you select event_type 2 then this field is required. The ID of the segment which will be linked with the trigger.

list_type
string

If you select event_type -> 1 then this field is required. list type must be one of these values (all, custom), Where all = any list, custom = selected lists.

list_ids
integer

If you select event_type 1 then this field is required. The ID of the single or multiple lists will be linked with the trigger.

when_to_send
required
string

When to send must be one of these values (on_event, after), where on_event = instant trigger fire, after = trigger fire later i.e. specific time.

trigger_action
required
string

Trigger action must be one of these values (send_broadcast, send_notify_to_admin, start_drip_group, change_contact_status, change_contact_format, update_field, move_contact, copy_contact, remove_contact, add_to_suppression)

time_frequency
string

If you select after in 'when_to_send' this field is required. The value of time frequency must be one of these values (minutes, hours, days, weeks, months, years)

time_duration
integer

If you select after in 'when_to_send' this field is required. The time duration must be an integer.

suppression_type
string

If you select add_to_suppression in “trigger_action” then this field is required. Suppression type must be one of these values (global, list), where global = all list, list = specific list.

list_id
integer

If you select: move_contact, copy_contact, remove_contact, add_to_suppression, in “trigger_action” then this field is required. The ID of the list.

action_for_duplicate
integer

The action for duplicate must be one of these values (1,2,3) where 1 = Skip duplicate, 2 = Overwrite duplicate, 3 = Update duplicate

move_recursively
integer

The value of move_recursively must be one of these values (1,0).

custom_field
string

Tag name of the custom field.

custom_field_value
string

Value of the custom field.

contact_format
string

The value of contact_format must be one of these values (html, text).

contact_status
string

The value of contact_status must be one of these values (active, inactive).

drip_group_id
integer

Provide drip group id.

subject
string

Subject of the email in case of sending notification to admin.

content_html
string

HTML content of the email in case of sending notification to admin.

to_email
string

This is the email address where the admin gets a notification email when a user is added to the list

remove_recursively
integer

By selecting this option, the trigger will not just find the newly qualified contacts but it will run recursively on all contacts of the selected lists

trigger_campaign
integer

In case of ‘Send a Broadcast’ provide broadcast ID.

smtp_ids
integer

Provide SMTP ID.

sender_option
string

Sender option must be one of these values: list, custom, smtp.

track_open
integer

To track opens these values must be used (1,0).

track_click
integer

To track clicks these values must be used (1,0).

unsubscribe_link
integer

To insert unsubscribe links these values must be used (1,0).

skip_unconfirmed
integer

To skip unconfirmed emails these values must be used (1,0).

from_name
string

From name is required if you select custom in 'sender_option'.

from_email
string

From email is required if you select custom in 'sender_option'.

bounce_email
string

Bounce email is required if you select custom in 'sender_option'.

reply_email
string

Reply email is required if you select custom in 'sender_option'.

field_type
string

Field type must be one of these values(any, specific).

when_values_is
string

When values are must be one of these values(any, specific).

value
string

Value of the custom field.

status
integer

To keep the trigger enabled/disabled status must be one of these values (1,0).

Responses

Request samples

Content type
application/json
{
  • "name": "New contact welcome trigger",
  • "event_type": "1",
  • "adding_method": "all",
  • "list_type": "all",
  • "list_ids": "2416",
  • "when_to_send": "on_event",
  • "trigger_action": "send_broadcast",
  • "trigger_campaign": "223",
  • "smtp_ids": "54",
  • "sender_option": "smtp",
  • "track_open": "1",
  • "track_click": "1",
  • "unsubscribe_link": "0",
  • "skip_unconfirmed": "1",
  • "status": "1"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Trigger has been successfully scheduled"
}

Get-Triggers

Get Triggers.

Authorizations:
BearerAuth
query Parameters
id
integer
Example: id=12

Trigger id which you want to get.

user_id
integer
Example: user_id=2

Get Triggers of a particular user.

limit_start
integer
Example: limit_start=1

Starting row of result. Default: 0.

limit_count
integer
Example: limit_count=25

Number of records to get. Default: 25.

Responses

Request samples 

curl -X GET -G https://demo.campaigns.mumara.com/api/getTriggers \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
-d {
     "id":"12"  \
     "user_id":"2"  \
     "limit_start":"1"  \
     "limit_count":"25"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "result": [
    ]
}

Delete-Trigger

Delete Trigger.

Authorizations:
BearerAuth
path Parameters
id
required
integer
Example: 10

Trigger ID(s) to be deleted.

Responses

Request samples 

curl -X DELETE https://demo.campaigns.mumara.com/api/deleteTriggers/{id} \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \

Response samples

Content type
application/json
{
  • "status": "success",
  • "response": "A trigger has been successfully deleted."
}

Drip Campaigns

Get-Drip-Campaigns-Auto-Follow-ups

Get Drip Campaigns/Auto Follow-ups.

Authorizations:
BearerAuth
query Parameters
id
integer
Example: id=12

Drip id which you want to get.

user_id
integer
Example: user_id=2

Get Drips of a particular user.

limit_start
integer
Example: limit_start=1

Starting row of result. Default: 0.

limit_count
integer
Example: limit_count=25

Number of records to get. Default: 25.

Responses

Request samples 

curl -X GET -G https://demo.campaigns.mumara.com/api/getDrips \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
-d {
     "id":"12"  \
     "user_id":"2"  \
     "limit_start":"1"  \
     "limit_count":"25"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "response": [
    ]
}

Add-a-Drip-Auto-Follow-ups

Add a Drip/Auto-Follow-ups.

Authorizations:
BearerAuth
query Parameters
user_id
integer
Example: user_id=4

ID of the user where you want to add a Drip.

name
required
string
Example: name=New User Drip

Name of the Drip you're adding.

group_id
required
integer
Example: group_id=5

Provide the Drip Group ID

when_to_start
required
string
Example: when_to_start=after

When to send must be one of these values (on_event, after), where on_event = instant schedule drip, after = schedule drip later i.e. specific time.

time_frequency
string
Example: time_frequency=days

Value of time frequency must be one of these values (minutes,hours,days,weeks,months,years).

time_duration
integer
Example: time_duration=45

If you select after in 'when_to_start' this field is required. The time duration must be an integer.

subject
required
string
Example: subject=this is drip campaign subject

Email subject of this Drip.

content_html
required
string
Example: content_html=<p>Rush to the stores and get 70% discount on your next purchase.</p>

HTML content for the drip.

content_text
required
string
Example: content_text=Rush to the stores and get 70% discount on your next purchase

Text content for the drip.

status
integer
Example: status=1

To keep the Drip enabled/disabled status must be one of these values (1,0).

Request Body schema: application/json
required

Add a Drip.

user_id
integer

ID of the user where you want to add a Drip

name
required
string

Name of the Drip you're adding.

group_id
required
integer

Provide the Drip Group ID

when_to_start
required
string

When to send must be one of these values (on_event, after), where on_event = instant schedule drip, after = schedule drip later i.e. specific time.

time_frequency
string

Value of time frequency must be one of these values (minutes,hours,days,weeks,months,years).

time_duration
integer

If you select after in 'when_to_start' this field is required. The time duration must be an integer.

subject
required
string

Email subject of this Drip.

content_html
required
string

HTML content for the drip.

content_text
required
string

Text content for the drip.

status
integer

To keep the Drip enabled/disabled status must be one of these values (1,0).

Responses

Request samples

Content type
application/json
{
  • "user_id": 4,
  • "name": "New User Drip",
  • "group_id": 5,
  • "when_to_start": "after",
  • "time_frequency": "days",
  • "time_duration": 45,
  • "subject": "this is drip campaign subject",
  • "content_html": "<p>Rush to the stores and get 70% discount on your next purchase.</p>",
  • "content_text": "Rush to the stores and get 70% discount on your next purchase.",
  • "status": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Drip has been successfully added"
}

Delete-Drip-Campaign-Auto-Follow-ups

Delete Drip Campaign/Auto-Follow-ups.

Authorizations:
BearerAuth
path Parameters
id
required
integer
Example: 10

Drip ID(s) to be deleted.

Responses

Request samples 

curl -X DELETE https://demo.campaigns.mumara.com/api/deleteDrips/{id} \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \

Response samples

Content type
application/json
{
  • "status": "success",
  • "response": "Success: Drip has been successfully deleted."
}