Contact with Soft Credit

contact_with_soft_credit (example on postman)

Import format for sending contact information in with soft credits

Body Params

data_format
string
action_type
string
data_type
string

The id field is specific to the API application you have created on your account. This used to keep duplicates out. The same contact record can be specified multiple times without causing duplicates.

If id is not provided then to remove duplicates we perform a record match by firstname + lastname + email or company_name + email. This is not ideal and poses a risk to your data, so please try to specify an identifier.

If soft_credit_id is not provided then we will generate a guid for it internally.

columns
required
notes
example
type

id

No

Contact ID

123ABC

String

first_name

Yes unless company_name is populated

last_name

Yes unless company_name is populated

String

company_name

Yes unless first and last name are populated

String

email

No

valid email address

String

alt_email

No

valid email address

String

addr1

No

String

addr2

No

String

city

No

String

state

No

state abbreviation TN,NY

String

postal

No

valid country postal code. 5 digits if United States

String

country

No

United States

http://www.worldatlas.com/aatlas/ctycodes.htm the full name from the list above. the A2 (ISO) code also can be used.

title

No

Example: Mr., Ms., Dr.

String

birthday

No

yyyy/mm/dd
yyyy-mm-dd

String

primary_phone

No

digits or with () - -

String

alt_phone

No

String

fax_phone

No

String

spouse_first

No

String

spouse_last

No

String

gender

No

Male = M, Female=F, Unknown=U. if blank the gender will be guessed based on name

M

M/F/U

updated_at

No
Yes if action = update

integer for unix timestamp (jan 1 1970) or string in UTC of ISO8601 or RFC3339 format

If not specified it will be set to pledge_time.

This field is required if an update is being performed

1444762572
2015-10-13 18:56:12 UTC
2015-10-13T18:56:12+00:00

String,Integer

created_at

no

integer for unix timestamp (jan 1 1970) or string in UTC of ISO8601 or RFC3339 format

If not specified it will be set to pledge_time.

This field is required if an update is being performed

1444762572
2015-10-13 18:56:12 UTC
2015-10-13T18:56:12+00:00

String,Integer

soft_credit_id

Yes

234DEF

amount_in_cents

Yes

5000 = $50

500

soft_credit_time

Yes

when non cash gift was created

integer for unix timestamp (jan 1 1970) or string in UTC of ISO8601 or RFC3339 format

1444762572
2015-10-13 18:56:12 UTC
2015-10-13T18:56:12+00:00

String,Integer

soft_credit_updated_at

No
Yes if action = update

integer for unix timestamp (jan 1 1970) or string in UTC of ISO8601 or RFC3339 format

If not specified it will be set to pledge_time.

This field is required if an update is being performed

campaign

No

event or category of transaction. Defaults to Partner Name

https://support.kindful.com/hc/en-us/articles/217204108

Gala, General, Mail Appeal

String

campaign_id

No

campaign identifier to minimize duplicates

String

parent_campaign

No

parent_campaign is only needed if you organize your campaigns in a hierarchy (for example, you organize your campaigns into categories). If parent_campaign is provided, it will be the parent of the provided campaign.

Events, Galas

String

parent_campaign_id

No

String

fund

No

larger group or fund of where the money ends up

https://support.kindful.com/hc/en-us/articles/217204108

General, Restricted, Africa

String

fund_id

No

fund identifier to minimize duplicates

String

acknowledged

No

used to determine if additional communication has occurred in addition to a transaction receipt email

Y,N,0,1,true,false

boolean

soft_credit_note

No

text details about soft credit