---
updatedAt: 2026-06-09T01:29:16.000Z
agentTools:
  projectIndex: https://docs.gliderpay.com/llms.txt
---

# LINK campaign

This API will allow you to start a Glider campaign or batch.  
After calling the API: the recipient records will be validated, a unique URL will be generated for each valid recipient and returned in the API response

This API request will return a successful response if at least one record in the CSV contains valid information.

Successful recipient records will be returned under the `recipients` JSON object.

Incorrect records will be listed under the `errors` JSON object, line and an error type will also be specified.

Successful responses will provide a batch identifier number `batchId` that can be used to retrieve batch status via the Report API.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Glider",
    "description": "All the api you need to know for Glider (former MeekiMoney)",
    "contact": {},
    "version": "2.0"
  },
  "x-readme": {
    "metrics-enabled": false,
    "samples-languages": [
      "node",
      "javascript",
      "http",
      "shell",
      "python"
    ]
  },
  "servers": [
    {
      "url": "https://api-uat.gliderpay.com",
      "description": "Sandbox"
    },
    {
      "url": "https://api.gliderpay.com",
      "description": "Production"
    }
  ],
  "paths": {
    "/v2/campaign/invoiceBatch/link": {
      "post": {
        "tags": [
          "Campaign"
        ],
        "summary": "LINK campaign",
        "description": "This API will allow you to start a Glider campaign or batch.  \nAfter calling the API: the recipient records will be validated, a unique URL will be generated for each valid recipient and returned in the API response\n\nThis API request will return a successful response if at least one record in the CSV contains valid information.\n\nSuccessful recipient records will be returned under the `recipients` JSON object.\n\nIncorrect records will be listed under the `errors` JSON object, line and an error type will also be specified.\n\nSuccessful responses will provide a batch identifier number `batchId` that can be used to retrieve batch status via the Report API.",
        "operationId": "LINKcampaign",
        "parameters": [],
        "requestBody": {
          "description": "",
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/LINKcampaignRequest"
                  }
                ]
              },
              "examples": {
                "basic": {
                  "summary": "Basic Link campaign",
                  "value": {
                    "name": "",
                    "handler": "",
                    "isInstalment": false,
                    "portalTemplate": "",
                    "expiryTime": 0,
                    "planRate": 0,
                    "planMaxTerm": 0,
                    "planMaxTermPeriod": "",
                    "recipients": [
                      {
                        "account_number": "",
                        "amount": 0,
                        "name": "",
                        "attachment": "",
                        "custom1_label": "Creditor",
                        "custom1_value": "",
                        "custom2_label": "Service",
                        "custom2_value": "",
                        "custom3_label": "Address",
                        "custom3_value": "",
                        "planRate": 0,
                        "planMaxTerm": 0,
                        "planMaxTermPeriod": ""
                      }
                    ]
                  }
                },
                "fixedPlan": {
                  "summary": "Fixed payment plan campaign",
                  "value": {
                    "name": "",
                    "handler": "",
                    "fixedPlan": true,
                    "recipients": [
                      {
                        "account_number": "",
                        "amount": 0,
                        "name": "",
                        "planSuggestions": [
                          {
                            "startDate": "2025-01-01",
                            "amount": "0",
                            "frequency": "weekly"
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LinkCampaignResponseObject"
                }
              }
            }
          }
        },
        "deprecated": false,
        "security": [
          {
            "bearer": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "LINKcampaignRequest": {
        "title": "LINKcampaignRequest",
        "required": [
          "name",
          "recipients"
        ],
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Name of the Glider Campaign (must be unique)"
          },
          "handler": {
            "type": "string",
            "description": "Agent ID to be stored for reporting as part of the campaign"
          },
          "isInstalment": {
            "type": "boolean",
            "description": "(false by default) If true, the invoices created will give the ability to the user to choose between \"pay now\" or a tailored payment plan",
            "default": false
          },
          "portalTemplate": {
            "type": "string",
            "description": "Payment Portal Introduction text (see above paragraph for more details)"
          },
          "expiryTime": {
            "type": "integer",
            "minimum": 0,
            "description": "Invoice TTL (in seconds) from the campaign scheduled time"
          },
          "planRate": {
            "type": "number",
            "minimum": 0,
            "maximum": 100,
            "description": "Annual interest rate if the campaign allows instalments, in percent (e.g.: 3.5% => 3.5)"
          },
          "planMaxTerm": {
            "type": "integer",
            "description": "Maximum length of the term (if max term period is not defined this value is intended in years)"
          },
          "planMaxTermPeriod": {
            "type": "string",
            "description": "Defines the period/unit of the above value planMaxTerm, values accepted: day, week, month, year",
            "enum": [
              "day",
              "week",
              "month",
              "year"
            ]
          },
          "fixedPlan": {
            "type": "boolean",
            "description": "If set to true, this flag enforces a fixed payment plan for each recipient. This means that the recipient cannot choose a custom plan—they can only accept the provided plan as-is and register their preferred payment method."
          },
          "recipients": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Recipient1"
            },
            "description": ""
          }
        }
      },
      "LinkCampaignResponseObject": {
        "type": "object",
        "title": "Batch Object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Name of the campaign"
          },
          "recipients": {
            "type": "array",
            "description": "Recipient records",
            "items": {
              "type": "object",
              "properties": {
                "account_number": {
                  "type": "string",
                  "description": "Account number of recipient"
                },
                "invoice_id": {
                  "type": "integer",
                  "description": "Invoice identifier"
                },
                "link": {
                  "type": "string",
                  "description": "Url of the invoice"
                },
                "qr": {
                  "type": "string",
                  "description": "Url for the QR code of the invoice link"
                }
              }
            }
          },
          "errors": {
            "type": "array"
          },
          "id": {
            "type": "integer",
            "description": "Batch identifier"
          },
          "status": {
            "type": "integer",
            "description": "Status of the request. Will always be <code>2</code> if request is successful"
          },
          "numberOfRecords": {
            "type": "integer",
            "description": "Number of records created"
          },
          "numberOfInvoices": {
            "type": "integer",
            "description": "Number of invoices created"
          },
          "isInstalment": {
            "type": "boolean",
            "description": "Flag if the campaign allowed instalment"
          },
          "channel": {
            "type": "string",
            "description": "Channel used to create the campaign",
            "enum": [
              "link"
            ]
          }
        }
      },
      "Recipient1": {
        "title": "Recipient1",
        "required": [
          "account_number",
          "amount"
        ],
        "type": "object",
        "properties": {
          "account_number": {
            "type": "string",
            "description": "User identifier"
          },
          "amount": {
            "type": "number",
            "minimum": 0,
            "description": "Invoice amount value",
            "default": 200
          },
          "name": {
            "type": "string",
            "description": "User's name",
            "default": "John Doe"
          },
          "attachment": {
            "type": "string",
            "description": "A publicly accessible URL pointing to the file you wish to attach. The URL must use HTTPS and remain reachable by our servers in order to successfully download and include the attachment."
          },
          "custom1_label": {
            "type": "string"
          },
          "custom1_value": {
            "type": "string"
          },
          "custom2_label": {
            "type": "string"
          },
          "custom2_value": {
            "type": "string"
          },
          "custom3_label": {
            "type": "string"
          },
          "custom3_value": {
            "type": "string"
          },
          "planRate": {
            "type": "number",
            "minimum": 0,
            "maximum": 100,
            "description": "Annual interest rate if the campaign allows instalments, in percent (e.g.: 3.5% => 3.5)"
          },
          "planMaxTerm": {
            "type": "integer",
            "description": "Maximum length of the term (if max term period is not defined this value is intended in years)"
          },
          "planMaxTermPeriod": {
            "type": "string",
            "description": "Defines the period/unit of the above value planMaxTerm, values accepted: day, week, month, year",
            "enum": [
              "day",
              "week",
              "month",
              "year"
            ]
          },
          "planSuggestions": {
            "type": "array",
            "description": "When fixedPlan is enabled, each recipient must include at least one plan suggestion. This field defines the pre-approved payment schedule the recipient must follow.",
            "items": {
              "type": "object",
              "required": [
                "startDate",
                "frequency",
                "amount"
              ],
              "properties": {
                "startDate": {
                  "type": "string",
                  "format": "date",
                  "description": "When the recurring plan starts."
                },
                "frequency": {
                  "type": "string",
                  "enum": [
                    "weekly",
                    "fortnightly",
                    "monthly"
                  ],
                  "description": "Frequency of instalments (e.g. monthly, weekly)"
                },
                "amount": {
                  "type": "string",
                  "description": "Amount to be charged on each instalment."
                }
              }
            }
          }
        },
        "example": {
          "account_number": "",
          "amount": 0,
          "name": "",
          "attachment": "",
          "custom1_label": "Creditor",
          "custom1_value": "",
          "custom2_label": "Service",
          "custom2_value": "",
          "custom3_label": "Address",
          "custom3_value": "",
          "planRate": 0,
          "planMaxTerm": 0,
          "planMaxTermPeriod": ""
        }
      }
    },
    "securitySchemes": {
      "bearer": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "security": [],
  "tags": [
    {
      "name": "Campaign"
    }
  ]
}
```