Method: POST
Endpoint: /api/addSendingDomain
| Parameter | Type | Required |
Description |
| domain | string | Yes | A valid domain |
| masking_type | cloak, htaccess, cname (default: cname) | No | Masking type |
| enable_tracking | 0, 1 (default: 0) | No | Flag to turn on tracking status 1 = Active 0 = Inactive |
| generate_dkim | 0, 1 (default: 0) | Yes if enable_signing = 1 | Flag to generate dkim keys 1 = Generate dkim keys 0 = Do not generate dkim keys |
| enable_signing | 0, 1 (default: 0) | No | Flag to enable/disable dkim signing 1 = Enable 0 = Disable |
| response | 0, 1 (default: 0) | No | Get full response of operation |
| Parameter | Type | Description |
| status | JSON | Success or Error |
| result | JSON | Result of the operation |
| response | JSON | Output of the operation |
<?php
// Authentication
$api_token = 'API_KEY'; // Mumara API Key (can be found in Settings -> API Key)
$domain = 'http://www.anydomain.com'; // Your Mumara Domain Name
// API Endpoint
$endpoint = '/api/addSendingDomain';
$params = [
'domain' => 'domain.com',
'masking_type' => 'cname',
];
// Defining cURL Request
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL,$domain.$endpoint);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($params));
curl_setopt($ch, CURLOPT_HTTPHEADER,
array('Content-Type: application/json', 'Authorization: Bearer ' . $api_token));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
// Executing cURL
$output = curl_exec ($ch);
// Printing Output
echo "<pre>";
echo json_encode(json_decode($output),JSON_PRETTY_PRINT );
// Closing cURL
curl_close ($ch);
?>
{"status":"success",
"result":"Success: Sending Domain has been successfully added.",
"response":{
"id":62,
"dns_id":null,
"zone":null,
"domain":"abcdfeg.com",
"type":"cname",
"user_id":2,
"pmta_id":0,
"spf":null,
"dkim_public":"v=DKIM1; k=rsa; p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqLLDO5NAlrnO\/O06b49tWIYAhmeLnbH6gVutWwtldDSg9lTWcJ1t+oWHF9KZuJKxhJW7Q8gjeBlTBAwXPPXiqtCsMLXoXuCd4TyssVEayZ+zH6DZ25yuwVqqZfnchas1V5XH92DVi0JRN2T0KkgAFPB684kyNbk8u0z2ikzGtKKMtKdYEhbdu7M3Trb2G07jhzfpsqY1MC20Wkv\/IGEHkEo5PWLRdqdsX410wfq1hRU7GDDKKlDRRxIRoiuO8h0qT74u3Vlnhj8FCjvS3N+RoA4N1+jkEqvKINeqA9xyRt0TnpQgNOIYbn2wR9oCSL09X\/TaHZTJQO9K8NTvpUubGQIDAQAB","dkim_private":"-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQCossM7k0CWuc78\n7Tpvj21YhgCGZ4udsfqBW61bC2V0NKD2VNZwnW36hYcX0pm4krGElbtDyCN4GVME\nDBc89eKq0Kwwtehe4J3hPKyxURrJn7MfoNnbnK7BWqpl+dyFqzVXlcf3YNWLQlE3\nZPQqSAAU8HrziTI1uTy7TPaKTMa0ooy0p1gSFt27szdOtvYbTuOHN+mypjUwLbRa\nS\/8gYQeQSjk9YtF2p2xfjXTB+rWFFTsYMMoqUNFHEhGiK47yHSpPvi7dWWeGPwUK\nO9Lc35GgDg3X6OQSq8og16oD3HJG3ROelCA04hhufbBH2gJIvT1f9NodlMlA70rw\n1O+lS5sZAgMBAAECggEAHYMQZnavQO8Gh\/bUVznnLipbIygwI4lEQqcQH7JRsE+Y\nrR9QWGkiGUaMyJ0eKUz4YzJyjTwRAGylujqHQjHd0nYo+WiJWze+Ru3\/ZBHFNuqK\nQok4M5QoekjrMGXSr0uxTD42uk8lbHRQkvlFQbRQ11jumXYx43Yhar7fDni59lWE\nvuPkL8Nvodh6I0lig\/JIGMm1VDgsgLkz206PHMQ13c7aJbck5HiVlnyujuQqTzeZ\nqfqJnSPtlMwZtU6Ry+p2Wub4LaMLiEweWwLbk00nYueTtPSS5wXB\/O4gcWtYaRu7\nphXCxJ+\/RtSrB30I\/hOr2RznyBP1g3lAxLE6bt+wAQKBgQDUwC4qW\/LTeTsl1Gkb\nw5ck2tT7zH4Q5qCfxBxQW7vyRH5IEwFN3yQ4o2YfHa6I8neWROvUe7A1IVju97wz\nWc\/azmstWEi\/JSIa7+iXmfgOfi+r+UkGcRdtQqBfy7bJab+eCL2JM\/qpkUNw9A5R\nqc5X1gwCfokMoDOr15xdW8diAQKBgQDK\/gnHQJDLgmTdqGbGuwTBh6jtdD8I9YjH\nw527a9u1K4mrzK7CGUyhDilSH5TIcRR1S+4K7I4x4\/6FqaW0L1QR9XMAWFuW6Rpx\nl1yea4yBxNj8xm+jfvSCrX3uFBGF141PUVi5vRRzQALxJo5Xhrx61YU8WNPVphjW\nw\/g3imEJGQKBgD7LutSl7zacQekYmS2ovaQTM2pfIZa7fA2sRO8zJHaN4PhFI81o\nX7iYAjyM9kdVyhaAoVtGZuxHu4hNdy9xAvkClH\/93vsMatSom26j86PTex63peZQ\n2ylU0SF1b65jmDt9OPSWcxY52j4sy00vYchrVYAm+SzQ3G+MZIrp3CABAoGBAKoC\nKV5fjOVkx+V87Nb0Ov97BtgYy9JNEcl849Xcd548YIkqXBLj7XHV0nWdTZayXlf+\nx9cOV+kg8kIv20AVg2unDjHzzoGNqUAJbOChYoQswS6zYzyjT1VCyH1lAWf\/J7KO\nhqjI2x\/LNKuThxN3HNQjj\/sCyifdfGAisPiTRMHBAoGBAKUvzrYjPbRyQg1KR9MQ\n24Hcje9WAImA9qRHepy+k4Z0DwOEg3Z4iTmmU7U8Nto6PuRtVXWsFEizuBQ96tzC\nnVP79cdGcbF77Am833y8FY1X2BcfjxjxMgFpBdb4JHtywGGx\/ajTtqI20G9Id8r2\ndFYJY7WmI+QmjprNGxJFbkaF\n-----END PRIVATE KEY-----\n","dkim_public_key":null,"created_at":"2021-08-11 12:25:17","updated_at":"2021-08-11 12:25:20","tracking_domain":"click1","tracking_status":"Active","bounce_status":null,"domain_status":4,"is_confirm_dns":0,"is_confirm":0,"is_confirm_redirect":0,"is_confirm_mx":0,"is_confirm_spf":0,"email_selector":"key1","bounce_selector":"bounce","is_verified":null,"is_enable_dkim":1,"is_confirm_clicked":0,"is_ssl_enabled":null}}{
"status": "success",
"result": "Success: Sending Domain has been successfully added.",
"response": {
"id": 62,
"dns_id": null,
"zone": null,
"domain": "abcdfeg.com",
"type": "cname",
"user_id": 2,
"pmta_id": 0,
"spf": null,
"dkim_public": "v=DKIM1; k=rsa; p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqLLDO5NAlrnO\/O06b49tWIYAhmeLnbH6gVutWwtldDSg9lTWcJ1t+oWHF9KZuJKxhJW7Q8gjeBlTBAwXPPXiqtCsMLXoXuCd4TyssVEayZ+zH6DZ25yuwVqqZfnchas1V5XH92DVi0JRN2T0KkgAFPB684kyNbk8u0z2ikzGtKKMtKdYEhbdu7M3Trb2G07jhzfpsqY1MC20Wkv\/IGEHkEo5PWLRdqdsX410wfq1hRU7GDDKKlDRRxIRoiuO8h0qT74u3Vlnhj8FCjvS3N+RoA4N1+jkEqvKINeqA9xyRt0TnpQgNOIYbn2wR9oCSL09X\/TaHZTJQO9K8NTvpUubGQIDAQAB",
"dkim_private": "-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQCossM7k0CWuc78\n7Tpvj21YhgCGZ4udsfqBW61bC2V0NKD2VNZwnW36hYcX0pm4krGElbtDyCN4GVME\nDBc89eKq0Kwwtehe4J3hPKyxURrJn7MfoNnbnK7BWqpl+dyFqzVXlcf3YNWLQlE3\nZPQqSAAU8HrziTI1uTy7TPaKTMa0ooy0p1gSFt27szdOtvYbTuOHN+mypjUwLbRa\nS\/8gYQeQSjk9YtF2p2xfjXTB+rWFFTsYMMoqUNFHEhGiK47yHSpPvi7dWWeGPwUK\nO9Lc35GgDg3X6OQSq8og16oD3HJG3ROelCA04hhufbBH2gJIvT1f9NodlMlA70rw\n1O+lS5sZAgMBAAECggEAHYMQZnavQO8Gh\/bUVznnLipbIygwI4lEQqcQH7JRsE+Y\nrR9QWGkiGUaMyJ0eKUz4YzJyjTwRAGylujqHQjHd0nYo+WiJWze+Ru3\/ZBHFNuqK\nQok4M5QoekjrMGXSr0uxTD42uk8lbHRQkvlFQbRQ11jumXYx43Yhar7fDni59lWE\nvuPkL8Nvodh6I0lig\/JIGMm1VDgsgLkz206PHMQ13c7aJbck5HiVlnyujuQqTzeZ\nqfqJnSPtlMwZtU6Ry+p2Wub4LaMLiEweWwLbk00nYueTtPSS5wXB\/O4gcWtYaRu7\nphXCxJ+\/RtSrB30I\/hOr2RznyBP1g3lAxLE6bt+wAQKBgQDUwC4qW\/LTeTsl1Gkb\nw5ck2tT7zH4Q5qCfxBxQW7vyRH5IEwFN3yQ4o2YfHa6I8neWROvUe7A1IVju97wz\nWc\/azmstWEi\/JSIa7+iXmfgOfi+r+UkGcRdtQqBfy7bJab+eCL2JM\/qpkUNw9A5R\nqc5X1gwCfokMoDOr15xdW8diAQKBgQDK\/gnHQJDLgmTdqGbGuwTBh6jtdD8I9YjH\nw527a9u1K4mrzK7CGUyhDilSH5TIcRR1S+4K7I4x4\/6FqaW0L1QR9XMAWFuW6Rpx\nl1yea4yBxNj8xm+jfvSCrX3uFBGF141PUVi5vRRzQALxJo5Xhrx61YU8WNPVphjW\nw\/g3imEJGQKBgD7LutSl7zacQekYmS2ovaQTM2pfIZa7fA2sRO8zJHaN4PhFI81o\nX7iYAjyM9kdVyhaAoVtGZuxHu4hNdy9xAvkClH\/93vsMatSom26j86PTex63peZQ\n2ylU0SF1b65jmDt9OPSWcxY52j4sy00vYchrVYAm+SzQ3G+MZIrp3CABAoGBAKoC\nKV5fjOVkx+V87Nb0Ov97BtgYy9JNEcl849Xcd548YIkqXBLj7XHV0nWdTZayXlf+\nx9cOV+kg8kIv20AVg2unDjHzzoGNqUAJbOChYoQswS6zYzyjT1VCyH1lAWf\/J7KO\nhqjI2x\/LNKuThxN3HNQjj\/sCyifdfGAisPiTRMHBAoGBAKUvzrYjPbRyQg1KR9MQ\n24Hcje9WAImA9qRHepy+k4Z0DwOEg3Z4iTmmU7U8Nto6PuRtVXWsFEizuBQ96tzC\nnVP79cdGcbF77Am833y8FY1X2BcfjxjxMgFpBdb4JHtywGGx\/ajTtqI20G9Id8r2\ndFYJY7WmI+QmjprNGxJFbkaF\n-----END PRIVATE KEY-----\n",
"dkim_public_key": null,
"created_at": "2021-08-11 12:25:17",
"updated_at": "2021-08-11 12:25:20",
"tracking_domain": "click1",
"tracking_status": "Active",
"bounce_status": null,
"domain_status": 4,
"is_confirm_dns": 0,
"is_confirm": 0,
"is_confirm_redirect": 0,
"is_confirm_mx": 0,
"is_confirm_spf": 0,
"email_selector": "key1",
"bounce_selector": "bounce",
"is_verified": null,
"is_enable_dkim": 1,
"is_confirm_clicked": 0,
"is_ssl_enabled": null
}
}
{
"status": "error",
"result": {
"domain": [
"The domain has already been taken."
]
}
}