Account and Permissions-Authentication Token

Account and Permissions-Organization

Get the Organizations the current user belongs to Get the Current Organization for the current user Switch the Current Organization

Account and Permissions-Permission

Get Permissions for the current user

Contacts and Individuals-Contacts-How to Get Contacts

Get a Contact Get a Contact by Reference Source and ID Get a Contact by Reference ID Get Contacts by Tag ID Find a Contact by Email Address or Reference Source and ID Find all Contacts that match, fully or partially, the given search parameters Find all Contacts within a given proximity of a geocoordinate Get the Activity for the Contacts the current user is following Get the Contacts the current user is following

Contacts and Individuals-Contacts-How to Create and Update Contacts

Create a Contact Update a Contact Archive a Contact Unarchive a Contact Follow or Unfollow a Contact for the current user

Contacts and Individuals-Contacts-Working with Collections

Get Custom Collections for Contacts Create Collection for a Contact Update Collection for a Contact Delete Collection for a Contact

Contacts and Individuals-Contacts-Contact Imports

Create a Contact that will go through the import process Create a Contact Import that will be processed for changes and duplicates

Contacts and Individuals-Contacts-Configuration

Get Contact Name Prefixes and Titles Get Contact Types Get Contact Custom Fields Available

Contacts and Individuals-Contacts-Contact Queries

Get Contact Query Options Query Contacts with Abbreviated Details Query Contacts with Full Details

Contacts and Individuals-Contacts-Receipts

Receipts Get Receipt

Contacts and Individuals-Individuals-How to Get Individuals

Get Individuals for a Contact Get an Individual Find an individual by email address Gets the avatar for a specified contact individual

Contacts and Individuals-Individuals-How to Create and Update

Create an Individual Upload the avatar for an Individual Update an Individual Delete an Individual

Contacts and Individuals-Individuals-Working with Collections

Get Custom Collections for Individuals Create Collection for an Individual Update Collection for an Individual Delete Collection for an Individual

Contacts and Individuals-Individuals-Configuration

Gets the custom fields for contact individuals

Contacts and Individuals-Individuals-Individual Queries

Get Individual Query Options Query Individuals

Contacts and Individuals-Individuals-Email Lists

Get Email Lists for an Individual

Contacts and Individuals-Contact Addresses

Get the Contact Addresses for a Contact Get a Contact Address Create a Contact Address Update a Contact Address Archive a Contact Address Unarchive a Contact Address Delete a Contact Address

Contacts and Individuals-Contact Methods

Get Contact Method Types Get Contact Methods Types related to the Base Type Get a Contact Method Create a Contact Method for an Individual Update a Contact Method Archive a Contact Method Unarchive a Contact Method Delete a Contact Method

Contacts and Individuals-Contact Notes

Get the Notes for a Contact Get the Important Notes for a Contact Get a Note Create a Note for a Contact Create a Note using an Email Update a Note Delete a Note Get Contact Note Query Options Query Contact Notes Get Contact Note Types Gets the custom fields for contact note

Contacts and Individuals-Contact References

Create a Contact Reference Delete a Contact Reference

Contacts and Individuals-Tags

Get all Tags Find all Tags that match, fully or partially

Contacts and Individuals-Contact Tags

Get Tags for a Contact Create a Contact Tag Delete a Contact Tag

Contacts and Individuals-Organization Groups

Get all Organization Groups Get Organization Groups for a Contact Get the Contacts in an Organization Group Get an Organization Group Assign a Contact to an Organization Group Remove a Contact from an Organization Group

Contacts and Individuals-Relationships

Get Relationships for a Contact Create a Relationship Update a Relationship Delete a Relationship Get Relationship Types

Contacts and Individuals-Tributes

Search for Tributes Create a Tribute Update a Tribute

Giving-Gifts-How to Get Gifts

Get Gifts for a Contact Get Gifts for a Contact by Reference ID Get Passthrough Gifts for a Contact Get a Gift Get a Gift by Transaction Source and ID

Giving-Gifts-How to Create and Update Gifts

Create a Gift *not recommended*Create many Gifts *not recommended*Create a Reversing Transaction Update a Gift Update many Gifts Delete a Gift

Giving-Gifts-Gift Imports

Create a Gift Transaction Create a Batch of Gift Transactions

Giving-Gifts-Configuration

Get Gift Custom Fields Available Get Non-Cash Gift Types Available

Giving-Gifts-Gift Queries

Get Gift Query Options Query Gifts with Abbreviated Details Query Gifts with Full Details

Giving-Gift Designations

Get Gift Designation Query Options Query Gift Designations

Giving-Gift Asks

Get Gift Asks for a Contact Get the Gifts applied to a Gift Ask Get a Gift Ask Create a Gift Ask Update a Gift Ask Get Gift Ask Custom Fields Available Get Gift Ask Query Options Query Gift Asks

Giving-Planned Gifts

Get Planned Gifts for a Contact Get Planned Gift Get Gifts Applied to a Planned Gift Create a Planned Gift Update a Planned Gift Get Planned Gift Custom Fields Available Get Planned Gift Query Options Query Planned Gifts

Get Pledges for a Contact Get Pledge Create a Pledge Update a Pledge Write-off the Pledge Get Pledge Custom Fields Available Get Pledge Query Options Query Pledges

Giving-Premiums

Get Premium Get Premium using a unique Code Find Premiums Create a Premium Update a Premium Increment the inventory count Decrement the inventory count Get Premium Custom Fields Available Query Premiums Get Premium Query Options

Giving-Recurring Gifts

Get Recurring Gifts for a Contact Get a Recurring Gift Create a Recurring Gift Update a Recurring Gift Cancel a Recurring Gift Get Recurring Gift Custom Fields Available Get Recurring Gift Query Options Query Recurring Gifts

Giving-Recurring Gift Payments

Get Payments for a Recurring Gift

Campaigns-Campaigns

Get Campaign Gets Campaign Steps Get Campaign Query Options Query Campaigns

Campaigns-Communications

Get Communications for a Campaign Get Communication Get Channel Types Get Communication Types Create Communication Query Communications Communication Query Options

Campaigns-Segments

Get the Segments for a Contact Get a Segment Get a Segment using a unique Code Find Segments Create a Segment Update a Segment

Projects-How to Get Projects

Get Project Get a Project using a unique Code Find Projects

Projects-How to Create and Update Projects

Create a Project Update a Project Update many Projects Temporarily Change Project Inventory Status Update Project Balance

Projects-Configuration

Get Project Custom Fields Available Get Project Types

Projects-Project Queries

Get Project Query Options Query Projects

Projects-Project Expenses

Get Project Expenses for a Project Get Project Expense Create a Project Expense Create many Project Expenses Update a Project Expense

Projects-Project Notes

Get Notes for a Project Get Project Note Create a Project Note Update a Project Note Delete a Project Note Get Project Note Types

Projects-Project Roles

Get Project Roles for a Contact Get Project Roles for a Project Get Project Role Create a Project Role Update a Project Role Delete a Project Role Get Project Role Types

Get Events Get an Event Find an Event Create an Event Update an Event Delete an Event Get the Event Types Get Event Custom Fields Available Get Event Query Options Query Events

Events-Event Attendees

Get Event Attendees for an Event Get an Event Attendee Create an Event Attendee Update an Event Attendee Delete an Event Attendee Get Event Attendee Custom Fields Available Get Event Attendee Query Options Query Event Attendees

Events-Event Contacts

Get Event Contacts for an Event Get an Event Contact Create an Event Contact Delete an Event Contact

Get Grants for a Contact Get Grant Get a Grant by Reference ID Get the Gifts applied to a Grant Create a Grant Update a Grant Delete a Grant Get Grant Custom Fields Available Get Grant Query Options Query Grants

Volunteering-Volunteer Opportunity

Get Volunteer Opportunities Get Volunteer Opportunity Create a Volunteer Opportunity Update a Volunteer Opportunity Delete a Volunteer Opportunity Get Custom Fields Available Get Query Options Queries Volunteer Opportunities

Volunteering-Volunteer

Get Volunteers for a Volunteer Opportunity Get Volunteer Search for Volunteers Create a Volunteer Delete a Volunteer Get Query Options Query Volunteers

Volunteering-Volunteer Attendance

Get Volunteer Attendance for a Volunteer Get Volunteer Attendance Create a Volunteer Attendance Update a Volunteer Attendance Delete a Volunteer Attendance

Volunteering-Volunteer Organizer

Get Volunteer Organizers Get Volunteer Organizer Create a Volunteer Organizer Delete a Volunteer Organizer

Get Emails Send an Email to a list of Contacts

Emails-Email List

Search for an Email List Add Individuals to an Email List

Reminders (Deprecated)

Get Active Reminders (for current user)Get Saved Reminders (for current user)Get Active Manual Reminders by Contact Get Inactive Manual Reminders by Contact Get Unresolved Manual Reminders by Contact Create Manual Reminder Create Recurring Reminder Create Milestone Reminder Update Recurring Reminder Update Milestone Reminder.Complete Reminder Dismiss Reminder Get Reminder Types Get Reminder Source Types Gets Milestone Types Gets Reminder Frequency Types

Create a Task Get Task Types Query Tasks Get Task Query Options

Get a Webhook Create a Webhook Update a Webhook Set the active state of a Webhook Delete a Webhook

Account and Permissions-Authentication Token

Account and Permissions-Organization

Get the Organizations the current user belongs to Get the Current Organization for the current user Switch the Current Organization

Account and Permissions-Permission

Get Permissions for the current user

Contacts and Individuals-Contacts-How to Get Contacts

Get a Contact Get a Contact by Reference Source and ID Get a Contact by Reference ID Get Contacts by Tag ID Find a Contact by Email Address or Reference Source and ID Find all Contacts that match, fully or partially, the given search parameters Find all Contacts within a given proximity of a geocoordinate Get the Activity for the Contacts the current user is following Get the Contacts the current user is following

Contacts and Individuals-Contacts-How to Create and Update Contacts

Create a Contact Update a Contact Archive a Contact Unarchive a Contact Follow or Unfollow a Contact for the current user

Contacts and Individuals-Contacts-Working with Collections

Get Custom Collections for Contacts Create Collection for a Contact Update Collection for a Contact Delete Collection for a Contact

Contacts and Individuals-Contacts-Contact Imports

Create a Contact that will go through the import process Create a Contact Import that will be processed for changes and duplicates

Contacts and Individuals-Contacts-Configuration

Get Contact Name Prefixes and Titles Get Contact Types Get Contact Custom Fields Available

Contacts and Individuals-Contacts-Contact Queries

Get Contact Query Options Query Contacts with Abbreviated Details Query Contacts with Full Details

Contacts and Individuals-Contacts-Receipts

Receipts Get Receipt

Contacts and Individuals-Individuals-How to Get Individuals

Get Individuals for a Contact Get an Individual Find an individual by email address Gets the avatar for a specified contact individual

Contacts and Individuals-Individuals-How to Create and Update

Create an Individual Upload the avatar for an Individual Update an Individual Delete an Individual

Contacts and Individuals-Individuals-Working with Collections

Get Custom Collections for Individuals Create Collection for an Individual Update Collection for an Individual Delete Collection for an Individual

Contacts and Individuals-Individuals-Configuration

Gets the custom fields for contact individuals

Contacts and Individuals-Individuals-Individual Queries

Get Individual Query Options Query Individuals

Contacts and Individuals-Individuals-Email Lists

Get Email Lists for an Individual

Contacts and Individuals-Contact Addresses

Get the Contact Addresses for a Contact Get a Contact Address Create a Contact Address Update a Contact Address Archive a Contact Address Unarchive a Contact Address Delete a Contact Address

Contacts and Individuals-Contact Methods

Get Contact Method Types Get Contact Methods Types related to the Base Type Get a Contact Method Create a Contact Method for an Individual Update a Contact Method Archive a Contact Method Unarchive a Contact Method Delete a Contact Method

Contacts and Individuals-Contact Notes

Get the Notes for a Contact Get the Important Notes for a Contact Get a Note Create a Note for a Contact Create a Note using an Email Update a Note Delete a Note Get Contact Note Query Options Query Contact Notes Get Contact Note Types Gets the custom fields for contact note

Contacts and Individuals-Contact References

Create a Contact Reference Delete a Contact Reference

Contacts and Individuals-Tags

Get all Tags Find all Tags that match, fully or partially

Contacts and Individuals-Contact Tags

Get Tags for a Contact Create a Contact Tag Delete a Contact Tag

Contacts and Individuals-Organization Groups

Get all Organization Groups Get Organization Groups for a Contact Get the Contacts in an Organization Group Get an Organization Group Assign a Contact to an Organization Group Remove a Contact from an Organization Group

Contacts and Individuals-Relationships

Get Relationships for a Contact Create a Relationship Update a Relationship Delete a Relationship Get Relationship Types

Contacts and Individuals-Tributes

Search for Tributes Create a Tribute Update a Tribute

Giving-Gifts-How to Get Gifts

Get Gifts for a Contact Get Gifts for a Contact by Reference ID Get Passthrough Gifts for a Contact Get a Gift Get a Gift by Transaction Source and ID

Giving-Gifts-How to Create and Update Gifts

Create a Gift *not recommended*Create many Gifts *not recommended*Create a Reversing Transaction Update a Gift Update many Gifts Delete a Gift

Giving-Gifts-Gift Imports

Create a Gift Transaction Create a Batch of Gift Transactions

Giving-Gifts-Configuration

Get Gift Custom Fields Available Get Non-Cash Gift Types Available

Giving-Gifts-Gift Queries

Get Gift Query Options Query Gifts with Abbreviated Details Query Gifts with Full Details

Giving-Gift Designations

Get Gift Designation Query Options Query Gift Designations

Giving-Gift Asks

Get Gift Asks for a Contact Get the Gifts applied to a Gift Ask Get a Gift Ask Create a Gift Ask Update a Gift Ask Get Gift Ask Custom Fields Available Get Gift Ask Query Options Query Gift Asks

Giving-Planned Gifts

Get Planned Gifts for a Contact Get Planned Gift Get Gifts Applied to a Planned Gift Create a Planned Gift Update a Planned Gift Get Planned Gift Custom Fields Available Get Planned Gift Query Options Query Planned Gifts

Get Pledges for a Contact Get Pledge Create a Pledge Update a Pledge Write-off the Pledge Get Pledge Custom Fields Available Get Pledge Query Options Query Pledges

Giving-Premiums

Get Premium Get Premium using a unique Code Find Premiums Create a Premium Update a Premium Increment the inventory count Decrement the inventory count Get Premium Custom Fields Available Query Premiums Get Premium Query Options

Giving-Recurring Gifts

Get Recurring Gifts for a Contact Get a Recurring Gift Create a Recurring Gift Update a Recurring Gift Cancel a Recurring Gift Get Recurring Gift Custom Fields Available Get Recurring Gift Query Options Query Recurring Gifts

Giving-Recurring Gift Payments

Get Payments for a Recurring Gift

Campaigns-Campaigns

Get Campaign Gets Campaign Steps Get Campaign Query Options Query Campaigns

Campaigns-Communications

Get Communications for a Campaign Get Communication Get Channel Types Get Communication Types Create Communication Query Communications Communication Query Options

Campaigns-Segments

Get the Segments for a Contact Get a Segment Get a Segment using a unique Code Find Segments Create a Segment Update a Segment

Projects-How to Get Projects

Get Project Get a Project using a unique Code Find Projects

Projects-How to Create and Update Projects

Create a Project Update a Project Update many Projects Temporarily Change Project Inventory Status Update Project Balance

Projects-Configuration

Get Project Custom Fields Available Get Project Types

Projects-Project Queries

Get Project Query Options Query Projects

Projects-Project Expenses

Get Project Expenses for a Project Get Project Expense Create a Project Expense Create many Project Expenses Update a Project Expense

Projects-Project Notes

Get Notes for a Project Get Project Note Create a Project Note Update a Project Note Delete a Project Note Get Project Note Types

Projects-Project Roles

Get Project Roles for a Contact Get Project Roles for a Project Get Project Role Create a Project Role Update a Project Role Delete a Project Role Get Project Role Types

Get Events Get an Event Find an Event Create an Event Update an Event Delete an Event Get the Event Types Get Event Custom Fields Available Get Event Query Options Query Events

Events-Event Attendees

Get Event Attendees for an Event Get an Event Attendee Create an Event Attendee Update an Event Attendee Delete an Event Attendee Get Event Attendee Custom Fields Available Get Event Attendee Query Options Query Event Attendees

Events-Event Contacts

Get Event Contacts for an Event Get an Event Contact Create an Event Contact Delete an Event Contact

Get Grants for a Contact Get Grant Get a Grant by Reference ID Get the Gifts applied to a Grant Create a Grant Update a Grant Delete a Grant Get Grant Custom Fields Available Get Grant Query Options Query Grants

Volunteering-Volunteer Opportunity

Get Volunteer Opportunities Get Volunteer Opportunity Create a Volunteer Opportunity Update a Volunteer Opportunity Delete a Volunteer Opportunity Get Custom Fields Available Get Query Options Queries Volunteer Opportunities

Volunteering-Volunteer

Get Volunteers for a Volunteer Opportunity Get Volunteer Search for Volunteers Create a Volunteer Delete a Volunteer Get Query Options Query Volunteers

Volunteering-Volunteer Attendance

Get Volunteer Attendance for a Volunteer Get Volunteer Attendance Create a Volunteer Attendance Update a Volunteer Attendance Delete a Volunteer Attendance

Volunteering-Volunteer Organizer

Get Volunteer Organizers Get Volunteer Organizer Create a Volunteer Organizer Delete a Volunteer Organizer

Get Emails Send an Email to a list of Contacts

Emails-Email List

Search for an Email List Add Individuals to an Email List

Reminders (Deprecated)

Get Active Reminders (for current user)Get Saved Reminders (for current user)Get Active Manual Reminders by Contact Get Inactive Manual Reminders by Contact Get Unresolved Manual Reminders by Contact Create Manual Reminder Create Recurring Reminder Create Milestone Reminder Update Recurring Reminder Update Milestone Reminder.Complete Reminder Dismiss Reminder Get Reminder Types Get Reminder Source Types Gets Milestone Types Gets Reminder Frequency Types

Create a Task Get Task Types Query Tasks Get Task Query Options

Get a Webhook Create a Webhook Update a Webhook Set the active state of a Webhook Delete a Webhook

Home Reference Contacts and Individuals-Contacts-How to Create and Update ContactsArchive a Contact

Archive a Contact

PUT {{baseUrl}}/api/Contact/Archive/:contactId

Request Body

{"archiveReason"=>"Optional reason for Archiving the contact"}

RESPONSES

status: OK

&quot;&quot;

Update a Contact

Unarchive a Contact