Adding / Removing Contacts

Learn how to add/remove contacts with our API

GET /api/contacts

Add or delete contacts from our applications using our proxy API.

Curl

curl -XGET 'https://tasks-wave.mobivate.com/api/contacts/create?username=username&password=password&msisdn=447000000001&applications=optouts:call'

Python

import requests

response = requests.get(
    'https://tasks-wave.mobivate.com/api/contacts/create?username=username&password=password&msisdn=447000000001&applications=optouts:call',
)

Curl

curl -XGET 'https://tasks-wave.mobivate.com/api/contacts/delete?username=username&password=password&msisdn=447000000001&applications=optouts:call'

Python

import requests

response = requests.get(
    'https://tasks-wave.mobivate.com/api/contacts/delete?username=username&password=password&msisdn=447000000001&applications=optouts:call',
)

Headers

Name	Value
Content-Type	application/json
Authorization	No Auth

Body

Parameter	Required	Description
username	Yes	The username used to login to Mobivate.
password	Yes	The password used to login to Mobivate.
msidn	Yes	Phone number in international format.
applications	Yes	Comma separated list of applications to subscribe to / remove from (see below).
name	No	The contacts name to use.
reference	No	Optional custom reference for the contact, used as callcentre reference id or custom 1 field.

Please note. Supplied reference is for your identification only.

Response

200

{
    "status": "ok",
    "optouts:robocall": "ok"
}

401

{
   "code":401,
   "message":"Not Authenticated"
}

Applications

Applications are denoted as a comma "," separated list, with colon ":" as the separator between the app name and identification token of the contact group/recurring campaign.

Application Name	Description
appointments	The appointment booking app.
recurring: CampaignId	The periodic reminder app.
contacts: ListId	The main contacts app.
callcentre: SetupId	The Callcentre app.
optouts: sms / call	Generic optouts.

Finding the Identification Tokens

Recurring

The CampaignId can be obtained as the last numeric parameter of the url while editing the campaign details.

Contacts Group

The ContactGroupId is shown on the group details at the bottom of the right column.

CallCentre

The SetupId is shown on the setup details at the bottom of the right column.

OptOuts

The identification is either sms for sms optouts or calls for robocall optouts.

To find out more about our applications, click here.