HTTP Request Method: POST

Tips & Tricks: Use the Postman app to run a request and try it out. (Here's how)

To obtain a Donation Link, make an HTTP POST request to the following URL: https://go.causeactive.com/api/v3/donation-link/:campaignId/:donorId/:tagId

The following table describes the options you can pass in that URL:

Authentication and Test Mode

To make the request, you will need to provide authentication credentials in the HTTP POST parameters for the request.

Note, the API Key and Secret are specific to each Collection and will only work for Campaigns that are within that collection.

Success Response

{
    "information": {
        "detail": [
            "Login Succeeded.",
            "Donation link found."
        ]
    },
    "login": {
        "error": false
    },
    "userId": "6",
    "error": false,
    "donation": {
        "url": "https://go.causeactive.com/donate/2/j79p2d6Y7jQ2wBMppwSVpnCdKYjbcKdx",
        "expiration": "2023-11-07T18:17:52+00:00"
    },
    "api": true
}

Error Responses

Invalid API Credentials

{
    "errors": {
        "detail": [
            "Login Failed"
        ]
    },
    "login": {
        "error": true,
        "errorCode": 2
    },
    "api": true
}

Error with Request

{
    "errors": {
        "detail": [
            "Target campaign does not have any available donations to allocate.",
            "Request for donation link denied.",
        ]
    },
    "error": true,
    "code": 10,
    "api": true
}

Possible Error Codes, Descriptions, and Common Solutions

The following table shows all possible error codes from the API. If there is any error, the JSON response error property will be set to boolean true and one of these error codes will be returned as an int value in under the code property in the JSON response.

The codes below are grouped by category of error.

• 10-19: Donation Pool errors
• 20-29: Donation Link errors
• 30-39: Invalid data errors
• 40-49: Entity not found errors
• 9999: Invalid error code provided for test mode error check