Bulk
Bulk Documentation
Contacts [BULK DELETE]
Contacts [BULK DELETE]
Request
Endpoint
DELETE /api/v2/contacts/bulk
Content-Type: application/vnd.api+jsonBody
{
"data": [
{
"data": {
"type": "contacts",
"id": "cbebfd5f-815e-47c2-803e-4daf2ab8716b"
}
},
{
"data": {
"type": "contacts",
"id": "bd06aa40-5843-4fb7-8f7b-15020d96e572"
}
}
]
}Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
200 OKBody
[
{
"data": {
"id": "bd06aa40-5843-4fb7-8f7b-15020d96e572",
"type": "contacts",
"attributes": {
"avatar": "https://mpdx.org/images/avatar.png",
"church_name": null,
"created_at": "2021-11-23T14:38:31Z",
"deceased": false,
"direct_deposit": false,
"envelope_greeting": "Brian Johns",
"greeting": "",
"last_activity": null,
"last_appointment": null,
"last_donation": null,
"last_letter": null,
"last_phone_call": null,
"last_pre_call": null,
"last_thank": null,
"late_at": "2021-11-19",
"likely_to_give": null,
"locale": "en",
"magazine": false,
"missionary_pages_banner": false,
"name": "Johns, Brian",
"next_ask": null,
"no_appeals": null,
"no_gift_aid": null,
"notes": "Test Note.",
"notes_saved_at": "2021-11-23T14:38:31Z",
"pledge_amount": "100.0",
"pledge_currency": "USD",
"pledge_currency_symbol": "$",
"pledge_frequency": "1",
"pledge_received": false,
"pledge_start_date": "2021-10-19",
"preferred_contact_method": null,
"relationship_code": null,
"send_newsletter": null,
"source": "MPDX",
"square_avatar": "https://mpdx.org/images/avatar.png",
"starred_at": null,
"status": "Partner - Financial",
"status_valid": null,
"suggested_changes": {
},
"tag_list": [
],
"timezone": null,
"uncompleted_tasks_count": 0,
"updated_at": "2021-11-23T14:38:31Z",
"updated_in_db_at": "2021-11-23T14:38:31Z",
"website": "http://ohara-green.biz/jordon.pollich"
},
"relationships": {
"account_list": {
"data": {
"id": "13af0d9d-1ffd-4f26-a739-a9dbaedde6a4",
"type": "account_lists"
}
},
"user": {
"data": null
},
"addresses": {
"data": [
]
},
"appeal_contacts": {
"data": [
]
},
"appeals": {
"data": [
]
},
"contact_referrals_by_me": {
"data": [
]
},
"contact_referrals_to_me": {
"data": [
]
},
"contacts_referred_by_me": {
"data": [
]
},
"contacts_that_referred_me": {
"data": [
]
},
"donor_accounts": {
"data": [
]
},
"excluded_appeal_contacts": {
"data": [
]
},
"last_six_donations": {
"data": [
]
},
"people": {
"data": [
]
},
"pledges": {
"data": [
]
},
"tasks": {
"data": [
]
},
"primary_person": {
"data": null
},
"primary_or_first_person": {
"data": {
"type": "people"
}
},
"spouse": {
"data": null
}
}
}
},
{
"data": {
"id": "cbebfd5f-815e-47c2-803e-4daf2ab8716b",
"type": "contacts",
"attributes": {
"avatar": "https://mpdx.org/images/avatar.png",
"church_name": null,
"created_at": "2021-11-23T14:38:31Z",
"deceased": false,
"direct_deposit": false,
"envelope_greeting": "Bernardo Nikolaus",
"greeting": "",
"last_activity": null,
"last_appointment": null,
"last_donation": null,
"last_letter": null,
"last_phone_call": null,
"last_pre_call": null,
"last_thank": null,
"late_at": "2021-11-19",
"likely_to_give": null,
"locale": "en",
"magazine": false,
"missionary_pages_banner": false,
"name": "Nikolaus, Bernardo",
"next_ask": null,
"no_appeals": null,
"no_gift_aid": null,
"notes": "Test Note.",
"notes_saved_at": "2021-11-23T14:38:31Z",
"pledge_amount": "100.0",
"pledge_currency": "USD",
"pledge_currency_symbol": "$",
"pledge_frequency": "1",
"pledge_received": false,
"pledge_start_date": "2021-10-19",
"preferred_contact_method": null,
"relationship_code": null,
"send_newsletter": null,
"source": "MPDX",
"square_avatar": "https://mpdx.org/images/avatar.png",
"starred_at": null,
"status": "Partner - Financial",
"status_valid": null,
"suggested_changes": {
},
"tag_list": [
],
"timezone": null,
"uncompleted_tasks_count": 0,
"updated_at": "2021-11-23T14:38:31Z",
"updated_in_db_at": "2021-11-23T14:38:31Z",
"website": "http://mohr.net/stevie_dicki"
},
"relationships": {
"account_list": {
"data": {
"id": "13af0d9d-1ffd-4f26-a739-a9dbaedde6a4",
"type": "account_lists"
}
},
"user": {
"data": null
},
"addresses": {
"data": [
]
},
"appeal_contacts": {
"data": [
]
},
"appeals": {
"data": [
]
},
"contact_referrals_by_me": {
"data": [
]
},
"contact_referrals_to_me": {
"data": [
]
},
"contacts_referred_by_me": {
"data": [
]
},
"contacts_that_referred_me": {
"data": [
]
},
"donor_accounts": {
"data": [
]
},
"excluded_appeal_contacts": {
"data": [
]
},
"last_six_donations": {
"data": [
]
},
"people": {
"data": [
]
},
"pledges": {
"data": [
]
},
"tasks": {
"data": [
]
},
"primary_person": {
"data": null
},
"primary_or_first_person": {
"data": {
"type": "people"
}
},
"spouse": {
"data": null
}
}
}
}
]Fields
data
Type
[Contact]
Description An array of Contacts that have just been deleted
Contacts [BULK POST]
an individual element of the
dataarray
{
"data": {
"type": "contacts",
"id": "1d6393dd-f3f4-49d3-9fd8-7e758b056b1f",
"attributes": {
"name": "Steve Rogers",
"more_attributes": "...etc"
}
}
}For this bulk create endpoint, you are required to send an array of items within the data object.
Each member of the array must contain a client generated
idto be used for the Contact being created.Each member of the array must contain a
typethat has the value of'contacts'.Each member of the array must have an
attributeshash of values to be used for the Contact being created.
Request
Endpoint
POST /api/v2/contacts/bulk
Content-Type: application/vnd.api+jsonBody
{
"data": [
{
"data": {
"type": "contacts",
"id": "a6aa1c6d-1192-435b-828f-3a50a177283a",
"attributes": {
"locale": "en",
"name": "Bogan, Troy",
"notes": "Test Note.",
"pledge_amount": 100,
"pledge_frequency": 1,
"pledge_start_date": "2021-10-19 14:38:32 UTC",
"status": "Partner - Financial",
"website": "http://greenholt.info/timmy.ullrich",
"updated_in_db_at": "2021-11-23 14:38:32 UTC"
},
"relationships": {
"account_list": {
"data": {
"id": "a61fb58a-ed36-4846-b2d6-de643dd689e3",
"type": "account_lists"
}
}
}
}
}
]
}Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
200 OKBody
[
{
"data": {
"id": "a6aa1c6d-1192-435b-828f-3a50a177283a",
"type": "contacts",
"attributes": {
"avatar": "https://mpdx.org/images/avatar.png",
"church_name": null,
"created_at": "2021-11-23T14:38:32Z",
"deceased": false,
"direct_deposit": false,
"envelope_greeting": "Troy Bogan",
"greeting": "",
"last_activity": null,
"last_appointment": null,
"last_donation": null,
"last_letter": null,
"last_phone_call": null,
"last_pre_call": null,
"last_thank": null,
"late_at": "2021-11-19",
"likely_to_give": null,
"locale": "en",
"magazine": false,
"missionary_pages_banner": false,
"name": "Bogan, Troy",
"next_ask": null,
"no_appeals": null,
"no_gift_aid": null,
"notes": "Test Note.",
"notes_saved_at": "2021-11-23T14:38:32Z",
"pledge_amount": "100.0",
"pledge_currency": "USD",
"pledge_currency_symbol": "$",
"pledge_frequency": "1",
"pledge_received": false,
"pledge_start_date": "2021-10-19",
"preferred_contact_method": null,
"relationship_code": null,
"send_newsletter": null,
"source": "MPDX",
"square_avatar": "https://mpdx.org/images/avatar.png",
"starred_at": null,
"status": "Partner - Financial",
"status_valid": null,
"suggested_changes": {
},
"tag_list": [
],
"timezone": null,
"uncompleted_tasks_count": 0,
"updated_at": "2021-11-23T14:38:32Z",
"updated_in_db_at": "2021-11-23T14:38:32Z",
"website": "http://greenholt.info/timmy.ullrich"
},
"relationships": {
"account_list": {
"data": {
"id": "a61fb58a-ed36-4846-b2d6-de643dd689e3",
"type": "account_lists"
}
},
"user": {
"data": null
},
"addresses": {
"data": [
]
},
"appeal_contacts": {
"data": [
]
},
"appeals": {
"data": [
]
},
"contact_referrals_by_me": {
"data": [
]
},
"contact_referrals_to_me": {
"data": [
]
},
"contacts_referred_by_me": {
"data": [
]
},
"contacts_that_referred_me": {
"data": [
]
},
"donor_accounts": {
"data": [
]
},
"excluded_appeal_contacts": {
"data": [
]
},
"last_six_donations": {
"data": [
]
},
"people": {
"data": [
]
},
"pledges": {
"data": [
]
},
"tasks": {
"data": [
]
},
"primary_person": {
"data": null
},
"primary_or_first_person": {
"data": {
"type": "people"
}
},
"spouse": {
"data": null
}
}
}
}
]Fields
data
Type
[Contact / error]
Description Array of both Contact objects that have been successfully created and of errors related to Contact objects that were not created successfully
Contacts [BULK PUT]
Contacts [BULK PUT]
Request
Endpoint
PUT /api/v2/contacts/bulk
Content-Type: application/vnd.api+jsonBody
{
"data": [
{
"data": {
"type": "contacts",
"id": "fd833a47-6731-4fed-b2b3-fcc7da4a905a",
"attributes": {
"locale": "en",
"name": "Schuster, Luciano",
"notes": "Test Note.",
"pledge_amount": 100,
"pledge_frequency": 1,
"pledge_start_date": "2021-10-19 14:38:32 UTC",
"status": "Partner - Financial",
"website": "http://hyatt.info/trey.monahan",
"updated_in_db_at": "2021-11-23 14:38:32 UTC"
}
}
}
]
}Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
200 OKBody
[
{
"data": {
"id": "fd833a47-6731-4fed-b2b3-fcc7da4a905a",
"type": "contacts",
"attributes": {
"avatar": "https://mpdx.org/images/avatar.png",
"church_name": null,
"created_at": "2021-11-23T14:38:32Z",
"deceased": false,
"direct_deposit": false,
"envelope_greeting": "Luciano Schuster",
"greeting": "",
"last_activity": null,
"last_appointment": null,
"last_donation": null,
"last_letter": null,
"last_phone_call": null,
"last_pre_call": null,
"last_thank": null,
"late_at": "2021-11-19",
"likely_to_give": null,
"locale": "en",
"magazine": false,
"missionary_pages_banner": false,
"name": "Schuster, Luciano",
"next_ask": null,
"no_appeals": null,
"no_gift_aid": null,
"notes": "Test Note.",
"notes_saved_at": "2021-11-23T14:38:32Z",
"pledge_amount": "100.0",
"pledge_currency": "USD",
"pledge_currency_symbol": "$",
"pledge_frequency": "1",
"pledge_received": false,
"pledge_start_date": "2021-10-19",
"preferred_contact_method": null,
"relationship_code": null,
"send_newsletter": null,
"source": "MPDX",
"square_avatar": "https://mpdx.org/images/avatar.png",
"starred_at": null,
"status": "Partner - Financial",
"status_valid": null,
"suggested_changes": {
},
"tag_list": [
],
"timezone": null,
"uncompleted_tasks_count": 0,
"updated_at": "2021-11-23T14:38:32Z",
"updated_in_db_at": "2021-11-23T14:38:32Z",
"website": "http://hyatt.info/trey.monahan"
},
"relationships": {
"account_list": {
"data": {
"id": "1a63fb59-2e69-45d6-bda0-17cb5870ea6a",
"type": "account_lists"
}
},
"user": {
"data": null
},
"addresses": {
"data": [
]
},
"appeal_contacts": {
"data": [
]
},
"appeals": {
"data": [
]
},
"contact_referrals_by_me": {
"data": [
]
},
"contact_referrals_to_me": {
"data": [
]
},
"contacts_referred_by_me": {
"data": [
]
},
"contacts_that_referred_me": {
"data": [
]
},
"donor_accounts": {
"data": [
]
},
"excluded_appeal_contacts": {
"data": [
]
},
"last_six_donations": {
"data": [
]
},
"people": {
"data": [
]
},
"pledges": {
"data": [
]
},
"tasks": {
"data": [
]
},
"primary_person": {
"data": null
},
"primary_or_first_person": {
"data": {
"type": "people"
}
},
"spouse": {
"data": null
}
}
}
}
]Fields
data
Type
[Contact / error]
Description Array of both Contact objects that have been successfully updated and of errors related to Contact objects that were not updated successfully
Last updated