MojoTxt API

MojoTxt API

Developer Guide: v1

URLs | Authentication | Objects | Results | Error Codes

API URLs

Any API endpoint can be accessed with either HTTP GET or POST. Objects that are associated with a phone number require the phone number as part of the URL, which must be expressed in international format (i.e. "+15555550100").

Objects that require a phone number use this URL scheme:

https://app.mojotxt.com/api/v1/{phone_number}/{object}/{verb}/{parameter}

Objects that do not require a phone number use this URL scheme:

https://app.mojotxt.com/api/v1/{object}/{verb}/{parameter}

Authentication

Visit the Integrations page of your account (API Keys tab) to generate your MojoTxt API credentials. Once you have obtained your API credentials, authenticate your requests with them using HTTP basic authentication.

Objects

Results

API results are returned in JSON format. When a list has no matching records, "record_count" is 0 and "records" is null.

Example Successful API Call:

GET https://app.mojotxt.com/api/v1/+15555550100/donations/list?Sort=DonationID

{
    "result": "success",               /* Test for "success" to determine a successful result.  */
    "timestamp": 1793491200,           /* The server's current UNIX timestamp.                  */
    "request": {                       /* The server will echo back all received parameters.    */
        "Sort": "DonationID",          /* Sort parameter (sent in querystring)                  */
        "object": "donations",         /* object (sent in URL)                                  */
        "verb": "list",                /* verb (sent in URL)                                    */
        "phone": "+15555550100"        /* phone_number (sent in URL)                            */
    },
    "record_count": 1,                 /* The number of records in this result set.             */
    "records": [                       /* An array containing the record(s) requested.          */
        {
            "DonationID": 103,
            "KeywordID": 412,
            "Keyword": "GIVE",
            "FundName": "General Fund",
            "DefaultAmount": null,
            "RecurringScheduleID": 0,
            "CCBFund": 1
        }
    ]
}

Example Unsuccessful API Call:

In this example, a DonationID is not included at the end of the URL.

GET https://app.mojotxt.com/api/v1/+15555550100/donations/get

{
    "result": "error",                                 /* "error" indicates a problem occurred. */
    "error_code": "1200",                              /* the error code                        */
    "error_message": "No Donation object specified.",  /* a human-readable error message        */
    "timestamp": 1793491200,                           /* the server's current UNIX timestamp   */
    "request": {                                       /* all received parameters               */
        "object": "donations",
        "verb": "get",
        "phone": "+15555550100"
    }
}

The "error_code" field is a number for codes below 1100 (for example, 1010) and a string for codes 1100 and above (for example, "1200").

Error Codes