Contact

Contact List

API Url : https://mailcampaign.club/api/thirdparty/v1/contact/list

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Contact Create

API Url : https://mailcampaign.club/api/thirdparty/v1/contact/create

Note : 1) If you create contact with mobile than country_code is required.

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) first_name : John (Required)
2) last_name : Doe (Optional)
3) email_address : [email protected] (Required)
4) country_code : 41 (Optional)
5) mobile : 0123456789 (Optional)
6) tag : abc,xyz,admin (Optional)

Contact CSV Upload

API Url : https://mailcampaign.club/api/thirdparty/v1/contact/csv

Note : 1) Every contact required country_code which have mobile.

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) first_name : John (Required in csv)
2) last_name : Doe (Optional in csv)
3) email_address : [email protected] (Required in csv)
4) country_code : 41 (Optional in csv)
5) mobile : 0123456789 (Optional in csv)
6) tag : abc,xyz,admin (Optional in csv)
7) contact_file : email-import-example.csv (Required)

Contact Edit

API Url : https://mailcampaign.club/api/thirdparty/v1/contact/edit

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) contact_id : 1 (Required)

Contact Update

API Url : https://mailcampaign.club/api/thirdparty/v1/contact/update

Note : 1) If you create update with mobile than country_code is required.

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) first_name : John (Required)
2) last_name : Doe (Optional)
3) email_address : [email protected] (Required)
4) country_code : 41 (Optional)
5) mobile : 0123456789 (Optional)
6) tag : abc,xyz,admin (Optional)
7) remove_tag : 123,456 (Optional)

Contact Delete

API Url : https://mailcampaign.club/api/thirdparty/v1/contact/delete

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) contact_id : 1 (Required)

Multiple Contact Delete

API Url : https://mailcampaign.club/api/thirdparty/v1/contact/multi/delete

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) contact_delete : [{"id":1},{"id":2}] (Required)

Contact Restore

API Url : https://mailcampaign.club/api/thirdparty/v1/contact/restore

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) contact_restore : 1 (Required)

Segment

Segment List

API Url : https://mailcampaign.club/api/thirdparty/v1/segment/list

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Segment Create

API Url : https://mailcampaign.club/api/thirdparty/v1/segment/create

Note : 1) If you create segment with email or contact than segment tags is not required.
2) If you create segment with tags than segment_contacts is not required.

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) segment_name : First Segment (Required)
2) segment_contacts : [email protected],[email protected] (Optional)
3) segment_tags : abc,xyz,admin (Optional)
4) segment_type : email (Required)(Values : email, tags , contact) Required

Segment Edit

API Url : https://mailcampaign.club/api/thirdparty/v1/segment/edit

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) segment_id : 1 (Required)

Segment Update

API Url : https://mailcampaign.club/api/thirdparty/v1/segment/update

Note : 1) If you create segment with email or contact than segment tags is not required.
2) If you create segment with tags than segment_contacts is not required.

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) segment_name : First Segment (Required)
2) segment_contacts : [email protected],[email protected] (Optional)
3) segment_tags : abc,xyz,admin (Optional)
4) segment_type : email (Required)(Values : email, tags , contact) (Required)
5) segment_id : 1 (Required)

Segment Delete

API Url : https://mailcampaign.club/api/thirdparty/v1/segment/delete

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) segment_id : 1 (Required)

Multiple Segment Delete

API Url : https://mailcampaign.club/api/thirdparty/v1/segment/multi/delete

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) segment_delete : [{"id":1},{"id":2}] (Required)

Segment Restore

API Url : https://mailcampaign.club/api/thirdparty/v1/segment/restore

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) segment_restore : 1 (Required)

Template

Template List

API Url : https://mailcampaign.club/api/thirdparty/v1/template/list

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Template Create

API Url : https://mailcampaign.club/api/thirdparty/v1/template/create

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) template_name : First Template (Required)
2) template_content : HTML content with internal css (Required)

3) attachment : array() (Optional)

Template Edit

API Url : https://mailcampaign.club/api/thirdparty/v1/template/edit

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) template_id : 1 (Required)

Template Update

API Url : https://mailcampaign.club/api/thirdparty/v1/template/update

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) template_name : First Template (Required)
2) template_content : HTML content with internal css (Required)
3) template_id : 1 (Required) 4) attachment : array() (Optio)

Template Delete

API Url : https://mailcampaign.club/api/thirdparty/v1/template/delete

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) template_id : 1 (Required)

Multiple Template Delete

API Url : https://mailcampaign.club/api/thirdparty/v1/template/multi/delete

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) template_delete : [{"id":1},{"id":2}] (Required)

Campaign

Campaign List

API Url : https://mailcampaign.club/api/thirdparty/v1/campaign/list

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Campaign Create

API Url : https://mailcampaign.club/api/thirdparty/v1/campaign/addcampaign

Note : 1) If you create campaign with email than recipients emails is required.
2) If you create campaign with tags than campaign tags is required.
3) If you create campaign with segment than campaign segmentation is required.
4) If you create campaign with set_time campaign type than campaign_time and timezone are required.

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) campaign_name : First Campaign (Required)
2) subject : First Campaign (Required)
3) from_email : [email protected] (Required), Note : Email must be verified in our system as a from email
4) recipients_type : Ex. email (Values : email, segmentations, tags) (Required)
5) recipients_emails : Serialized array (key : name , emailid) (Optional)
6) campaign_tags : Serialized array (Tag name) (Optional)
7) campaign_segmentation : Serialized array (Segment id) (Optional)
8) campaign_time_type : Default : immediate (Values : immediate , set_time) (Required)
9) campaign_time : Y-m-d H:i:s (Format) (Optional)
10) timezone : Zürich (Optional)
10) attachment : array() (Optional)
11) template : HTML content with internal css (Required)

Campaign Edit

API Url : https://mailcampaign.club/api/thirdparty/v1/campaign/edit

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) campaign_id : 1 (Required)

Campaign Update

API Url : https://mailcampaign.club/api/thirdparty/v1/campaign/editcampaign

Note : 1) If you create campaign with email than recipients emails is required.
2) If you create campaign with tags than campaign tags is required.
3) If you create campaign with segment than campaign segmentation is required.
4) If you create campaign with set_time campaign type than campaign_time and timezone are required.

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) campaign_name : First Campaign (Required)
2) subject : First Campaign (Required)
3) from_email : [email protected] (Required), Note : Email must be verified in our system as a from email
4) recipients_type : Ex. email (Values : email, segmentations, tags) (Required)
5) recipients_emails : Serialized array (key : name , emailid) (Optional)
6) campaign_tags : Serialized array (Tag name) (Optional)
7) campaign_segmentation : Serialized array (Segment id) (Optional)
8) campaign_time_type : Default : immediate (Values : immediate , set_time) (Required)
9) campaign_time : Y-m-d H:i:s (Format) (Optional)
10) timezone : Zürich (Optional)
11) attachment : array() (Optional)
12) template : HTML content with internal css (Required)
13) campaign_id : 1 (Required)

Campaign Delete

API Url : https://mailcampaign.club/api/thirdparty/v1/campaign/delete

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) campaign_id : 1 (Required)

Multiple Campaign Delete

API Url : https://mailcampaign.club/api/thirdparty/v1/campaign/multi/delete

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) campaign_delete : [{"id":1},{"id":2}] (Required)

From Email

From email List

API Url : https://mailcampaign.club/api/thirdparty/v1/from-email/list

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Add From Email

API Url : https://mailcampaign.club/api/thirdparty/v1/from-email/add

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) email_address : [email protected] (Required)

Remove From Email

API Url : https://mailcampaign.club/api/thirdparty/v1/from-email/remove

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) verify_id : 1 (Required)

SMS Template

SMS Template List

API Url : https://mailcampaign.club/api/thirdparty/v1/smstemplate/list

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

SMS Template Create

API Url : https://mailcampaign.club/api/thirdparty/v1/smstemplate/create

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) sms_template_name : First SMS Template (Required)
2) sms_template_content : This is my first SMS template (Required)

SMS Template Edit

API Url : https://mailcampaign.club/api/thirdparty/v1/smstemplate/edit

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) sms_template_id : 1 (Required)

SMS Template Update

API Url : https://mailcampaign.club/api/thirdparty/v1/smstemplate/update

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) sms_template_id : 1 (Required)
2) sms_template_name : First SMS Template (Required)
3) sms_template_content : This is my first SMS template (Required)

SMS Template Delete

API Url : https://mailcampaign.club/api/thirdparty/v1/smstemplate/delete

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) sms_template_id : 1 (Required)

Multiple SMS Template Delete

API Url : https://mailcampaign.club/api/thirdparty/v1/smstemplate/multi/delete

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) sms_template_delete : [{"id":1},{"id":2}] (Required)

SMS Campaign

SMS Campaign List

API Url : https://mailcampaign.club/api/thirdparty/v1/smscampaign/list

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

SMS Campaign Create

API Url : https://mailcampaign.club/api/thirdparty/v1/smscampaign/create

Note : 1) If you create sms campaign with recipients mobile than mobile_no is required.
2) If you create sms campaign with recipients segmentation than sms_segment is required.
3) If you create campaign with campaign_send_type than timezone & set_cron_date_time is required.

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) sms_campaign_name : First SMS Campaign (Required)
2) sms_campaign_content : This is my first SMS Campaign (Required)
3) mobile_no : mobile number's serialized array() (Optional)
4) sms_segment : segment id's serialized array() (Optional)
3) mobile_no : mobile number's serialized array() (Optional)
5) recipients_type : segmentation or mobile (Required)
6) timezone : Zürich (Optional)
7) set_cron_date_time : YYYY-mm-dd H:i:s (Optional)
8) campaign_send_type : immediate or set_time (Required)

SMS Campaign Edit

API Url : https://mailcampaign.club/api/thirdparty/v1/smscampaign/edit

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) sms_campaign_id : 1 (Required)

SMS Campaign Update

API Url : https://mailcampaign.club/api/thirdparty/v1/smscampaign/update

Note : 1) If you update sms campaign with recipients mobile than mobile_no is required.
2) If you update sms campaign with recipients segmentation than sms_segment is required.
3) If you update campaign with campaign_send_type than timezone & set_cron_date_time is required.

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) sms_campaign_name : First SMS Campaign (Required)
2) sms_campaign_content : This is my first SMS Campaign (Required)
3) mobile_no : mobile number's serialized array() (Optional)
4) sms_segment : segment id's serialized array() (Optional)
3) mobile_no : mobile number's serialized array() (Optional)
5) recipients_type : segmentation or mobile (Required)
6) timezone : Zürich (Optional)
7) set_cron_date_time : YYYY-mm-dd H:i:s (Optional)
8) campaign_send_type : immediate or set_time (Required)
8) sms_campaign_id : 1 (Required)

SMS Campaign Delete

API Url : https://mailcampaign.club/api/thirdparty/v1/smscampaign/delete

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) sms_campaign_id : 1 (Required)

Multiple SMS Campaign Delete

API Url : https://mailcampaign.club/api/thirdparty/v1/smscampaign/multi/delete

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameters :
1) sms_campaign_delete : [{"id":1},{"id":2}] (Required)

Dynamic Fields

Dynamic Field List

API Url : https://mailcampaign.club/api/thirdparty/v1/dynamic-field/list

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Add Dynamic Field

API Url : https://mailcampaign.club/api/thirdparty/v1/dynamic-field/add

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameter :
1) labelname : My name (Required)
2) fieldname : Ex. My_name (Optional)
3) datatype : Ex. text (Values : text , hidden , file) (Required)
4) required : Default : no (Values : no , yes) (Optional)

Edit Dynamic Field

API Url : https://mailcampaign.club/api/thirdparty/v1/dynamic-field/edit

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameter :
1) field_id : 9 (Required)

Update Dynamic Field

API Url : https://mailcampaign.club/api/thirdparty/v1/dynamic-field/update

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameter :
1) field_id : 9 (Required)
2) labelname : My name (Required)
3) fieldname : Ex. My_name (Optional)
4) datatype : Ex. text (Values : text , hidden , file) (Required)
5) required : Default : no (Values : no , yes) (Optional)

Delete Dynamic Field

API Url : https://mailcampaign.club/api/thirdparty/v1/dynamic-field/delete

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameter :
1) field_id : 9 (Required)

Delete Multiple Dynamic Field

API Url : https://mailcampaign.club/api/thirdparty/v1/dynamic-field/multi/delete

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameter :
1) dynamic_field_delete : [{"id":1},{"id":2}] (Required)

Tag

Tag List

API Url : https://mailcampaign.club/api/thirdparty/v1/tag/list

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Add Tag

API Url : https://mailcampaign.club/api/thirdparty/v1/tag/create

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameter :
1) tag : country (Required)

Edit Tag

API Url : https://mailcampaign.club/api/thirdparty/v1/tag/edit

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameter :
1) tag_id : 1 (Required)

Update Tag

API Url : https://mailcampaign.club/api/thirdparty/v1/tag/update

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameter :
1) tag_id : 1 (Required)
2) tag : country (Required)

Delete Tag

API Url : https://mailcampaign.club/api/thirdparty/v1/tag/delete

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameter :
1) tag_id : 1 (Required)

Multiple Tag Delete

API Url : https://mailcampaign.club/api/thirdparty/v1/tag/multi/delete

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameter :
1) tag_delete : [{"id":1},{"id":2}] (Required)

Restore Tag

API Url : https://mailcampaign.club/api/thirdparty/v1/tag/restore

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameter :
1) tag_id : 1 (Required)

Other

Tracking List

API Url : https://mailcampaign.club/api/thirdparty/v1/track-report/list

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Generate Invoice

API Url : https://mailcampaign.club/api/thirdparty/v1/invoice/generate

Header parameter :
1) secret-key : st3N******************************************************************************************************************* (Required)

Body parameter :
1) payment_id : 1 (Required)
2) invoice_type : email or sms (Required)