MailMaster Campaign API Reference

MailMaster is a powerful mass mailing service built into InQ.Social ecosystem. Now, you no longer need to export lists of emails and use third-party services to reach out your customers with product updates, special deals and news.

Security

Each API request must be executed with a set of authentication details, set up in your InQ.Social administration area. Read more on InQ.Social API security options.

Endpoints

The InQ.Social API provides the following endpoints:

Get List of Equery Campaigns

GET: https://mailmaster.inq.social/organizations/{organization-id}/campaigns

Optional parameters: see paged list paging parameters.
Returns a paged list of MailMaster campaigns for the given organization id.

Get MailMaster Campaign Profile

GET: https://mailmaster.inq.social/organizations/{organization-id}/campaigns/{campaign-id}

Returns the MailMaster Campaign object.

Create

POST: https://mailmaster.inq.social/organizations/{organization-id}/campaigns

Request Fields

Name Mandatory Description Type
Name Yes Name of the EQuery campaign String
Subject Yes Subject that will appear in the email String
Template Yes Email template in HTML format String
TemplateType Yes The only acceptable value for creation using API is “Custom” String
DateToSubmit Yes Date and time when you want to start to send out the EQuery campaign. Must be supplied in your local timezone format DateTime
Audiences Yes Array of Audience objects. Array of Audience objects
EmailId Yes Id of email address profile registered with InQ.Social. Must be confirmed before campaign creation. string (GUID)

Response: if successful, the API will return status 200 and the new campaign Id.

Update

The only parameter you can update is the campaign name. If you want to change any other settings, cancel the campaign and create the new one.

PUT: https://mailmaster.inq.social/organizations/{organization-id}/campaigns/{query-id}

Request Fields

Name Mandatory Description Type
Name Yes Name of the MailMaster campaign String

Response: if successful, the API will return status 200.

Delete

DELETE: https://mailmaster.inq.social/organizations/{organization-id}/campaigns/{campaign-id}

Response: if successful, the API will return status 200.