POST api/v1/donor

Add a new Donor

Request Information

URI Parameters

None.

Body Parameters

Donor object that needs to be added

Name	Description	Type	Additional information
DonorID		string	String length: inclusive between 0 and 20
ExternalReference	How is the donor referenced in external system?	string	String length: inclusive between 0 and 50
ExternalOrigin		string	String length: inclusive between 0 and 50
Source		string	String length: inclusive between 0 and 20
DateAdd		date	None.
DateAddUTC		string	None.
NameLast		string	String length: inclusive between 0 and 40
NameFirst		string	String length: inclusive between 0 and 30
NameMiddle		string	String length: inclusive between 0 and 30
NameTitle		string	String length: inclusive between 0 and 30
NameSuffix		string	String length: inclusive between 0 and 30
Salutation		string	String length: inclusive between 0 and 30
Company		string	String length: inclusive between 0 and 50
Birthdate		date	None.
DonorType		Collection of DonorCode	None.
DonorAddress		PostalAddress	None.
SecondaryAddresses		Collection of PostalAddress	None.
Email		string	String length: inclusive between 0 and 120
SecondaryEmails		Collection of DonorEmail	None.
Phone		string	String length: inclusive between 0 and 30
SecondaryPhone		Collection of DonorPhone	None.
DonorStop		Collection of DonorCode	None.
DonorAppeal		Collection of DonorCode	None.
DonorStatus		string	String length: inclusive between 0 and 2
LastUpdated		date	None.
LastUpdatedBy		string	String length: inclusive between 0 and 200
Created		date	None.
CreatedBy		string	String length: inclusive between 0 and 200
DonorAttributes		DonorAttribute	None.

Request Formats

application/json, text/json

Sample:

{
  "DonorID": "sample string 1",
  "ExternalReference": "sample string 2",
  "ExternalOrigin": "sample string 3",
  "Source": "sample string 4",
  "DateAdd": "2025-09-04T15:06:13.058",
  "DateAddUTC": "sample string 6",
  "NameLast": "sample string 7",
  "NameFirst": "sample string 8",
  "NameMiddle": "sample string 9",
  "NameTitle": "sample string 10",
  "NameSuffix": "sample string 11",
  "Salutation": "sample string 12",
  "Company": "sample string 13",
  "Birthdate": "2025-09-04T15:06:13.058",
  "DonorType": [
    {
      "Code": "sample string 1"
    },
    {
      "Code": "sample string 1"
    }
  ],
  "DonorAddress": {
    "Line1": "sample string 1",
    "Line2": "sample string 2",
    "Line3": "sample string 3",
    "City": "sample string 4",
    "StatePR": "sample string 5",
    "PostalCode": "sample string 6",
    "Country": "sample string 7"
  },
  "SecondaryAddresses": [
    {
      "Line1": "sample string 1",
      "Line2": "sample string 2",
      "Line3": "sample string 3",
      "City": "sample string 4",
      "StatePR": "sample string 5",
      "PostalCode": "sample string 6",
      "Country": "sample string 7"
    },
    {
      "Line1": "sample string 1",
      "Line2": "sample string 2",
      "Line3": "sample string 3",
      "City": "sample string 4",
      "StatePR": "sample string 5",
      "PostalCode": "sample string 6",
      "Country": "sample string 7"
    }
  ],
  "Email": "sample string 14",
  "SecondaryEmails": [
    {
      "Email": "sample string 1"
    },
    {
      "Email": "sample string 1"
    }
  ],
  "Phone": "sample string 15",
  "SecondaryPhone": [
    {
      "Phone": "sample string 1"
    },
    {
      "Phone": "sample string 1"
    }
  ],
  "DonorStop": [
    {
      "Code": "sample string 1"
    },
    {
      "Code": "sample string 1"
    }
  ],
  "DonorAppeal": [
    {
      "Code": "sample string 1"
    },
    {
      "Code": "sample string 1"
    }
  ],
  "DonorStatus": "sample string 16",
  "LastUpdated": "2025-09-04T15:06:13.058",
  "LastUpdatedBy": "sample string 17",
  "Created": "2025-09-04T15:06:13.058",
  "CreatedBy": "sample string 18",
  "DonorAttributes": {
    "FundDesignation": "sample string 1"
  }
}

application/xml, text/xml

Sample:

<Donor xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DPCSWS.Models">
  <Birthdate>2025-09-04T15:06:13.0586223+00:00</Birthdate>
  <Company>sample string 13</Company>
  <Created>2025-09-04T15:06:13.0586223+00:00</Created>
  <CreatedBy>sample string 18</CreatedBy>
  <DateAdd>2025-09-04T15:06:13.0586223+00:00</DateAdd>
  <DateAddUTC>sample string 6</DateAddUTC>
  <DonorAddress>
    <City>sample string 4</City>
    <Country>sample string 7</Country>
    <Line1>sample string 1</Line1>
    <Line2>sample string 2</Line2>
    <Line3>sample string 3</Line3>
    <PostalCode>sample string 6</PostalCode>
    <StatePR>sample string 5</StatePR>
  </DonorAddress>
  <DonorAppeal>
    <DonorCode>
      <Code>sample string 1</Code>
    </DonorCode>
    <DonorCode>
      <Code>sample string 1</Code>
    </DonorCode>
  </DonorAppeal>
  <DonorAttributes>
    <FundDesignation>sample string 1</FundDesignation>
  </DonorAttributes>
  <DonorID>sample string 1</DonorID>
  <DonorStatus>sample string 16</DonorStatus>
  <DonorStop>
    <DonorCode>
      <Code>sample string 1</Code>
    </DonorCode>
    <DonorCode>
      <Code>sample string 1</Code>
    </DonorCode>
  </DonorStop>
  <DonorType>
    <DonorCode>
      <Code>sample string 1</Code>
    </DonorCode>
    <DonorCode>
      <Code>sample string 1</Code>
    </DonorCode>
  </DonorType>
  <Email>sample string 14</Email>
  <ExternalOrigin>sample string 3</ExternalOrigin>
  <ExternalReference>sample string 2</ExternalReference>
  <LastUpdated>2025-09-04T15:06:13.0586223+00:00</LastUpdated>
  <LastUpdatedBy>sample string 17</LastUpdatedBy>
  <NameFirst>sample string 8</NameFirst>
  <NameLast>sample string 7</NameLast>
  <NameMiddle>sample string 9</NameMiddle>
  <NameSuffix>sample string 11</NameSuffix>
  <NameTitle>sample string 10</NameTitle>
  <Phone>sample string 15</Phone>
  <Salutation>sample string 12</Salutation>
  <SecondaryAddresses>
    <PostalAddress>
      <City>sample string 4</City>
      <Country>sample string 7</Country>
      <Line1>sample string 1</Line1>
      <Line2>sample string 2</Line2>
      <Line3>sample string 3</Line3>
      <PostalCode>sample string 6</PostalCode>
      <StatePR>sample string 5</StatePR>
    </PostalAddress>
    <PostalAddress>
      <City>sample string 4</City>
      <Country>sample string 7</Country>
      <Line1>sample string 1</Line1>
      <Line2>sample string 2</Line2>
      <Line3>sample string 3</Line3>
      <PostalCode>sample string 6</PostalCode>
      <StatePR>sample string 5</StatePR>
    </PostalAddress>
  </SecondaryAddresses>
  <SecondaryEmails>
    <DonorEmail>
      <Email>sample string 1</Email>
    </DonorEmail>
    <DonorEmail>
      <Email>sample string 1</Email>
    </DonorEmail>
  </SecondaryEmails>
  <SecondaryPhone>
    <DonorPhone>
      <Phone>sample string 1</Phone>
    </DonorPhone>
    <DonorPhone>
      <Phone>sample string 1</Phone>
    </DonorPhone>
  </SecondaryPhone>
  <Source>sample string 4</Source>
</Donor>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.