### Add User API Request Examples
Source: https://developers.mumara.com/Campaigns/API#section
Examples of how to add a user using different methods. This includes a CURL request and a Javascript example.
```curl
curl -X POST https://demo.campaigns.mumara.com/api/addUser -H "Authorization: Bearer {token}" -H "Content-Type: application/json" -d '{ "name": "Jon", "email": "email@domain.com", "password": "/:2E$Ej4n~A-", "password_confirmation": "/:2E$Ej4n~A-", "package_id": 3, "timezone": "+05:00", "login_ips": "192.168.1.1,192.168.1.2", "hashed": 0, "response": 1 }'
```
```javascript
const url = 'https://demo.campaigns.mumara.com/api/addUser';
const token = '{token}';
const userData = {
"name": "Jon",
"email": "email@domain.com",
"password": "/:2E$Ej4n~A-",
"password_confirmation": "/:2E$Ej4n~A-",
"package_id": 3,
"timezone": "+05:00",
"login_ips": "192.168.1.1,192.168.1.2",
"hashed": 0,
"response": 1
};
fetch(url, {
method: 'POST',
headers: {
'Authorization': `Bearer ${token}`,
'Content-Type': 'application/json'
},
body: JSON.stringify(userData)
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
```
--------------------------------
### Get List Groups Response Sample
Source: https://developers.mumara.com/Campaigns/API#section
Example JSON response for the Get List Groups endpoint. It returns a list of groups with their associated details.
```json
{
"status": "success",
"result": [
{
"id": 2,
"name": "Unsorted",
"user_id": 2,
"number_of_lists_in_group": 590
}
]
}
```
--------------------------------
### Add FBL Account Javascript Example
Source: https://developers.mumara.com/Campaigns/API#section
Example of how to add an FBL account using Javascript. This shows how to construct the request payload and send it to the API.
```javascript
var data = {
"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"
};
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://demo.campaigns.mumara.com/api/addFBLAccount");
xhr.setRequestHeader("Authorization", "Bearer {token}");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.send(JSON.stringify(data));
```
--------------------------------
### Add FBL Account CURL Example
Source: https://developers.mumara.com/Campaigns/API#section
Example of how to add an FBL account using a CURL request. This demonstrates the endpoint and the required headers.
```curl
curl -X POST https://demo.campaigns.mumara.com/api/addFBLAccount \
-H "Authorization: Bearer {token}" \
-H "Content-Type: application/json" \
-d @data.json
```
--------------------------------
### Get Contact Lists Response
Source: https://developers.mumara.com/Campaigns/API
Example of a successful response when fetching contact lists. It contains a list of contact list objects with their details.
```json
{
"status": "success",
"data": [
{
"name": "List 1",
"id": 6,
"owner_name": "John Lee",
"reply_email": "reply@anydomain.com",
"user_id": 2,
"group_id": 2,
"total_subscribers": 0,
"group_name": "Unsorted",
"bounce_email": "bounce@anydomain.com",
"bounce_id": 1,
"created_at": "2019-05-06 09:23:10",
"updated_at": "2019-05-14 08:22:17",
"custom_fields": null
}
]
}
```
--------------------------------
### Get Contact List Details Response Sample
Source: https://developers.mumara.com/Campaigns/API#section
Example JSON response when retrieving contact list details. The 'data' field contains an array of list objects.
```json
{
"status": "success",
"data": [
{
"id": 99,
"name": "user list by user apioi",
"group_id": 89,
"owner_name": "Adnan",
"owner_email": "adnan@user.101payment.com",
"reply_email": "reply@hello.com",
"bounce_email_id": 2,
"is_deleted": 0,
"validate": 0,
"user_id": 4,
"total_subscribers": 0,
"export_status": 0,
"download_status": 0,
"import_status": 0,
"zapier_connected": null,
"created_at": "2020-10-22 07:41:30",
"updated_at": "2020-10-22 08:47:28",
"import_cancel": 0
}
]
}
```
--------------------------------
### Get Drip Campaigns Response
Source: https://developers.mumara.com/Campaigns/API#section
Example successful response for the Get Drip Campaigns API endpoint, including campaign details.
```json
{
"status": "success",
"response": [
{
"id": 60,
"name": "Testing Drip Group-copy 2",
"autoresponder_group_id": 4,
"order_no": 0,
"perform_action_datetime_frequency": null,
"perform_action_datetime_count": 0,
"email_subject": "Testing Trigger",
"is_active": 0,
"send_to_existing": 0,
"meta_attributes": "{\"name\":\"Testing Drip Group\",\"autoresponder_group_id\":\"4\",\"status\":\"on\",\"perform_action_event\":\"on_event\",\"email_subject\":\"Testing Trigger\",\"content_html\":\"\\r\\n
\\r\\n\t<\/title>\\r\\n<\/head>\\r\\nHello %%first_name%%
\\r\\n
\\r\\nHello {{first_name}}
\\r\\n
\\r\\nHello ++[[first_name]]
\\r\\n
\\r\\nHello Sys %%recipient_email%%<\/body>\\r\\n<\/html>\",\"content_text\":\"Hello %%first_name%%\\r\\n\\r\\nHello {{first_name}}\\r\\n\\r\\nHello [[first_name]]\\r\\n\\r\\nHello Sys %%recipient_email%%\",\"smtp_id\":\"6\",\"preview_email\":null,\"is_active\":1,\"send_to_existing\":0,\"user_id\":2,\"order_no\":0}",
"user_id": 2,
"created_at": "2021-03-25 01:17:41",
"updated_at": "2021-03-25 01:17:41",
"run_at": null,
"last_activity_at": "2020-09-11 12:50:10",
"added_interval_date": "1970-01-01 00:00:00"
}
]
}
```
--------------------------------
### Create Contact List Response Sample
Source: https://developers.mumara.com/Campaigns/API#section
Example JSON response upon successful creation of a contact list. Includes list ID and creation details.
```json
{
"status": "success",
"result": "Success: List has been successfully created.",
"response": {
"id": 22,
"name": "Test List Via Api",
"group_id": 2,
"owner_name": "John Lee",
"owner_email": "owner@anydomain.com",
"reply_email": "reply@anydomain.com",
"bounce_email_id": 1,
"user_id": 2,
"created_at": "2019-05-08 09:17:41",
"updated_at": "2019-05-08 09:17:41",
"custom_fields": {
"2": "First Name",
"13": "Profession"
}
}
}
```
--------------------------------
### Get Broadcast Groups API Response (JSON)
Source: https://developers.mumara.com/Campaigns/API
Example JSON response for a successful request to get broadcast groups. It contains the status and a list of broadcast group details.
```json
{
"status": "success",
"result": [
{
"id": 4,
"name": "New Group",
"user_id": 2,
"number_of_campaigns_in_group": 47
}
]
}
```
--------------------------------
### Add User Response Sample
Source: https://developers.mumara.com/Campaigns/API#section
This is a sample successful response when adding a user. It confirms the status and provides details of the created user.
```json
{
* "status": "success",
* "result": "User has been successfully created.",
* "response": [
* {
* "name": "David Seagal",
* "email": "david_seagal@yahoo.com",
* "login_ips": "192.168.1.1,192.168.1.2",
* "role": "client",
* "is_client": 1,
* "user_id": 2,
* "time_zone": "+5:+00",
* "package_id": 1,
* "role_id": 3,
* "updated_at": "2020-12-29 12:56:19",
* "created_at": "2020-12-29 12:56:19",
* "id": 24
}
]
}
```
--------------------------------
### Get Triggers CURL Request
Source: https://developers.mumara.com/Campaigns/API#section
Example CURL request to retrieve triggers. Supports filtering by ID, user ID, and pagination.
```curl
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"
}
```
--------------------------------
### Add FBL Account PHP Sample
Source: https://developers.mumara.com/Campaigns/API#section
Example of how to add an FBL account using PHP. This demonstrates making a POST request with JSON data.
```php
"https://demo.campaigns.mumara.com/api/addFBLAccount",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "{
\"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\"
}",
CURLOPT_HTTPHEADER => array(
"Authorization: Bearer {token}",
"Content-Type: application/json"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:". $err;
} else {
echo $response;
}
```
--------------------------------
### Add User Response Sample (JSON)
Source: https://developers.mumara.com/Campaigns/API
A sample successful response when adding a user. It includes the status, a success message, and details of the created user, such as user_id, name, email, and creation timestamps.
```json
{
"status": "success",
"result": "User has been successfully created.",
"response": [
{
"name": "David Seagal",
"email": "david_seagal@yahoo.com",
"login_ips": "192.168.1.1,192.168.1.2",
"role": "client",
"is_client": 1,
"user_id": 2,
"time_zone": "+5:+00",
"package_id": 1,
"role_id": 3,
"updated_at": "2020-12-29 12:56:19",
"created_at": "2020-12-29 12:56:19",
"id": 24
}
]
}
```
--------------------------------
### Contact Creation Response Sample
Source: https://developers.mumara.com/Campaigns/API#section
This is a sample successful response after creating a contact, showing the status and details of the created contact.
```json
{
"status": "success",
"result": "Success: Contact has been successfully created.",
"data": {
"id": 44,
"email": "test_yahoo@anydomain.com",
"list_id": 9,
"bounced": "no_process",
"is_spamed": 0,
"is_unsubscribed": 1,
"is_confirmed": 1,
"is_verified": 0,
"is_active": 1,
"format": "html",
"user_id": 2,
"created_at": "2019-05-15 08:38:46",
"updated_at": "2019-05-15 08:38:46",
"additional_fields_data": {
"first_name": "Anthony",
"company": "Tstore",
"last_name": "Lewis"
}
}
}
```
--------------------------------
### Get Contact Details CURL Request
Source: https://developers.mumara.com/Campaigns/API
Example CURL command to retrieve the details of a specific contact using their ID. Requires an authorization token.
```curl
curl -X GET -G https://demo.campaigns.mumara.com/api/getContact/{id} \
-H "Authorization: Bearer {token}" \
-H "Content-Type: application/json" \
```
--------------------------------
### Get Scheduled Broadcasts API Response (JSON)
Source: https://developers.mumara.com/Campaigns/API
Example JSON response for a successful request to retrieve scheduled broadcasts. Includes status and a list of broadcast results.
```json
{
"status": "success",
"result": [
{
"id": 8,
"name": "Marketing Campaign",
"user_id": 2,
"status": "complete",
"created_at": "2020-09-03 19:39:18",
"updated_at": "2021-09-24 11:17:20"
}
]
}
```
--------------------------------
### Create Contact List Response Sample
Source: https://developers.mumara.com/Campaigns/API
This is a sample successful response when a contact list is created. It includes the status and details of the created list.
```json
{
"status": "success",
"result": "Success: List has been successfully created.",
"response": {
"id": 22,
"name": "Test List Via Api",
"group_id": 2,
"owner_name": "John Lee",
"owner_email": "owner@anydomain.com",
"reply_email": "reply@anydomain.com",
"bounce_email_id": 1,
"user_id": 2,
"created_at": "2019-05-08 09:17:41",
"updated_at": "2019-05-08 09:17:41",
"custom_fields": {
"2": "First Name",
"13": "Profession"
}
}
}
```
--------------------------------
### Get Bounce Address Request (cURL)
Source: https://developers.mumara.com/Campaigns/API
This cURL command retrieves bounce addresses. You can filter by user ID, and specify start and count for pagination. Replace `{token}` with your authorization token.
```curl
curl -X GET -G https://demo.campaigns.mumara.com/api/getBounceAddresses \
-H "Authorization: Bearer {token}" \
-H "Content-Type: application/json" \
```
--------------------------------
### Get Contact Lists
Source: https://developers.mumara.com/Campaigns/API
Retrieves a list of contact lists. You can filter the results by list ID, user ID, group ID, and control pagination with limit start and count parameters.
```APIDOC
## Get Contact Lists
### Description
Retrieves a list of contact lists. You can filter the results by list ID, user ID, group ID, and control pagination with limit start and count parameters.
### Method
GET
### Endpoint
/api/getLists
### Parameters
#### Query Parameters
- **list_id** (integer) - Optional - Example: 3. Get details of a specific contact list.
- **user_id** (integer) - Optional - Example: 2. Get contact lists of a specific user.
- **group_id** (integer) - Optional - Example: 23. Get contact lists for a specific group.
- **limit_start** (integer) - Optional - Starting row of result. Default: 0.
- **limit_count** (integer) - Optional - Number of records to get. Default: 25.
### Request Example
```bash
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
#### Success Response (200)
- **status** (string) - Indicates the status of the operation.
- **data** (array) - An array of contact list objects.
#### Response Example
```json
{
"status": "success",
"data": [
{
"name": "List 1",
"id": 6,
"owner_name": "John Lee",
"reply_email": "reply@anydomain.com",
"user_id": 2,
"group_id": 2,
"total_subscribers": 0,
"group_name": "Unsorted",
"bounce_email": "bounce@anydomain.com",
"bounce_id": 1,
"created_at": "2019-05-06 09:23:10",
"updated_at": "2019-05-14 08:22:17",
"custom_fields": null
}
]
}
```
```
--------------------------------
### Add FBL Account (JavaScript)
Source: https://developers.mumara.com/Campaigns/API
Example of adding an FBL account using JavaScript's fetch API. This demonstrates how to send a POST request with JSON data and authorization headers.
```javascript
const url = "https://demo.campaigns.mumara.com/api/addFBLAccount";
const token = "{token}";
const data = {
"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"
};
fetch(url, {
method: "POST",
headers: {
"Authorization": `Bearer ${token}`,
"Content-Type": "application/json"
},
body: JSON.stringify(data)
})
.then(response => response.json())
.then(data => {
console.log("Success:", data);
})
.catch(error => {
console.error("Error:", error);
});
```
--------------------------------
### Get Contact Lists
Source: https://developers.mumara.com/Campaigns/API#section
Retrieves a list of contact lists. You can filter the results by list ID, user ID, or group ID, and control the pagination with limit start and count parameters.
```APIDOC
## Get Contact Lists
### Description
Retrieves a list of contact lists. You can filter the results by list ID, user ID, or group ID, and control the pagination with limit start and count parameters.
### Method
GET
### Endpoint
/api/getLists
### Parameters
#### Query Parameters
- **list_id** (integer) - Optional - Example: 3. Get details of a specific contact list.
- **user_id** (integer) - Optional - Example: 2. Get contact lists of a specific user.
- **group_id** (integer) - Optional - Example: 23. Get contact lists for a specific group.
- **limit_start** (integer) - Optional - Starting row of result. Default: 0.
- **limit_count** (integer) - Optional - Number of records to get. Default: 25.
### Request Example
```bash
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
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.
- **data** (array) - An array of contact list objects.
- **name** (string) - The name of the contact list.
- **id** (integer) - The unique identifier of the contact list.
- **owner_name** (string) - The name of the list owner.
- **reply_email** (string) - The reply-to email address.
- **user_id** (integer) - The ID of the user who owns the list.
- **group_id** (integer) - The ID of the group the list belongs to.
- **total_subscribers** (integer) - The total number of subscribers in the list.
- **group_name** (string) - The name of the group the list belongs to.
- **bounce_email** (string) - The bounce email address configured for the list.
- **bounce_id** (integer) - The ID of the bounce email configuration.
- **created_at** (string) - The timestamp when the list was created.
- **updated_at** (string) - The timestamp when the list was last updated.
- **custom_fields** (null) - Placeholder for custom fields, currently null.
### Response Example
```json
{
"status": "success",
"data": [
{
"name": "List 1",
"id": 6,
"owner_name": "John Lee",
"reply_email": "reply@anydomain.com",
"user_id": 2,
"group_id": 2,
"total_subscribers": 0,
"group_name": "Unsorted",
"bounce_email": "bounce@anydomain.com",
"bounce_id": 1,
"created_at": "2019-05-06 09:23:10",
"updated_at": "2019-05-14 08:22:17",
"custom_fields": null
}
]
}
```
```
--------------------------------
### Add User
Source: https://developers.mumara.com/Campaigns/API#section
Adds a new user to the system with specified details including name, email, password, and package.
```APIDOC
## POST /api/addUser
### Description
Adds a new user to the system. Requires user details such as name, email, password, and package ID.
### Method
POST
### Endpoint
https://demo.campaigns.mumara.com/api/addUser
### Parameters
#### Query Parameters
- **name** (string) - Required - Name of the user you're adding.
- **email** (string) - Required - Email of the user you're adding.
- **password** (string) - Required - Password of the user you're adding.
- **password_confirmation** (string) - Required - Password confirmation.
- **package_id** (integer) - Required - Package ID for the user.
- **timezone** (string) - Optional - Timezone of the user you're adding. Example: +05:00.
- **login_ips** (string) - Optional - Restrict access to user account by adding trusted IP addresses. Example: 192.168.1.1,192.168.1.2.
- **hashed** (integer) - Optional - Set to 1 if Mumara should not encrypt the password. Default is 0.
- **response** (integer) - Optional - Set to 1 to get the full response of the operation. Default is 0.
### Request Body schema: application/json
- **name** (string) - Required - Name of the user you're adding.
- **email** (string) - Required - Email of the user you're adding.
- **password** (string) - Required - Password of the user you're adding.
- **password_confirmation** (string) - Required - Password confirmation.
- **package_id** (integer) - Required - Package ID for the user.
- **timezone** (string) - Optional - Timezone of the user you're adding.
- **login_ips** (string) - Optional - Restrict access to user account by adding trusted IP addresses.
- **hashed** (integer) - Optional - Set to 1 if Mumara should not encrypt the password.
- **response** (integer) - Optional - Set to 1 to get the full response of the operation.
### Request Example
```json
{
"name": "Jon",
"email": "email@domain.com",
"password": "0AT'}d5piG]K",
"password_confirmation": "0AT'}d5piG]K",
"package_id": 3,
"timezone": "+05:00",
"login_ips": "192.168.1.1,192.168.1.2",
"hashed": 0,
"response": 1
}
```
### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the request.
- **result** (string) - A message confirming the user creation.
- **response** (array) - Details of the created user if 'response' parameter is set to 1.
- **name** (string) - Name of the user.
- **email** (string) - Email of the user.
- **login_ips** (string) - Allowed login IPs.
- **role** (string) - User role.
- **is_client** (integer) - Flag indicating if the user is a client.
- **user_id** (integer) - The unique ID of the user.
- **time_zone** (string) - User's timezone.
- **package_id** (integer) - The package ID assigned to the user.
- **role_id** (integer) - The role ID.
- **updated_at** (string) - Timestamp of the last update.
- **created_at** (string) - Timestamp of creation.
- **id** (integer) - The internal ID of the user record.
#### Response Example
```json
{
"status": "success",
"result": "User has been successfully created.",
"response": [
{
"name": "David Seagal",
"email": "david_seagal@yahoo.com",
"login_ips": "192.168.1.1,192.168.1.2",
"role": "client",
"is_client": 1,
"user_id": 2,
"time_zone": "+5:+00",
"package_id": 1,
"role_id": 3,
"updated_at": "2020-12-29 12:56:19",
"created_at": "2020-12-29 12:56:19",
"id": 24
}
]
}
```
```
--------------------------------
### Add User
Source: https://developers.mumara.com/Campaigns/API
Adds a new user to the system with specified details.
```APIDOC
## POST /api/addUser
### Description
Adds a new user to the system. Requires authentication via Bearer Token.
### Method
POST
### Endpoint
https://demo.campaigns.mumara.com/api/addUser
### Parameters
#### Query Parameters
- **name** (string) - Required - Name of the user you're adding.
- **email** (string) - Required - Email of the user you're adding.
- **password** (string) - Required - Password of the user you're adding.
- **password_confirmation** (string) - Required - Password of the user you're adding.
- **package_id** (integer) - Required - Package id for user.
- **timezone** (string) - Optional - Timezone of user you're adding.
- **login_ips** (string) - Optional - Restrict access to user your account by adding a range of trusted IP addresses.
- **hashed** (integer) - Optional - Setting it to 1 means, Mumara will not encrypt the password. Default: 0.
- **response** (integer) - Optional - Get full response of the operation. Default: 1.
#### Request Body schema: application/json
- **name** (string) - Required - Name of the user you're adding.
- **email** (string) - Required - Email of the user you're adding.
- **password** (string) - Required - Password of the user you're adding.
- **password_confirmation** (string) - Required - Password of the user you're adding.
- **package_id** (integer) - Required - Package id for user.
- **timezone** (string) - Optional - Timezone of user you're adding.
- **login_ips** (string) - Optional - Restrict access to user your account by adding a range of trusted IP addresses.
- **hashed** (integer) - Optional - Setting it to 1 means, Mumara will not encrypt the password.
- **response** (integer) - Optional - Get full response of the operation.
### Request Example
```json
{
"name": "Jon",
"email": "email@domain.com",
"password": "0AT'}d5piG]K",
"password_confirmation": "0AT'}d5piG]K",
"package_id": 3,
"timezone": "+05:00",
"login_ips": "192.168.1.1,192.168.1.2",
"hashed": 0,
"response": 1
}
```
### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the operation.
- **result** (string) - A message confirming the user creation.
- **response** (array) - Detailed information about the created user.
#### Response Example
```json
{
"status": "success",
"result": "User has been successfully created.",
"response": [
{
"name": "David Seagal",
"email": "david_seagal@yahoo.com",
"login_ips": "192.168.1.1,192.168.1.2",
"role": "client",
"is_client": 1,
"user_id": 2,
"time_zone": "+5:+00",
"package_id": 1,
"role_id": 3,
"updated_at": "2020-12-29 12:56:19",
"created_at": "2020-12-29 12:56:19",
"id": 24
}
]
}
```
```
--------------------------------
### Get Logs By ID(s) Request Example (cURL)
Source: https://developers.mumara.com/Campaigns/API
This cURL command retrieves campaign schedule logs by providing a comma-separated list of log IDs. An optional user ID can be included for filtering.
```bash
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"
}
```
--------------------------------
### Get Broadcast Stats Logs Request Example (cURL)
Source: https://developers.mumara.com/Campaigns/API
Use this cURL command to retrieve broadcast statistics logs for a specific schedule ID. Include your authorization token and specify limit parameters.
```bash
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"
}
```
--------------------------------
### Add FBL Account (PHP)
Source: https://developers.mumara.com/Campaigns/API
Example of adding an FBL account using PHP. This code snippet shows how to prepare the data and send a POST request using cURL.
```php
"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"
];
$payload = json_encode($data);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer {$token}",
"Content-Type: application/json"
]);
$response = curl_exec($ch);
if (curl_errno($ch)) {
echo 'Curl error: ' . curl_error($ch);
}
curl_close($ch);
$responseData = json_decode($response, true);
print_r($responseData);
?>
```
--------------------------------
### Get Broadcast Bounced Stats API Request (CURL)
Source: https://developers.mumara.com/Campaigns/API
This CURL command retrieves bounced statistics for a broadcast schedule. You can filter the results by start row and the number of records. Include your authorization token.
```curl
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"
}
```
--------------------------------
### Add FBL Account (cURL)
Source: https://developers.mumara.com/Campaigns/API
Example of adding an FBL account using cURL. This command includes the necessary headers and the JSON payload.
```bash
curl -X POST https://demo.campaigns.mumara.com/api/addFBLAccount \
-H "Authorization: Bearer {token}" \
-H "Content-Type: application/json" \
-d @payload.json
```
--------------------------------
### Get Activity Logs API (cURL)
Source: https://developers.mumara.com/Campaigns/API#section
This cURL command retrieves activity logs for a specific user. You can filter results by user ID, starting row, and the number of records to retrieve. Requires an authorization token.
```bash
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"
}
```
--------------------------------
### Update User Response Sample
Source: https://developers.mumara.com/Campaigns/API#section
A sample successful response after updating a user. It includes status and details of the operation.
```json
{
"status": "success",
"result": "User has been successfully created.",
"response": [
{
"id": 24,
"name": "David Seagal",
"email": "david_seagal@yahoo.com",
"one_time_password": null,
"login_ips": "192.168.1.1,192.168.1.2",
"countrycode": 92,
"country": "PK",
"time_zone": "+5:+00",
"address_line_1": "St # 1",
"address_line_2": "St # 2",
"city": "Bhalwal",
"state": "Punjab",
"post_code": 40410,
"phone": 66427868,
"mobile": 3317667,
"user_id": 2,
"role": "client",
"role_id": 3,
"package_id": 1,
"is_admin": 0,
"is_staff": 0,
"is_client": 1,
"status": "active",
"parent_id": 0,
"logout": 0,
"deleted_at": null,
"created_at": "2020-12-29 12:56:19",
"updated_at": "2020-12-29 13:52:20"
}
]
}
```
--------------------------------
### Response Sample for Add SpinTag
Source: https://developers.mumara.com/Campaigns/API
This is a sample JSON response after successfully adding a SpinTag. It includes details of the newly created tag.
```JSON
{
* "status": "success",
* "result": "Success: Spintag has been successfully added.",
* "response": {
* "user_id": 2,
* "place_holder": "first name",
* "tag": "first_name",
* "word_list": "John\r\nJames\r\nAlexa\r\nDavid",
* "updated_at": "2020-10-13 10:32:50",
* "created_at": "2020-10-13 10:32:50",
* "id": 13
}
}
```
--------------------------------
### Get Activity Logs API Request (CURL)
Source: https://developers.mumara.com/Campaigns/API
This CURL command retrieves activity logs for a specific user. You can filter results by user ID, start row, and the number of records to retrieve. Include your authorization token.
```curl
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"
}
```
--------------------------------
### Get Sending Nodes Request Sample (cURL)
Source: https://developers.mumara.com/Campaigns/API
This cURL command demonstrates how to request sending nodes for a specific user, including parameters for pagination. Ensure you replace `{token}` with your actual authorization token.
```curl
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"
}
```
--------------------------------
### Get Contact List Details Response Sample
Source: https://developers.mumara.com/Campaigns/API
This is a sample successful response for retrieving contact list details. It returns an array of list objects.
```json
{
"status": "success",
"data": [
{
"id": 99,
"name": "user list by user apioi",
"group_id": 89,
"owner_name": "Adnan",
"owner_email": "adnan@user.101payment.com",
"reply_email": "reply@hello.com",
"bounce_email_id": 2,
"is_deleted": 0,
"validate": 0,
"user_id": 4,
"total_subscribers": 0,
"export_status": 0,
"download_status": 0,
"import_status": 0,
"zapier_connected": null,
"created_at": "2020-10-22 07:41:30",
"updated_at": "2020-10-22 08:47:28",
"import_cancel": 0
}
]
}
```
--------------------------------
### Import Contacts Response Sample
Source: https://developers.mumara.com/Campaigns/API#section
A successful response indicates that the contact import process has been initiated in the background.
```json
{
"status": "success",
"result": "The import has been started in background"
}
```
--------------------------------
### Get Sending Nodes Response Sample
Source: https://developers.mumara.com/Campaigns/API
This is a sample JSON response for the 'Get Sending Nodes' API endpoint, illustrating the structure of a successful retrieval of sending node details.
```json
{
"status": "success",
"result": {
"id": 10,
"name": "sending_node",
"host": "smtp.domain.com",
"username": "testings@domain.com",
"password": "asd324234asdasdasdsdfsdf",
"port": 587,
"smtp_encryption": "tls",
"allow_self_signed": 1,
"verify_peer": 0,
"verify_peer_name": 0,
"mail_encoding": "quoted-printable",
"group_id": 216,
"status": 1,
"from_name": "mohammad",
"from_email": "testings@domain.com",
"bounce_email_id": 0,
"masked_domain_id": 120,
"reply_email": "testings@domain.com",
"pmta_id": 0,
"user_id": 67,
"test_status": "Verified",
"type": "smtp",
"domain_name": "",
"api_key": "",
"process_delivery_status": 0,
"process_delivery_reports": null,
"settings": "{\"hourlyspeed_status\":null,\"hourlyspeed\":null,\"dbatch_status\":null,\"delaybatch\":null}",
"additional_headers": "[{\"header\":\"header_1\",\"header_value\":\"user_id\"}]",
"api_credentials": null,
"created_at": "2021-06-09T17:23:00.000000Z",
"updated_at": "2023-07-31T06:46:43.000000Z",
"auto_inactive_datetime": "2022-10-18 12:43:53"
}
}
```
--------------------------------
### Add Sending Domain Response Sample
Source: https://developers.mumara.com/Campaigns/API
This is a sample successful response when adding a sending domain. It includes status and result messages, along with detailed information about the added domain.
```json
{
"status": "success",
"result": "Success: Sending Domain has been successfully added.",
"response": {
"id": 109,
"dns_id": null,
"zone": null,
"domain": "apinew.com",
"type": "index",
"user_id": "2",
"pmta_id": "0",
"spf": null,
"dkim_public": null,
"dkim_private": null,
"dkim_public_key": null,
"created_at": "2021-08-24 11:00:44",
"updated_at": "2021-08-24 11:00:44",
"tracking_domain": "email",
"tracking_status": "Active",
"bounce_status": null,
"domain_status": "1",
"is_confirm_dns": "0",
"is_confirm": "0",
"is_confirm_redirect": "0",
"is_confirm_mx": "0",
"is_confirm_spf": "0",
"email_selector": "track",
"bounce_selector": "bounce",
"is_verified": null,
"is_enable_dkim": "0",
"is_confirm_clicked": "0",
"is_ssl_enabled": null
}
}
```