> For the complete documentation index, see [llms.txt](https://docs.anedot.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.anedot.com/integrations/crm-donor-management/aegis.md).

# Aegis

Integrate Anedot with Aegis Premier Solutions to automatically relay donor and lead data using custom fields for accurate CRM syncing.

Integrate Anedot with Aegis Premier Solutions to automatically relay donor and lead data using custom fields for accurate CRM syncing.

Aegis Premier Solutions is a nonprofit CRM platform designed for donor management, fundraising tools, analytics, and reporting.

Anedot's integration with Aegis enables the automatic relay of supporter data from Donation and Lead Pages, simplifying backend workflows and keeping your CRM up to date with the latest fundraising activity.

## Connect Anedot to Aegis

To connect your Anedot fundraising account to Aegis:

1. Navigate to **Settings → Integrations → Directory** in your Anedot dashboard.
2. Click **+ New Connection** in the upper right corner.
3. Select **Aegis** from the integrations list.
4. Choose the Action Pages you want to sync with Aegis.
   * By default, all Action Pages are included.
   * To exclude specific pages, enter a comma-separated list of Action Page IDs.
   * You may also scope the integration by **Team** if desired.
5. Enter your Aegis Premier Solutions URL.
6. Enter your Aegis Username.
7. Enter your Aegis Password.
8. Provide your Context Key.
9. Add your Fund Code.
10. Click **Create integration** to complete the setup.

The Action Pages, Team, and credentials can be updated at any time after setup. For assistance locating Aegis credentials, contact Aegis Technical Support directly.

## Data Relays

Anedot relays data to Aegis from both Donation Pages and Lead Pages.

For relays to be successful, these pages must include:

* A field labeled `appeal_id`, set as a Custom Hidden Field.
* Fields labeled `custom_flag` and `custom_data_field` to pass additional metadata.

These hidden fields ensure the correct data is delivered to Aegis partners.

### Custom Flags

To enable flag-based data relays:

* Add a Custom Hidden Field with the key `custom_flag_1` using the Action Page Builder.
* Additional flags must follow the same pattern: `custom_flag_2`, `custom_flag_3`, and so on.
* Assign a Page-Specific Value to each field in **Settings → Sharing → Page-Specific Values**.

Field names must match exactly. Typos or mismatches prevent data from relaying correctly.

### Custom Data Fields

To send custom product-related data:

* Add a Custom Hidden Field with the key `custom_data_field_1`.

For Aegis users tracking product orders, add a `product_sku` field. This appears in Aegis under the `productOrders` area as `productSKU`.

## Viewing Data in Aegis

Once relays are successfully processed, locate transactions in Aegis by navigating to **Partners → Locate Transactions**. Use this tool to search by contact or transaction ID.

### Relay Fields

| Anedot Field                                                                                            | Aegis Field                                                                                                                     |
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| fundcode (from Setup); `{amount}` (×100); TRUE/FALSE                                                    | gifts `{fundCode}` `{pledgeID}` `{giftAmount}` `{applyToPledge}`                                                                |
| `"internet"`                                                                                            | channel                                                                                                                         |
| donation `{amount}` (×100); `{lastDigits}`; `"Paid"`; `{payMethod}` (Donations)                         | payment `{amount}` `{number}` `{status}` `{paymentType}`                                                                        |
| `[firstName]` `[lastName]`; address `{city}` `{region}` `{country}` `{line1}` `{line2}` `{postalCode}`  | shipping `{shipto}` `{shiptoCity}` `{shiptoState}` `{shiptoCountry}` `{shiptoAddress1}` `{shiptoAddress2}` `{shiptoPostalCode}` |
| Aegis Field                                                                                             | partnerID                                                                                                                       |
| `*appeal_id`                                                                                            | appealCode                                                                                                                      |
| value (from Product Details); `"0.0"`; fundcode (from Setup); `"1"`; InternalSKU (from Product Details) | productOrders `{price}` `{discount}` `{fundCode}` `{quantity}` `{productSKU}`                                                   |
| (Submission) id                                                                                         | referenceNumber                                                                                                                 |
| created\_at                                                                                             | transactionDate                                                                                                                 |
| `"Anedot UID: [Submission id] OnlineContribution (Source:[source_code])"`                               | transactionNote                                                                                                                 |
| totalAmount (×100)                                                                                      | totalTransactionAmount                                                                                                          |

\* Custom hidden field that must be added to the Anedot Action Page in order to be relayed.

\*\* The discount is greater than 0 if the donation amount is below the value amount specified in the Product's Details.

Anedot stores the Amount in cents.

## Payload Data

### Request Headers

```json
{}
```

### Request Body (Success, Create Partner)

```json
{
  "createPartner": {
    "city": "New Orleans",
    "email": "annie@anedot.com",
    "address1": "1340 Poydras St",
    "address2": null,
    "lastName": "Dot",
    "firstName": "Annie",
    "stateProv": "LA",
    "postalCode": "70112",
    "countryCode": "US",
    "customFlags": [],
    "originSource": "Web",
    "partnerPhones": [{
      "number": "2015550123"
    }],
    "customDataFields": []
  },
  "createDonation": {
    "gifts": [{
      "fundCode": "DEFAULT",
      "pledgeID": null,
      "giftAmount": 25.00,
      "applyToPledge": false
    }],
    "channel": "Internet",
    "payment": {
      "amount": 25,
      "number": "5454",
      "status": "Paid",
      "paymentType": "CreditCard"
    },
    "shipping": {
      "shipto": "Annie Dot",
      "shiptoCity": "New Orleans",
      "shiptoState": "LA",
      "shiptoCountry": "US",
      "shiptoAddress1": "1340 Poydras St",
      "shiptoAddress2": null,
      "shiptoPostalCode": "70112"
    },
    "partnerID": "2617081",
    "appealCode": "W2403_TPOC",
    "productOrders": [{
      "price": 11.55,
      "discount": 0,
      "fundCode": "DEFAULT",
      "quantity": 1,
      "productSKU": "PK_POC_3DAY_GEN1"
    }],
    "referenceNumber": "53b5e566-7b92-4913-9c50-b2caf262d56d",
    "transactionDate": "2024-03-29T14:30:13.738Z",
    "transactionNote": "Anedot UID: 53b5e566-7b92-4913-9c50-b2caf262d56d\nOnline Contribution (Source: WEB)",
    "totalTransactionAmount": 25
  },
  "findPartnerByEmail": {
    "get": "partner/Email"
  },
  "findPartnerByNameAndAddress": {
    "get": "partner/Search"
  }
}
```

### Request Body (Success, Create Donation)

```json
{
  "gifts": [
    {
      "fundCode": "DEFAULT Test Fund",
      "pledgeID": null,
      "giftAmount": 50,
      "applyToPledge": false
    }
  ],
  "channel": "Internet",
  "payment": {
    "amount": 50,
    "number": "1111",
    "status": "Paid",
    "paymentType": "CreditCard"
  },
  "shipping": {
    "shipto": "Annie Dot",
    "shiptoCity": "New Orleans",
    "shiptoState": "LA",
    "shiptoCountry": "US",
    "shiptoAddress1": "1340 Poydras Street",
    "shiptoAddress2": null,
    "shiptoPostalCode": "70113"
  },
  "partnerID": "0000000",
  "appealCode": "W0000A0A",
  "productOrders": null,
  "referenceNumber": "affa9ef5-f4c3-4984-be25-5616abe46237",
  "transactionDate": "2023-01-25T15:30:55.851Z",
  "transactionNote": "Anedot UID: affa9ef5-f4c3-4984-be25-5616abe46237\nOnline Contribution (Source: stub)",
  "totalTransactionAmount": 50
}
```

### Response Body (Success)

```json
{
  "Gifts": [
    {
      "FundCode": "DEFAULT Test Fund",
      "PledgeID": null,
      "GiftAmount": 50,
      "ApplyToPledge": false,
      "MatchingContactID": null,
      "EstimatedPercentage": null
    }
  ],
  "Notes": [],
  "Channel": "Internet",
  "Payment": {
    "Bank": null,
    "City": null,
    "Amount": 50,
    "Number": "1111",
    "Status": "Received",
    "Country": null,
    "ExpDate": null,
    "ExtraID": null,
    "Address1": null,
    "Address2": null,
    "LastName": null,
    "FirstName": null,
    "MiddleName": null,
    "PostalCode": null,
    "PaymentType": "CreditCard",
    "ContactPhone": null,
    "EmailAddress": null,
    "StateProvince": null,
    "UpdatePrimaryEmailAddress": false,
    "UpdatePrimaryMailingAddress": false
  },
  "Shipping": {
    "Shipto": "Annie Dot",
    "ShiptoCity": "New Orleans",
    "ShiptoState": "LA",
    "ShippingNote": null,
    "ShiptoCountry": "US",
    "ShippingMethod": null,
    "ShiptoAddress1": "1340 Poydras Street",
    "ShiptoAddress2": null,
    "ShiptoPostalCode": "70113",
    "ShippingOverridden": false
  },
  "BatchType": "Web",
  "PartnerID": "0000000",
  "TaxAmount": 0,
  "AppealCode": "W0000A0A",
  "Attributes": [],
  "RecordedBy": null,
  "MediaOutlet": null,
  "SegmentCode": null,
  "MediaProgram": null,
  "ShippingCost": 0,
  "BatchCategory": null,
  "InvoiceNumber": "2213291",
  "ProductOrders": [],
  "ReferenceNumber": "affa9ef5-f4c3-4984-be25-5616abe46237",
  "TransactionDate": "2023-01-25T15:30:55.851+00:00",
  "TransactionNote": "Anedot UID: affa9ef5-f4c3-4984-be25-5616abe46237\nOnline Contribution (Source: stub)",
  "Acknowledgements": [],
  "DefaultPaymentType": null,
  "ResponsesOverridden": false,
  "TotalTransactionAmount": 50
}
```

### Response Body (When productOrders Is Present)

```json
{
  "create_donation": {
    "gifts": [{
      "fundCode": "DEFAULT Pathway to Victory Ministry Fund",
      "pledgeID": null,
      "giftAmount": 12.0,
      "applyToPledge": false
    }],
    "channel": "Internet",
    "payment": {
      "amount": 12.0,
      "number": "5454",
      "status": "Paid",
      "paymentType": "CreditCard"
    },
    "shipping": {
      "shipto": "Annie Dot",
      "shiptoCity": "New Orleans",
      "shiptoState": "LA",
      "shiptoCountry": "US",
      "shiptoAddress1": "1340 Poydras St",
      "shiptoAddress2": null,
      "shiptoPostalCode": "70114"
    },
    "partnerID": "2557459",
    "appealCode": "W2207A1A",
    "productOrders": [{
      "discount": 0,
      "fundCode": "DEFAULT Pathway to Victory Ministry Fund",
      "quantity": 1,
      "productSKU": "2452808"
    }],
    "referenceNumber": "ae2f4940-1c3e-4a07-9d2e-69653e3bce2c",
    "transactionDate": "2023-11-17T20:37:16.867Z",
    "transactionNote": "Anedot UID: ae2f4940-1c3e-4a07-9d2e-69653e3bce2c\nOnline Contribution (Source: Web)",
    "totalTransactionAmount": 12.0
  },
  "find_partner_by_email": {
    "get": "partner/Email"
  },
  "find_partner_by_name_and_address": {
    "get": "partner/Search"
  }
}
```

### Response Body (Error)

```json
{}
```

### Response Body (Failure)

```json
{
  "Message": "The appeal could not be found in Aegis CRM. Appeal Code: 'W0000A0A'."
}
```

### Response Status (Success)

```
201
```

### Response Status (Failure)

```
400
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.anedot.com/integrations/crm-donor-management/aegis.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
