Colony

TRITECH MEDIA

COLONY REST API

GET POST OPTIONS

Description:

Provides the ability to list and create Blacklists

Model:

{
    "originator": "string", 
    "comment": "string", 
    "updated_by": "int", 
    "campaign": "int", 
    "date_updated": "datetime", 
    "company": "int", 
    "created_by": "int", 
    "blacklisted_until": "datetime", 
    "notify": "boolean", 
    "date_created": "datetime", 
    "message": "int", 
    "id": "int"
}

Test:

You can test this API using the link below.

/collate/blacklists/

GET PUT PATCH OPTIONS

Description:

Provides the ability to get and put a Blacklist

Model:

{
    "originator": "string", 
    "comment": "string", 
    "updated_by": "int", 
    "campaign": "int", 
    "date_updated": "datetime", 
    "company": "int", 
    "created_by": "int", 
    "blacklisted_until": "datetime", 
    "notify": "boolean", 
    "date_created": "datetime", 
    "message": "int", 
    "id": "int"
}
GET POST OPTIONS

Description:

Provides the ability to list and create Messages

Model:

{
    "originator": "string", 
    "campaign": "int", 
    "date_updated": "datetime", 
    "text": "string", 
    "company": "int", 
    "fav": "boolean", 
    "blacklisted": "boolean", 
    "fraud_incident": "boolean", 
    "reason": "int", 
    "id": "int", 
    "fraud_suspect": "boolean", 
    "slot": "int", 
    "extra_digits": "string", 
    "network": "int", 
    "session_data": "unknown", 
    "reply_path_message": "boolean", 
    "backend_id": "string", 
    "longitude": "float", 
    "provider": "int", 
    "latitude": "float", 
    "date_created": "datetime", 
    "backend": "string", 
    "additional_data": "unknown"
}

Test:

You can test this API using the link below.

/collate/campaigns/message/

POST OPTIONS

Description:

Provides the ability to reply to a message from collate.

Model:

{}

Test:

You can test this API using the link below.

/collate/campaigns/message/reply/

GET PUT PATCH OPTIONS

Description:

Provides the ability to get and put a Message

Model:

{
    "originator": "string", 
    "campaign": "int", 
    "date_updated": "datetime", 
    "text": "string", 
    "company": "int", 
    "fav": "boolean", 
    "blacklisted": "boolean", 
    "fraud_incident": "boolean", 
    "reason": "int", 
    "id": "int", 
    "fraud_suspect": "boolean", 
    "slot": "int", 
    "extra_digits": "string", 
    "network": "int", 
    "session_data": "unknown", 
    "reply_path_message": "boolean", 
    "backend_id": "string", 
    "longitude": "float", 
    "provider": "int", 
    "latitude": "float", 
    "date_created": "datetime", 
    "backend": "string", 
    "additional_data": "unknown"
}
POST OPTIONS

Description:

Provides the ability to reply to a message that we've received.

Model:

{}
POST OPTIONS

Description:

Provides the ability to launch a task to create a csv file within filebox with messages.

Model:

{}

Test:

You can test this API using the link below.

/collate/campaigns/message/fraud/override/

POST OPTIONS

Description:

Provides the ability to launch a task to create a csv file within filebox with messages.

Model:

{}

Test:

You can test this API using the link below.

/collate/campaigns/downloadmessages/

GET POST OPTIONS

Description:

Provides the ability to list and create provider used to pull messages in to a campaign.

Model:

{
    "live": "boolean", 
    "handle": "string", 
    "updated_by": "int", 
    "date_updated": "datetime", 
    "company": "int", 
    "last_token_id": "int", 
    "reply_config": "int", 
    "created_by": "int", 
    "currency": "string", 
    "token": "string", 
    "cost": "float", 
    "date_created": "datetime", 
    "id": "int", 
    "token_secret": "string", 
    "provider_type": "int"
}

Test:

You can test this API using the link below.

/collate/campaigns/provider/

GET OPTIONS

Description:

Provides the ability to list providers that are not used in any live campaign.

Model:

{
    "live": "boolean", 
    "handle": "string", 
    "updated_by": "int", 
    "date_updated": "datetime", 
    "company": "int", 
    "last_token_id": "int", 
    "reply_config": "int", 
    "created_by": "int", 
    "currency": "string", 
    "token": "string", 
    "cost": "float", 
    "date_created": "datetime", 
    "id": "int", 
    "token_secret": "string", 
    "provider_type": "int"
}

Test:

You can test this API using the link below.

/collate/campaigns/provider_unused/

GET PUT PATCH OPTIONS

Description:

Provides the ability to get and update a provider used to pull messages in to a campaign.

Model:

{
    "live": "boolean", 
    "handle": "string", 
    "updated_by": "int", 
    "date_updated": "datetime", 
    "company": "int", 
    "last_token_id": "int", 
    "reply_config": "int", 
    "created_by": "int", 
    "currency": "string", 
    "token": "string", 
    "cost": "float", 
    "date_created": "datetime", 
    "id": "int", 
    "token_secret": "string", 
    "provider_type": "int"
}
POST OPTIONS

Description:

Provides the ability to send a message directly using a specific provider

Model:

{}
GET POST OPTIONS

Description:

Provides the ability to list Attachments

Model:

{
    "attachment": "image file", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "message": "int", 
    "id": "int", 
    "thumbnail": "unknown"
}

Test:

You can test this API using the link below.

/collate/campaigns/attachments/

GET OPTIONS

Description:

Provides the ability to get an Attachment

Model:

{
    "attachment": "image file", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "message": "int", 
    "id": "int", 
    "thumbnail": "unknown"
}
GET POST OPTIONS

Description:

Provides the ability to list ReplyMessage

Model:

{
    "text": "string", 
    "updated_by": "int", 
    "campaign": "int", 
    "reply_type": "int", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "id": "int", 
    "created_by": "int"
}

Test:

You can test this API using the link below.

/collate/campaigns/replymessage/

GET PUT PATCH DELETE OPTIONS

Description:

Provides the ability to get and put a ReplyMessage

Model:

{
    "text": "string", 
    "updated_by": "int", 
    "campaign": "int", 
    "reply_type": "int", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "id": "int", 
    "created_by": "int"
}
GET POST OPTIONS

Description:

Provides the ability to list and create Addons

Model:

{
    "addon_type": "string", 
    "updated_by": "int", 
    "campaign": "int", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "ignore_failure": "boolean", 
    "id": "int", 
    "created_by": "int", 
    "order": "int"
}

Test:

You can test this API using the link below.

/collate/campaigns/addon/

POST OPTIONS

Description:

Provides the ability to set a list of Addons for a campaign using the following format [

System Message: ERROR/3 (<string>, line 3)

Unexpected indentation.
{type: <addon type>, ignore_failure: <boolean>}, {type: <addon type>, ignore_failure: <boolean>}

System Message: WARNING/2 (<string>, line 5)

Block quote ends without a blank line; unexpected unindent.

]

clears out any previously set addons in the process.

Model:

{
    "addon_type": "string", 
    "updated_by": "int", 
    "campaign": "int", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "ignore_failure": "boolean", 
    "id": "int", 
    "created_by": "int", 
    "order": "int"
}
GET PUT PATCH DELETE OPTIONS

Description:

Provides the ability to get and put a Addon

Model:

{
    "addon_type": "string", 
    "updated_by": "int", 
    "campaign": "int", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "ignore_failure": "boolean", 
    "id": "int", 
    "created_by": "int", 
    "order": "int"
}
GET OPTIONS

Description:

Model:

{
    "addon_type": "string", 
    "updated_by": "int", 
    "campaign": "int", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "ignore_failure": "boolean", 
    "id": "int", 
    "created_by": "int", 
    "order": "int"
}
GET OPTIONS

Description:

Model:

{
    "addon_type": "string", 
    "updated_by": "int", 
    "campaign": "int", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "ignore_failure": "boolean", 
    "id": "int", 
    "created_by": "int", 
    "order": "int"
}
GET POST OPTIONS

Description:

Provides the ability to list and create Campaigns

Model:

{
    "updated_by": "int", 
    "end_date": "datetime", 
    "title": "string", 
    "date_updated": "datetime", 
    "company": "int", 
    "created_by": "int", 
    "start_date": "datetime", 
    "default": "boolean", 
    "is_focus_group": "boolean", 
    "keyword": "string", 
    "date_created": "datetime", 
    "id": "int"
}

Test:

You can test this API using the link below.

/collate/campaigns/

GET PUT PATCH OPTIONS

Description:

Provides the ability to get and put a Campaign

Model:

{
    "updated_by": "int", 
    "end_date": "datetime", 
    "title": "string", 
    "date_updated": "datetime", 
    "company": "int", 
    "created_by": "int", 
    "start_date": "datetime", 
    "default": "boolean", 
    "is_focus_group": "boolean", 
    "keyword": "string", 
    "date_created": "datetime", 
    "id": "int"
}
GET OPTIONS

Description:

Provides the ability to list Campaigns, included those that are disabled.

Model:

{
    "updated_by": "int", 
    "end_date": "datetime", 
    "title": "string", 
    "date_updated": "datetime", 
    "company": "int", 
    "created_by": "int", 
    "start_date": "datetime", 
    "default": "boolean", 
    "is_focus_group": "boolean", 
    "keyword": "string", 
    "date_created": "datetime", 
    "id": "int"
}

Test:

You can test this API using the link below.

/collate/campaigns/all/

GET OPTIONS

Description:

Provides the ability to get and put a Campaign

Model:

{
    "updated_by": "int", 
    "end_date": "datetime", 
    "title": "string", 
    "date_updated": "datetime", 
    "company": "int", 
    "created_by": "int", 
    "start_date": "datetime", 
    "default": "boolean", 
    "is_focus_group": "boolean", 
    "keyword": "string", 
    "date_created": "datetime", 
    "id": "int"
}
GET POST OPTIONS

Description:

Provides the ability to list closed/inactive Campaigns

Model:

{
    "updated_by": "int", 
    "end_date": "datetime", 
    "title": "string", 
    "date_updated": "datetime", 
    "company": "int", 
    "created_by": "int", 
    "start_date": "datetime", 
    "default": "boolean", 
    "is_focus_group": "boolean", 
    "keyword": "string", 
    "date_created": "datetime", 
    "id": "int"
}

Test:

You can test this API using the link below.

/collate/campaigns/inactive/

GET OPTIONS

Description:

Provides the ability to list future Campaigns

Model:

{
    "updated_by": "int", 
    "end_date": "datetime", 
    "title": "string", 
    "date_updated": "datetime", 
    "company": "int", 
    "created_by": "int", 
    "start_date": "datetime", 
    "default": "boolean", 
    "is_focus_group": "boolean", 
    "keyword": "string", 
    "date_created": "datetime", 
    "id": "int"
}

Test:

You can test this API using the link below.

/collate/campaigns/future/

DELETE OPTIONS

Description:

Provides the ability to un-allocate prizes for a closed campaign

Model:

{}
POST OPTIONS

Description:

Provides the ability to un-reserve on cpp

Model:

{}
POST OPTIONS

Description:

Provides the ability to POST a message into your campaign. Messages that are posted have some set fields that are required to successfully create the message.

Required fields:
  • originator:

    The identity of the person sending the message. Usually you'd use something like the person's mobile number, email address or twitter handle. If you are giving away airtime prizes as part of the campaign the originator needs to be the person's mobile number.

  • network_id (only required for airtime prizes):

    This is only required if the campaign is giving away airtime prizes. The network id can be gotten from https://api.colonyhq.com/collate/networks/mobilenetwork/

  • message

    Simple text that will be shown in the message stream. This field will also be mined with the below fields.

All other fields passed back into the post will be used to create the message as well as mine any data from. For mining, the following fields can be used.

Optional mining fields:
  • product

    A product that could be associated to both the person and the message. If the person is entering a competition after buying a specific product you could add that to the person's profile.

  • name

    The person's full name or any part thereof.

  • gender

    The gender of the person.

  • address

    A location where the person lives or works.

  • location

    A wider type location like city etc.

  • email

    An email address that is linked to a person.

  • twitter

    A twitter handle that is linked to a person.

  • interest

    Any interest that a person has; i.e. music, movies.

  • language

    Any language that can be linked to a person.

  • mobile_number

    A mobile number that is linked to a person. Formatted with the country code; i.e. 27812213322

  • relationship

    Any relationship the person could be in; i.e. father, son, mother etc.

  • country

    The country that the person lives in.

  • id_number

    If the person has a South African ID you could post it in this field.

  • birthdate

    The date that the person was born in ISO format; i.e. YYYY-MM-DD

  • phone

    A phune number that is linked to a person. Formatted with the country code; i.e. 27115422254

  • postal_code

    A South African postal code linked to the person.

  • latitude

    The latitude of where the message originated.

  • longitude

    The longitude of where the message originated.

Response fields (returned as JSON):
  • error:

    A boolean informing you whether or not the call was successful. True if it was successful and False if not. If it is not a success then then error_code and error_text will inform you where the problem might be.

  • error_code:

    0: No fields were sent in with the POST. 1: The campaign_pk sent in as part of the URL could not be found. 2: The provider that is gleaned from the "HTTP_REFERER" header could not be found in the given campaign. 3: The originator was not sent in as a field in the POST. 4: The message was not sent in as a field in the POST.

  • error_text:

    A simple human readable text representation of the error.

  • message:

    A JSON representation of the message that was created.

  • prize_result:

    Shows results for any prizes that were or were not awarded.

Model:

{}
GET OPTIONS

Description:

Provides the ability to get a total of codes redeemed for a a campaign

Model:

{}
GET OPTIONS

Description:

Model:

{
    "twitter_count": "int", 
    "total": "int", 
    "web_hook_count": "int", 
    "campaign": "int", 
    "company": "int", 
    "mixit_count": "int", 
    "fraud_count": "int", 
    "wechat_count": "int", 
    "ussd_count": "int", 
    "period_type": "int", 
    "facebook_count": "int", 
    "period_end": "datetime", 
    "period_start": "datetime", 
    "mms_email_count": "int", 
    "id": "int", 
    "sms_count": "int", 
    "google_plus_count": "int"
}
GET OPTIONS

Description:

Model:

{}

Test:

You can test this API using the link below.

/collate/campaignstats/unique/

GET OPTIONS

Description:

Model:

{}

Test:

You can test this API using the link below.

/collate/campaignstats/topten/

GET POST OPTIONS

Description:

Provides the ability to list and create code batches.

Model:

{
    "product": "string", 
    "valid_from": "datetime", 
    "updated_by": "int", 
    "campaign": "int", 
    "title": "string", 
    "batch_num": "int", 
    "is_active": "boolean", 
    "valid_to": "datetime", 
    "date_updated": "datetime", 
    "prefix": "string", 
    "created_by": "int", 
    "date_created": "datetime", 
    "multi_use": "boolean", 
    "id": "int", 
    "code_len": "int"
}

Test:

You can test this API using the link below.

/collate/codes/batch/

POST OPTIONS

Description:

Even though its a destroy API view we inherit CreateAPIView because we do not know the pk of the used batch beforehand

Model:

{
    "code": "string", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "message": "int", 
    "id": "int", 
    "batch": "int"
}

Test:

You can test this API using the link below.

/collate/codes/batch/codereset/

GET PUT PATCH OPTIONS

Description:

Provides the ability to retrieve an individual code batch

Model:

{
    "product": "string", 
    "valid_from": "datetime", 
    "updated_by": "int", 
    "campaign": "int", 
    "title": "string", 
    "batch_num": "int", 
    "is_active": "boolean", 
    "valid_to": "datetime", 
    "date_updated": "datetime", 
    "prefix": "string", 
    "created_by": "int", 
    "date_created": "datetime", 
    "multi_use": "boolean", 
    "id": "int", 
    "code_len": "int"
}
GET OPTIONS

Description:

Ability to generate codes for a batch

Params: count - Amount of codes to generate for this batch

Model:

{}
GET OPTIONS

Description:

Ability to pass a code and check if it's valid on that batch

Model:

{}
GET OPTIONS

Description:

Provides the ability to list codes that have already been used in a batch

Model:

{
    "code": "string", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "message": "int", 
    "id": "int", 
    "batch": "int"
}

Test:

You can test this API using the link below.

/collate/codes/used/

GET OPTIONS

Description:

Provides the ability to view details on an individual batch code that has been used

Model:

{
    "code": "string", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "message": "int", 
    "id": "int", 
    "batch": "int"
}
GET OPTIONS

Description:

Provides the ability to get a total of codes redeemed for a a campaign

Model:

{}

Test:

You can test this API using the link below.

/collate/codes/redeemed/

GET POST OPTIONS

Description:

Provides the ability to add and remove access codes which can be used to allow or disallow entry into a campaign on ussd.

Model:

{
    "code": "string", 
    "updated_by": "int", 
    "campaign": "int", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "id": "int", 
    "created_by": "int", 
    "batch": "int"
}

Test:

You can test this API using the link below.

/collate/codes/accesscode/

POST OPTIONS

Description:

Allows for bulk upload of access codes for a campaign

Model:

{}
GET PUT PATCH DELETE OPTIONS

Description:

Provides the ability to retrieve, update or destroy access codes which are used to allow or disallow entry into a campaign on ussd.

Model:

{
    "code": "string", 
    "updated_by": "int", 
    "campaign": "int", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "id": "int", 
    "created_by": "int", 
    "batch": "int"
}
GET PUT PATCH DELETE OPTIONS

Description:

Provides the ability to remove large collections of access codes by supplying a batch

Model:

{
    "pool_id": "int", 
    "updated_by": "int", 
    "campaign": "int", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "company": "int", 
    "id": "int", 
    "created_by": "int", 
    "name": "string"
}
GET OPTIONS

Description:

Provides the ability to list access code batches

Model:

{
    "pool_id": "int", 
    "updated_by": "int", 
    "campaign": "int", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "company": "int", 
    "id": "int", 
    "created_by": "int", 
    "name": "string"
}

Test:

You can test this API using the link below.

/collate/codes/accesscodes/batches/

GET POST OPTIONS

Description:

Model:

{
    "code": "string", 
    "updated_by": "int", 
    "campaign": "int", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "sent": "boolean", 
    "id": "int", 
    "created_by": "int", 
    "desc": "string"
}

Test:

You can test this API using the link below.

/collate/codes/pullcode/

GET PUT PATCH DELETE OPTIONS

Description:

Model:

{
    "code": "string", 
    "updated_by": "int", 
    "campaign": "int", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "sent": "boolean", 
    "id": "int", 
    "created_by": "int", 
    "desc": "string"
}
GET OPTIONS

Description:

Model:

{
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "message": "int", 
    "id": "int", 
    "pull_code": "int"
}

Test:

You can test this API using the link below.

/collate/codes/sentpullcode/

GET OPTIONS

Description:

Model:

{
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "message": "int", 
    "id": "int", 
    "pull_code": "int"
}
GET POST OPTIONS

Description:

Provides the ability to list and create Rules

Model:

{
    "active": "boolean", 
    "entry_count": "int", 
    "updated_by": "int", 
    "campaign": "int", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "company": "int", 
    "block_time_type": "int", 
    "id": "int", 
    "created_by": "int"
}

Test:

You can test this API using the link below.

/collate/codes/accesscoderule/

GET PUT PATCH DELETE OPTIONS

Description:

Provides the ability to get and put an Access Code Rule

Model:

{
    "active": "boolean", 
    "entry_count": "int", 
    "updated_by": "int", 
    "campaign": "int", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "company": "int", 
    "block_time_type": "int", 
    "id": "int", 
    "created_by": "int"
}
POST OPTIONS

Description:

Allows for bulk upload of user codes for a campaign #

Model:

{}
POST OPTIONS

Description:

Allows for bulk upload of user codes for a campaign #

Model:

{}
GET POST OPTIONS

Description:

Model:

{
    "updated_by": "int", 
    "campaign": "int", 
    "trigger_type": "int", 
    "date_updated": "datetime", 
    "start_hour": "time", 
    "end_hour": "time", 
    "created_by": "int", 
    "emails": "list", 
    "summary_type": "int", 
    "last_run": "datetime", 
    "date_created": "datetime", 
    "id": "int"
}

Test:

You can test this API using the link below.

/collate/forwarding/

GET PUT PATCH DELETE OPTIONS

Description:

Provides the ability to list closed/inactive Campaigns

Model:

{
    "updated_by": "int", 
    "campaign": "int", 
    "trigger_type": "int", 
    "date_updated": "datetime", 
    "start_hour": "time", 
    "end_hour": "time", 
    "created_by": "int", 
    "emails": "list", 
    "summary_type": "int", 
    "last_run": "datetime", 
    "date_created": "datetime", 
    "id": "int"
}
GET POST OPTIONS

Description:

Provides the ability to list and create Rules

Model:

{
    "entry_time": "int", 
    "updated_by": "int", 
    "campaign": "int", 
    "date_updated": "datetime", 
    "company": "int", 
    "created_by": "int", 
    "suspect_time": "int", 
    "entry_time_type": "int", 
    "active": "boolean", 
    "entry_count": "int", 
    "suspect_time_type": "int", 
    "block_time": "int", 
    "date_created": "datetime", 
    "block_time_type": "int", 
    "id": "int", 
    "suspect_count": "int"
}

Test:

You can test this API using the link below.

/collate/fraud/rule/

GET PUT PATCH DELETE OPTIONS

Description:

Provides the ability to get and put a Rule

Model:

{
    "entry_time": "int", 
    "updated_by": "int", 
    "campaign": "int", 
    "date_updated": "datetime", 
    "company": "int", 
    "created_by": "int", 
    "suspect_time": "int", 
    "entry_time_type": "int", 
    "active": "boolean", 
    "entry_count": "int", 
    "suspect_time_type": "int", 
    "block_time": "int", 
    "date_created": "datetime", 
    "block_time_type": "int", 
    "id": "int", 
    "suspect_count": "int"
}
GET OPTIONS

Description:

Provides the ability to list MobileNetwork

Model:

{
    "mnc": "string", 
    "name": "string", 
    "country": "string", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "dial_code": "string", 
    "mcc": "string", 
    "id": "int"
}

Test:

You can test this API using the link below.

/collate/networks/mobilenetwork/

GET OPTIONS

Description:

Provides the ability to fetch a MobileNetwork

Model:

{
    "mnc": "string", 
    "name": "string", 
    "country": "string", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "dial_code": "string", 
    "mcc": "string", 
    "id": "int"
}
GET POST OPTIONS

Description:

Provides the ability to list and create Polls

Model:

{
    "is_active": "boolean", 
    "updated_by": "int", 
    "campaign": "int", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "question": "string", 
    "id": "int", 
    "created_by": "int"
}

Test:

You can test this API using the link below.

/collate/polls/

GET PUT PATCH OPTIONS

Description:

Provides the ability to get and put a Poll

Model:

{
    "is_active": "boolean", 
    "updated_by": "int", 
    "campaign": "int", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "question": "string", 
    "id": "int", 
    "created_by": "int"
}
GET POST OPTIONS

Description:

Provides the ability to list and create PollChoice

Model:

{
    "matches": "list", 
    "votes": "int", 
    "updated_by": "int", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "poll": "int", 
    "is_active": "boolean", 
    "id": "int", 
    "created_by": "int", 
    "choice": "string"
}

Test:

You can test this API using the link below.

/collate/polls/choice/

GET PUT PATCH OPTIONS

Description:

Provides the ability to get and put a PollChoice

Model:

{
    "matches": "list", 
    "votes": "int", 
    "updated_by": "int", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "poll": "int", 
    "is_active": "boolean", 
    "id": "int", 
    "created_by": "int", 
    "choice": "string"
}
GET POST OPTIONS

Description:

Provides the ability to list and create QRCodes

Model:

{
    "updated_by": "int", 
    "campaign": "int", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "company": "int", 
    "data": "string", 
    "id": "int", 
    "created_by": "int", 
    "image": "image file"
}

Test:

You can test this API using the link below.

/collate/qrcodes/

GET PUT PATCH DELETE OPTIONS

Description:

Provides the ability to get and put a QRCode

Model:

{
    "updated_by": "int", 
    "campaign": "int", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "company": "int", 
    "data": "string", 
    "id": "int", 
    "created_by": "int", 
    "image": "image file"
}
GET POST OPTIONS

Description:

Model:

{
    "status": "int", 
    "updated_by": "int", 
    "campaign": "int", 
    "date_updated": "datetime", 
    "csv_file": "file", 
    "company": "int", 
    "created_by": "int", 
    "from_date": "datetime", 
    "winners": "int", 
    "to_date": "datetime", 
    "error": "string", 
    "date_created": "datetime", 
    "id": "int"
}

Test:

You can test this API using the link below.

/collate/randomselector/

GET POST OPTIONS

Description:

Provides the ability for a user within a company to list and create timeslots

Model:

{
    "start_day": "int", 
    "updated_by": "int", 
    "title": "string", 
    "date_updated": "datetime", 
    "start_time": "time", 
    "created_by": "int", 
    "id": "int", 
    "end_day": "int", 
    "end_time": "time", 
    "active": "boolean", 
    "date_created": "datetime", 
    "company": "int"
}

Test:

You can test this API using the link below.

/collate/timeslots/

GET PUT PATCH OPTIONS

Description:

Provides the ability to a user within a company to retrieve individual timeslots and to modify them.

Model:

{
    "start_day": "int", 
    "updated_by": "int", 
    "title": "string", 
    "date_updated": "datetime", 
    "start_time": "time", 
    "created_by": "int", 
    "id": "int", 
    "end_day": "int", 
    "end_time": "time", 
    "active": "boolean", 
    "date_created": "datetime", 
    "company": "int"
}
GET POST OPTIONS

Description:

Provides the ability to list and create modules used for USSD sessions.

Model:

{
    "cup_module_id": "int", 
    "additionalData": "string", 
    "module_type": "int", 
    "updated_by": "int", 
    "campaign": "int", 
    "text": "string", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "id": "int", 
    "created_by": "int"
}

Test:

You can test this API using the link below.

/collate/ussd/modules/

POST OPTIONS

Description:

Kicks off ussd campaign sync to ussd server

Model:

{}
GET PUT PATCH OPTIONS

Description:

Provides the ability to get and put a Module

Model:

{
    "cup_module_id": "int", 
    "additionalData": "string", 
    "module_type": "int", 
    "updated_by": "int", 
    "campaign": "int", 
    "text": "string", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "id": "int", 
    "created_by": "int"
}
DELETE OPTIONS

Description:

Allows a user to destroy their previous session created for a campaign.

Model:

{
    "cup_module_id": "int", 
    "additionalData": "string", 
    "module_type": "int", 
    "updated_by": "int", 
    "campaign": "int", 
    "text": "string", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "id": "int", 
    "created_by": "int"
}
POST OPTIONS

Description:

Allows for bulk upload of access codes for a campaign

Model:

{}
GET PUT PATCH OPTIONS

Description:

Provides the ability to get and put a ModuleLink

Model:

{
    "source_module": "int", 
    "option": "string", 
    "target_module": "int", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "id": "int", 
    "value": "string"
}
GET OPTIONS

Description:

Model:

{}

Test:

You can test this API using the link below.

/collate/ussdreportbuilder/backends/

POST OPTIONS

Description:

Model:

{}

Test:

You can test this API using the link below.

/collate/ussdreportbuilder/generate/

GET POST OPTIONS

Description:

Model:

{}

Test:

You can test this API using the link below.

/collate/ussdreportbuilder/report/