Donor Tools

Soft Credits - Donor Tools User Guide

Soft Credits

Soft Credits provide a way to associate one or more people (who are not the donor) with a donation.

Read about Soft Crediting a Donation in our Userguide

Get a List of All Soft Credits

Request

GET /soft_credits.xml             # all soft credits
GET /personas/1/soft_credits.xml  # scope by persona

Response

Status: 200 OK 
<?xml version="1.0" encoding="UTF-8"?>
<soft-credits type="collection">
  <current_page type="integer">1</current_page>
  <per_page type="integer">30</per_page>
  <total_entries type="integer">7</total_entries>
  <soft-credit>
    <id type="integer">10000</id>
    <created-at type="datetime">2010-09-07T22:08:40Z</created-at>
    <updated-at type="datetime">2010-09-07T22:08:40Z</updated-at>
    <notes nil="true"></notes>
    <persona-id>10000</persona-id>
    <donation-id type="integer">100000</donation-id>
    <soft-credit-type-id>1</soft-credit-type-id>
  </soft-credit>
  <soft-credit>
    ...
  </soft-credit>
  ...
</soft-credits>

Creating Soft Credits

Soft credits aren't created directly. Instead, they are assigned when creating a donation. To create a Soft Credit, use the Donations API.

You can either pass the ID of a Persona, or you can use the special "find-or-create-persona" node.

Example 1: Find or Create Persona

"Find or create persona" will attempt to find an exact match by name and address. If no match is found, or if there is more than one exact match, then a new Persona record will be created.

Request

POST /donations.xml 
<?xml version="1.0" encoding="UTF-8"?>
<donation>
  ...
  <soft-credits type="array">
    <soft-credit>
      <find-or-create-persona>
        <first-name>Frank</first-name>
        <last-name>Fundraiser</last-name>
      </find-or-create-persona>
      <soft-credit-type-id type="integer">1</soft-credit-type-id>
    </soft-credit>
  </soft-credits>
</donation>

Example 2: Persona Id

Alternatively, if the ID of the persona is known, you can pass it through the soft credit node.

Request

POST /donations.xml 
<?xml version="1.0" encoding="UTF-8"?>
<donation>
  ...
  <soft-credits type="array">
    <soft-credit>
      <persona-id>1</persona-id>
      <soft-credit-type-id type="integer">1</soft-credit-type-id>
    </soft-credit>
  </soft-credits>
</donation>