Goals

APIDescription
POST v1/goals/AddGoalAchievedToContact?MobitKey={MobitKey}&MobitId={MobitId}&ContactId={ContactId}&GoalId={GoalId}

Applies a Goal Achieved to an existing contact

GET v1/goals/GetCompanyGoals?MobitKey={MobitKey}&MobitId={MobitId}&GoalId={GoalId}

Returns all goals for a company or a specified goal based on the GoalId passed in.

Messages

APIDescription
POST v1/Messages/SendMessage?MobitKey={MobitKey}&MobitId={MobitId}&MessageId={MessageId}&ContactId={ContactId}

Sends the Mobit or SMS for a Given Contact

GET v1/Messages/GetMobitsAndSmss?MobitKey={MobitKey}&MobitId={MobitId}&CampaignId={CampaignId}

Gets Mobits and SMS's for a given Company and Campaign if specified.

Contacts

APIDescription
POST v1/contacts/GetContactDetails?MobitId={MobitId}&MobitKey={MobitKey}&ContactId={ContactId}

Provides Contacts Field Details - Use Json Body for Field list request.

POST v1/contacts/AddContactToGroup?ContactId={ContactId}&GroupId={GroupId}&MobitId={MobitId}&MobitKey={MobitKey}

Adds an existing contact to a MOBIT Group using the contactId.

POST v1/contacts/RemoveContactFromGroup?ContactId={ContactId}&GroupId={GroupId}&MobitId={MobitId}&MobitKey={MobitKey}

Removes an existing contact from a MOBIT Group using the contactId.

POST v1/contacts/AddContactToCampaignAudience?ContactId={ContactId}&CampaignId={CampaignId}&MobitId={MobitId}&MobitKey={MobitKey}

Adds an existing contact to a Campaign Audience using the contactId.

POST v1/contacts/RemoveContactFromCampaignAudience?ContactId={ContactId}&CampaignId={CampaignId}&MobitId={MobitId}&MobitKey={MobitKey}

Removes an existing contact from a Campaign Audience using the contactId.

POST v1/contacts/AddContact?MobitId={MobitId}&MobitKey={MobitKey}

Adds a new Contact to an account and returns the new Contact ID.

POST v1/contacts/UpdateContactDetails?MobitKey={MobitKey}&MobitId={MobitId}&ContactId={ContactId}

Updates a Contact with passed in field values.

Groups

APIDescription
GET v1/groups/GetCompanyGroups?MobitKey={MobitKey}&MobitId={MobitId}

Returns all Groups for a given MOBIT account.

GET v1/groups/GetContactIdsInGroup?MobitKey={MobitKey}&MobitId={MobitId}&GroupId={GroupId}

Returns Contact ID's of Contacts in a Group

Company

APIDescription
GET v1/Company/GetContactFields?MobitId={MobitId}&MobitKey={MobitKey}

Gets the Schema for Primary, Additional and Custom Fields for a Company

User

APIDescription
GET v1/user/Validate?MobitKey={MobitKey}&MobitId={MobitId}

Validates that a MobitID and API key are Valid

Tags

APIDescription
GET v1/tags/GetCompanyTags?MobitId={MobitId}&MobitKey={MobitKey}

Get the Tags for a Company

POST v1/tags/AddTagToContact?MobitId={MobitId}&MobitKey={MobitKey}&ContactId={ContactId}&TagId={TagId}

Adds a Tag to an existing contact

POST v1/tags/RemoveTagFromContact?MobitId={MobitId}&MobitKey={MobitKey}&ContactId={ContactId}&TagId={TagId}

Removes a Tag from an existing contact

LandingPage

APIDescription
GET v1/LandingPages/GetLandingPages?MobitKey={MobitKey}&MobitId={MobitId}&CampaignId={CampaignId}

Gets the current Active Landing Pages for a Company and or Campaign.

Campaign

APIDescription
GET v1/campaign/GetCompanyCampaigns?MobitKey={MobitKey}&MobitId={MobitId}&CampaignId={CampaignId}

Get the Campaign/s for a Company including Goals.

GET v1/campaign/GetCompanyMobits?MobitKey={MobitKey}&MobitId={MobitId}&CampaignId={CampaignId}

Gets a List of Company Mobits or Filtered to a given CampaignID if specified.

POST v1/campaign/StartCampaign?MobitKey={MobitKey}&MobitId={MobitId}&CampaignId={CampaignId}

Assigns an existing Campaign to on i.e Play Status

POST v1/campaign/StopCampaign?MobitKey={MobitKey}&MobitId={MobitId}&CampaignId={CampaignId}

Assigns an existing Campaign to off i.e Paused Status

GET v1/campaign/GetContactsInCampaignAudience?MobitKey={MobitKey}&MobitId={MobitId}&CampaignId={CampaignId}

Gets a List of Contact ID's that are in a Campaign Audience