Bulk
Bulk Documentation
Tags [BULK DELETE]
Tags [BULK DELETE]
Request
Endpoint
DELETE /api/v2/contacts/tags/bulk
Content-Type: application/vnd.api+jsonBody
{
"data": [
{
"data": {
"type": "tags",
"attributes": {
"name": "tag_one"
}
}
},
{
"data": {
"type": "tags",
"attributes": {
"name": "tag_two"
}
}
}
],
"filter": {
"contact_ids": "8b62498e-fa33-442e-b880-b496da9b0cff,81122808-d530-4d2a-8864-422f223e4af8"
}
}Parameters
Filters
account_list_id
Type ID string
Description
The ID of an Account List to scope the tasks to
Required No
task_ids
Type string (comma delimited IDs)
Description A comma delimited list of Task IDs to remove the Tag from. If ommited the Tag will be removed from all Tasks.
Required No
Attributes
name
Type
string
Description The name of the Tag to be deleted
Required No
Response
Headers
204 No ContentBody
Tags [BULK POST]
Tags [BULK POST]
Request
Endpoint
POST /api/v2/contacts/tags/bulk
Content-Type: application/vnd.api+jsonBody
{
"data": [
{
"data": {
"type": "tags",
"attributes": {
"name": "tag_one"
}
}
},
{
"data": {
"type": "tags",
"attributes": {
"name": "tag_two"
}
}
}
],
"filter": {
"contact_ids": "b821bf8f-8b81-4d5d-a8ae-2fdba4ed6fc3,8643d33d-2523-4f09-9b74-0854b33f37a7"
}
}Parameters
Filters
account_list_id
Type ID string
Description
The ID of an Account List to scope the tasks to
Required No
task_ids
Type string (comma delimited IDs)
Description A comma delimited list of Task IDs to add the Tag to. If ommited the Tag will be added to all Tasks.
Required No
Attributes
name
Type
string
Description The name of the Tag to be added
Required No
Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
200 OKBody
[
{
"data": {
"id": "b821bf8f-8b81-4d5d-a8ae-2fdba4ed6fc3",
"type": "contacts",
"attributes": {
"avatar": "https://mpdx.org/images/avatar.png",
"church_name": null,
"created_at": "2022-01-12T17:18:27Z",
"deceased": false,
"direct_deposit": false,
"envelope_greeting": "Randy Kuvalis",
"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": "2022-01-08",
"likely_to_give": null,
"locale": "en",
"magazine": false,
"missionary_pages_banner": false,
"name": "Kuvalis, Randy",
"next_ask": null,
"no_appeals": null,
"no_gift_aid": null,
"notes": "Test Note.",
"notes_saved_at": "2022-01-12T17:18:27Z",
"pledge_amount": "100.0",
"pledge_currency": "USD",
"pledge_currency_symbol": "$",
"pledge_frequency": "1",
"pledge_received": false,
"pledge_start_date": "2021-12-08",
"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": [
"tag_one",
"tag_two"
],
"timezone": null,
"uncompleted_tasks_count": 0,
"updated_at": "2022-01-12T17:18:27Z",
"updated_in_db_at": "2022-01-12T17:18:27Z",
"website": "http://dooley.co/felipe"
},
"relationships": {
"account_list": {
"data": {
"id": "ae570f11-9405-4f7b-b3fc-30dc6940c1ea",
"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": "8643d33d-2523-4f09-9b74-0854b33f37a7",
"type": "contacts",
"attributes": {
"avatar": "https://mpdx.org/images/avatar.png",
"church_name": null,
"created_at": "2022-01-12T17:18:27Z",
"deceased": false,
"direct_deposit": false,
"envelope_greeting": "Ronny Leannon",
"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": "2022-01-08",
"likely_to_give": null,
"locale": "en",
"magazine": false,
"missionary_pages_banner": false,
"name": "Leannon, Ronny",
"next_ask": null,
"no_appeals": null,
"no_gift_aid": null,
"notes": "Test Note.",
"notes_saved_at": "2022-01-12T17:18:27Z",
"pledge_amount": "100.0",
"pledge_currency": "USD",
"pledge_currency_symbol": "$",
"pledge_frequency": "1",
"pledge_received": false,
"pledge_start_date": "2021-12-08",
"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": [
"tag_one",
"tag_three",
"tag_two"
],
"timezone": null,
"uncompleted_tasks_count": 0,
"updated_at": "2022-01-12T17:18:27Z",
"updated_in_db_at": "2022-01-12T17:18:27Z",
"website": "http://prosacco.io/lea"
},
"relationships": {
"account_list": {
"data": {
"id": "ae570f11-9405-4f7b-b3fc-30dc6940c1ea",
"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
Attributes
created_at
Type
date
Description The timestamp of when this resource was created
updated_at
Type
date
Description The timestamp of when this resource was last updated
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
Last updated