Introduction
Welcome to the MPDX API documentation. This is the API used by the official MPDX web interface, so everything the web ui is able to do can also be accomplished via the API. This API attempts to conform where possible to the JSON API Spec .
Authentication
Your Authorization header should look like this:
GET /api/v2/user
Content-Type: application/vnd.api+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxNTl9.DKgwCXxnXA8tmw3rH9C5qoUXGZh2pbVs-TAH8mTwVsc
MPDX uses Bearer Auth over HTTPS for authentication. Unauthenticated requests will return an HTTP 401 response.
To get a token you must submit a valid CAS Ticket from The Key service for MPDX to the User Authenticate CREATE Endpoint. To find out more go to the documentation for User Authenticate. This endpoint will return a JWT which you will need to use in the Authorization header.
Throttling
Status: 200 OK
X-RateLimit-Limit: 50
X-RateLimit-Remaining: 49
X-RateLimit-Reset: 5
API requests are limited to 50 calls per 10 seconds, though that limit is subject to change. Exceeding that limit will cause MPDX to return an HTTP 429 response. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers to see how many more requests you are allowed until throttling kicks in.
| Header Name | Description |
|---|---|
| X-RateLimit-Limit | Maximum Number of requests per throttle window |
| X-RateLimit-Remaining | Requests remaining in the current throttle window |
| X-RateLimit-Reset | Time in seconds until the current throttle window ends |
Validation
Methods that take input will validate all parameters. Any parameter that fails validation will trigger an error response with status HTTP 422. The response body will be a JSON object that includes a message as well as a list of fields that failed validation.
General Considerations
Unless otherwise specified, API methods generally conform to the following:
- Properties without a value will use
nullinstead of being undefined - “Snake Case” is used for attribute names (e.g.
first_name) - Timestamps are rendered in ISO-8601 format (e.g.
2016-02-03T16:38:46.985Z) - We reserve the right to add more properties to objects, but will never change or remove them on the same API version
Versioning
Why do we have versions?
The goal for having versioning is for developers building apps to be able to understand in advance when an API might change. They help with web development, but are critical with mobile development because a person using your app on their phone may take a long time to upgrade (or may never upgrade).
As mentioned, each version will remain for at least 2 years from release, therefore giving you a solid timeline for how long your app will remain working, and for how long you have to update it to newer versions.
Version Schedules
Each version is guaranteed to operate for at least two years. A version will no longer be usable two years after the date that the subsequent version is released.
So if API version v3 is released on March 25th, 2016 and API version v4 is released August 7th, 2016 then v3 would expire on August 7th, 2018, two years after the release of v4.
For APIs, once a version is no longer usable, any calls made to it will be defaulted to the next oldest usable version.
Will everything remain completely unchanged within a version?
We reserve the right to make changes in any API in a short period of time for issues related to security or privacy. These changes don’t happen often, but they do happen.
Web Browsers
When writing an in-browser client, you have to circumvent the browser’s same origin policy. Generally, we offer one approach for this: Cross-Origin Resource Sharing (aka CORS).
CROSS-ORIGIN RESOURCE SHARING
All API resources set appropriate headers to allow Cross-Origin requests. Be aware that on Internet Explorer you might have to use a different interface to send these requests.
In contrast to JSONP, CORS does not lead to any execution of untrusted code.
Most JavaScript frameworks, like jQuery, take care of CORS requests for you under the hood, so you can just do a normal AJAX request.
Our current setup allows the headers Content-Type, Authorization, Accept, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset and X-HTTP-Method-Override and the HTTP methods HEAD, GET, POST, PATCH, PUT, DELETE.
Errors
The MPDX API uses the following error codes:
| Error Code | Meaning |
|---|---|
| 400 | Bad Request – Your request sucks |
| 401 | Unauthorized – Your API key is wrong |
| 403 | Forbidden – The page requested is hidden for administrators only |
| 404 | Not Found – The specified page could not be found |
| 405 | Method Not Allowed – You tried to access a page with an invalid method |
| 406 | Not Acceptable – You requested a format that isn’t json |
| 410 | Gone – The page requested has been removed from our servers |
| 418 | I’m a teapot |
| 429 | Too Many Requests – You’re requesting too many page! Slow down! |
| 500 | Internal Server Error – We had a problem with our server. Try again later. |
| 503 | Service Unavailable – We’re temporarially offline for maintanance. Please try again later. |
Offline Clients Syncing
To allow for the syncing of devices that were previously offline, client side developers must be aware that certain fields are expected to be included with all PUT requests updating database data.
Updated In Db At (Required)
To allow offline clients to later sync resources with the API without overwriting valid data, the API will require that the updated_in_db_at field (which reflects the value of the updated_at field that was last returned from the server) be provided in text format for each resource updated through a PUT request. The API will verify that the provided updated_in_db_at field has the exact same value that is currently stored in the database and reject the update if that is not the case. This will ensure that a client doesn’t overwrite a resource without being aware of that resource’s latest data.
Created At & Updated At
To allow offline clients to create and update resources and to ensure that the created_at and updated_at fields of that resource reflects the exact time of its creation and update, clients can provide the created_at or updated_at fields at the time of syncing.
Id (Universally Unique Identifiers)
To allow offline clients to reference resources before having synced with the API, clients can generate a UUID and provide it with the id field when syncing with the API.
MPDX API Changelog
This changelog covers what’s changed in the MPDX APIs.
25 September 2018
- BREAKING CHANGE contacts/exports [POST] when using ids filter other filters will be ignored
- BREAKING CHANGE contacts/exports/mailing [POST] when using ids filter other filters will be ignored
23 August 2018
- Added bulk_update_option_hashes and notification_hashes to list of constants at ’/api/v2/constants’.
- DEPRACATED notification_translated_hashes. This was a mistake and should not have had _translated_ present in the name.
17 August 2018
- Added PUT account_list/designation_accounts/:id allowing active to be updated
4 May 2018
- Added reports/pledge_histories endpoint
- Added reports/appointment_results endpoint
26 April 2018
- contacts/exports [LIST] is now deprecated
- contacts/exports/mailing [LIST] is now deprecated
- contacts/exports [POST] allows creating of export_logs
- contacts/exports/:id [GET] allows users to retrieve a CSV or XLSX file directly from the API
- contacts/exports/mailing [POST] allows creating of export_logs with a custom mailing format
- contacts/exports/mailing/:id [GET] allows users to retrieve a CSV file directly from the API
20 April 2018
- add nil activity type to Activity analytics
6 April 2018
- add designation_account_id & donor_account_id filter to account_list/donations
- add designation_account_id & donor_account_id filter to reports/donor_currency_donations
- add designation_account_id & donor_account_id filter to reports/salary_currency_donations
- add designation_account_id & donor_account_id filter to reports/monthly_giving_graph
- add designation_account_id & donor_account_id filter to reports/expected_monthly_totals
17 November 2017
- CSV Import no longer accepts hash key value format
8 November 2017
- designation account display name field no longer duplicates designation_number
- donor account display name field no longer duplicates account_number
4 November 2017
- user/organization_accounts no longer returns token field
30 October 2017
- Updated 4 filters.
- gave_more_than_pledged_within is now gave_more_than_pledged_range
- pledge_amount_increase_within is now pledge_amount_increase_range
- started_giving_within is now started_giving_range
- stopped_giving_within is now stopped_giving_range
12 October 2017
- Added api/v2/reports/monthly_losses_graphs endpoint.
11 October 2017
- added a DELETE action to appeals/excluded_appeal_contacts endpoint
09 October 2017
- Added /api/v2/coaching/pledges endpoint.
6 October 2017
- appeals/appeal_contacts endpoint is now sortable by contact.name
- appeals/excluded_appeal_contacts endpoint is now sortable by contact.name
- Added relationship to donation_amount_recommendations to contacts endpoint.
- Added contact/donation_amount_recommendations endpoint.
- pledges endpoint is now filterable by status
05 October 2017
- Added /api/v2/coaching/account_lists endpoint.
- Added /api/v2/coaching/contacts endpoint.
4 October 2017
- Added ability to sort by contact name field in pledges endpoint.
- Contact Status filter now returns contacts with no status when ‘active’ is in the list of parameter.
- Added assignable_location_hashes to list of constants returned by the ’/api/v2/constants’ endpoint.
3 October 2017
- convert pledge status booleans to enum
29 September 2017
- Added pledged_to_appeal filter to appeal/:id/appeal_contacts endpoint.
28 September 2017
- Add all person fields to the /user endpoint.
27 September 2017
- Removed Burmese, Vietnamese, Japanese and Persian to list available languages.
19 September 2017
- Added the /contacts/people endpoint to get and delete a person without the contact id.
11 September 2017
- Removed /api/v2/appeals/contacts endpoint.
- Added /api/v2/appeals/appeal_contacts endpoint.
- Added /api/v2/appeals/excluded_appeal_contacts endpoint.
- Upon a successful Account Reset (an admin function), the user is sent an email asking them to logout and log back into MPDX. A link to the logout route is provided in the email body.
8 September 2017
- The ACCEPT-LANGUAGE header can now be used to set the locale on each request.
- Eg. 'ACCEPT-LANGUAGE: “fr-FR”’
5 September 2017
- Added active_mpd_start_at, active_mpd_finish_at, active_mpd_monthly_goal fields to account_list object.
- Added primary_appeal relationship to account_list object.
- Added fix-send-newsletter count to /api/v2/tools/analytics endpoint.
31 August 2017
- Breaking changes to the /api/v2/contacts/people/duplicates endpoints. Duplicates are now resources with uuids.
30 August 2017
- Added pledges_amount fields to appeal object.
29 August 2017
- Added a 'processed’ field on the pledge object.
- Added an 'appeal_id’ filter on the pledges endpoint.
- Add a new include to designation_accounts called balances showing historic balances
21 August 2017
- Breaking changes to the /api/v2/user endpoint. preferences[setup] now returns a string if the user is not setup correctly.
18 August 2017
- Added email_blacklist attribute to google_integrations.
- Breaking changes to the /api/v2/contacts/duplicates endpoints. Duplicates are now resources with uuids.
17 August 2017
- Moved appeals donations attribute into relationships.
08 August 2017
- Added pt-BR (brazilian portuguese) to the list of supported locales on the API.
28 July 2017
- Added filter[display_currency] to ’/api/v2/reports/monthly_giving_graph’ that changes the converted currency for the graph.
24 July 2017
- Expanded the search scope of wildcard_search under ’/api/v2/tasks’ endpoint to include associated comments and contacts.
21 July 2017
- Addresses, email addresses and phone numbers now can be edited when the source is 'TntImport’.
20 July 2017
- The ’/admin/impersonation’ endpoint now permits the search of impersonated users by email addresses.
13 July 2017
- Removed the ’/api/v2/user/authentication’ endpoint.
12 July 2017
- Added a pledge_frequency_hashes field to ’/api/v2/constants’ endpoint.
11 July 2017
- Added organization to relationships on designation account objects returned by the API.
- Gift Aid can now be opted out for specific contacts.
- Added a ’/reports/donation_monthly_totals’ endpoint.
06 July 2017
- Added the ’/admin/impersonation’ endpoint.
27 June 2017
- Tasks endpoint can now sort by multiple parameters.
- Sorting now allows specifying the NULLS sort order (FIRST or LAST).
26 June 2017
- Added contact name search to donor accounts endpoint.
20 June 2017
- CSV Import should support importing Referred By.
19 June 2017
- TNT import now allows to import Campaign information related to all manually added gifts.
13 June 2017
- Added parent_contacts field to person object.
- That field contains the ids of contacts associated to the person object.
09 June 2017
- Added a tools analytics endpoint:
- Gives the number of contacts, addresses, phone numbers and email addresses that need to be fixed by the user. It also gives a count of the number of duplicated contacts and people associated to him/her.
08 June 2017
- Tnt import: improve setting task completed status, and timezone parsing.
06 June 2017
- Added wildcard search filter on ’/api/v2/contacts/people’ endpoint.
- Added location to list of task attributes displayed on ’/api/v2/tasks’ endpoint.
05 June 2017
- Added Vietnamese, Ukrainian, Burmese and Polish to list of languages supported on the API side.
09 May 2017
- Added translated constant hashes to list of constants at ’/api/v2/constants’.
- 'activity_hashes’, 'assignable_likely_to_give_hashes’, 'assignable_send_newsletter_hashes’ and 'status_hashes’ were added.
- They contain hashes with the english and translated version of each constant.
08 May 2017
- DB Migrations: AddAmountCurrencyToPledges, AddAppealIdToPledges, CreatePledgeDonations, MigratePledgesDonationIdDataToJoinTable, RemoveDonationIdFromPledges
- Pledge now has many Donations (instead of belongs_to).
- Pledge now has an amount_currency.
- TNT Import parses dates according to the user’s timezone.
- TNT Import now imports Pledges (called “Promises” in TNT).
05 May 2017
- Allow clients to apply merge the different filters together using an 'OR’. To do so add 'any_filter = true’ to your list of filters.
04 May 2017
- Added 5 new filters.
- Those are: gave_more_than_pledged, no_appeals, pledge_amount_increase_within, started_giving_within and stopped_giving_within. View documentation for details.
- Migration: Add is_organization to contacts
- TNT Import now imports Contact is_organization
01 May 2017
- Added updated_at filter to people.
- Allowing clients to set a foreign key to nil.
- To do so just set “id: 'none’” for a belongs_to relationship
- Add “qa” Rails environment
28 April 2017
- Added batch endpoint at
POST /api/v2/batch- It expects a JSON payload with a
requestskey that has an array of request objects. A request object needs to have amethodkey and apathkey. It may also have abodykey. - The response will be a JSON array of response objects. A response object has a
statuskey, aheaderskey, and abodykey. Thebodyis a string of the server response. - In addition to the
requestskey in the payload, you may also specify aon_errorkey which may be set toCONTINUE, orABORT.CONTINUEis the default, and it will return a 200 no matter what, and give a response for every request, no matter if they errored or not.ABORTwill end the batch request early if one of the requests fails. The batch response will have the status code of the failing request, and the response will include responses up to and including the errored request, but no more. - Some endpoints are unable to be used within a batch request. At this time, only bulk endpoints are disallowed from being used in a batch request.
- It expects a JSON payload with a
26 April 2017
- Now allowing anyone invited to share an account to edit any of the account’s resources on MPDX.
- Allowing reverse filters for any contacts or tasks filters.
- To do so just add 'reverse_FILTER_NAME_HERE = true’ to the filter hash.
25 April 2017
- Added /account_lists/invites/accept endpoint to allow users to accept an account list invite.
20 April 2017
- Added received_not_processed to pledges.
- Contact suggested_changes used to sometimes suggest a blank value for status, this was a bug that has been fixed.
18 April 2017
- Added direct deposit to contact endpoints.
- Updated translations and added it, th and id.
- Added a contact name_like filter.
13 April 2017
- Removed total_donations from all contact endpoints.
- Added api_class and help_email attributes to a new constant field called organizations_attributes.
- Added contact referrals relationships to contact serializer.
- Added people bulk endpoints.
11 April 2017
- Update Contact suggested_changes after an import.
- Added updated_in_db_at to all 409 Conflict error payloads.
- Permit override param on imports.
10 April 2017
- Allows the client not to specify a particular accept or content-type header on the contacts export endpoints.
- Added a late_by_90_days field to contacts analytics endpoint.
8 April 2017
- Add
mobile_alert_frequenciesto Constants.
7 April 2017
- Added a way to overwrite data on PATCH requests without providing an
updated_in_db_atvalue.
6 April 2017
- Contacts Wildcard Search is now returning contacts where the value is in notes.
- Addresses are now returning the source_donor_account relationship.
- Contacts are now returning the primary_or_first_person relationship.
5 April 2017
- Added total_donation to donation detail
- Amount under donation endpoint is now just returning an amount without symbol
4 April 2017
- TNT Import now imports social media accounts.
- TNT Import now imports contact envelope_greeting.
3 April 2017
- Imports API now accepts comma delimited tag_list, instead of tags.
2 April 2017
- Added Russian, Arabic, German and Korean to list of languages supported on the API side.
31 March 2017
- Added converted_amount and converted_currency to donation objects returned by the API.
- Added turkish to list of language constants.
- Add missing attributes metro_area, region, remote_id, and seasonal to Address serialization
- CSV Import: Remove support for Contact Name, instead we’ll require at least First Name, or Last Name
- CSV Import: Remove Referred By because it’s not supported yet
- CSV Import: Auto generate a Contact Name based on first and last names
30 March 2017
- Added bulk create actions for contacts/tags and tasks/tags
- Added a way to bulk remove multiple tags from multiple records on the contacts/tags and tasks/tags endpoints
- Bulk contacts/tags and tasks/tags now work like any other bulk endpoint
- Enabled being able to set
X-HTTP-Method-Overrideheader to override the request method
29 March 2017
- Added updated_at as a filter for Contacts endpoint
- Added updated_at as a filter for Tasks endpoint
28 March 2017
- Added contact related filters to tasks endpoint
- User creation now works. Now when you try to authenticate with a valid theKey ticket, and the User doesn’t exist - it will create them
- One thing to note - the User will be returned without any
Account Listinformation, unless they are part of the Cru-USA organization
- One thing to note - the User will be returned without any
- TNT imports user fields as tags
- TNT imports Campaigns, renamed from Appeals in v3.2
27 March 2017
- Updating TntImport::GroupTagsLoader to import from TNT v3.2
- Added TntImport::Xml service class to assist TNT imports
24 March 2017
- Added endpoint to update people without specifying a contact_id at PUT api/v2/contacts/people
23 March 2017
- Add sources to Constants endpoint
- “source” and “valid_values” attributes are now updatable on phone_numbers, email_addresses, and addresses
22 March 2017
- When adding a referral under a Contact, ie:
contacts_referred_by_me, you are now required to provide a relatedaccount_listfor each referral - When Merging Account Lists, the Target Account List (ie: the account that remains after the merge) is now returned in the response body of a successful merge
21 March 2017
- The API will now return better 404 detail messages when unable to find a resource
20 March 2017
- Added a pledge endpoint to access pledges associated to an account_list ( /account_lists/pledges )
- Filters ending with
_idnow allow for comma-delimited ids to be sent - Add CSV Import get, list, and update endpoints
- Added alert frequencies to the constants endpoint
- Add CSV Import constants to the constants endpoint
17 March 2017
- Sparse fieldsets enabled for contacts and people duplicates endpoints
15 March 2017
- Adjust attributes returned / required for Linkedin Accounts
14 March 2017
- Add
websiteattribute toContactobjects - Adjust Bulk Delete Tags endpoints (
api/v2/contacts/tags/bulkandapi/v2/tasks/tags/bulk) - Allow for resource filtering, ie:
filter[contact_ids] - Adjust object format of Tag to be removed to better mirror
json:api
10 March 2017
- Added a mailing csv export endpoint
- FacebookAccount on person endpoint is now accepting username and remote_id as opposed to url
- Person object will now have only one primary address at a time
- Removed donor_account presence validation on organization_id as requested by Mike
- Now displaying parent_contact for people objects under birthdays_this_week field of contacts analytics
- Added Google OAuth endpoint
- Added Prayer Letters OAuth endpoint
8 March 2017
- all filters accept comma separated items
7 March 2017
- constant_list now returning a complete currency object instead of a string
- person duplicates endpoint is now eliminating doubles
- conflict error returns the value of update_at in db to client
6 March 2017
- Added bulk create tasks endpoint
3 March 2017
- removed validation on start_at and dropped no_date field
- added fr-CA to language constants
1 March 2017
- Added ability to sort by start_at field in donations endpoint
- Added a delete donation endpoint
- Added the ability to include people, email_addresses and phone_number in tasks endpoint
- Removed the 'links’ object from list endpoints
28 February 2017
- Added tasks to contacts endpoint
27 February 2017
- Added locale_display to User model preferences
- Added completed_at sorting param to tasks endpoint
25 February 2017
- Added a contacts bulk create endpoint
- Bulk endpoints now require an
idto be provided for every object within the sent data array for create and update requests- Without such, a 409 will be returned
- Fixed some of the documentation for the bulk update endpoints for tasks and contacts
24 February 2017
- Added notification fields to activity_serializer
23 February 2017
- Added
updated_atas a filterable attribute on the LIST endpoint for all database backed Resources - Added sorting by
donation_dateto Account Lists > Donations > LIST - Added filtering by
donation_datewith a date range, on Account Lists > Donations > LIST
22 February 2017
- changed the account_lists method in V2 controller to only filter when account_list_id is in list of permitted_filters
- reordered the list of contact options returned by the /contacts/filter
- changed contact_id filter to donor_account_id filter for donations endpoint
- fixed contact status and activity type filters to allow them to accept several params seperated by comma
- account_list analytics endpoint now accepts datetime range in proper iso8601 format
- account_list endpoint now accepts notification_preferences relationships
- Fixed bug with person endpoint that took place when a linkedin account relationship was provided
21 February 2017
- Accepts datetime range filters that match
YYYY-MM-DDThh:mm:ssZ..YYYY-MM-DDThh:mm:ssZ- Use two periods
..to denote an inclusive range - Use three periods
...to denote an exclusive range
- Use two periods
- Accepts date range filters that match
YYYY-MM-DD..YYYY-MM-DD- Use two periods
..to denote an inclusive range - Use three periods
...to denote an exclusive range
- Use two periods
20 February 2017
- Fixed sorting for cases when chained with filters
- Added account_list_id filter to contacts and people duplicates endpoints
- Added attributes to person_serializer
- Removed html error pages from public folder
- Contact_ids filter config is now returning contacts ordered by name and account_list_id is included with each.
- Added an endpoint for deleting a named tag from all tasks (
DELETE /tasks/tags/bulk) @ardation - Added an endpoint for deleting a named tag from all contacts (
DELETE /contacts/tags/bulk) @ardation
17 February 2017
- Added a serializer for Organization
- Added a contact_id filter to Donations endpoint
- Fixed assigning a person to a Task comment
15 February 2017
- Changed mail_chimp_accounts controller to mail_chimp_account
- Added documentation for create action of account_lists#mail_chimp_account endpoint
- Attempted to fix the seeder_application_spec intermittent error
13 February 2017
- Nested Attributes with Included data can now be sent in POST/PATCH
- Activity Comments are now officially Comments
9 February 2017
- added an API changelog
- updated contributing.md to suggest contribution to changelog
Content Negotiation
Our API requires use of the JSON API media type (application/vnd.api+json) for exchanging data.
Client Responsibilities
Clients MUST send all JSON API data in request documents with the header Content-Type: application/vnd.api+json without any media type parameters.
Clients that include the JSON API media type in their Accept header MUST specify the media type there at least once without any media type parameters.
Clients MUST ignore any parameters for the application/vnd.api+json media type received in the Content-Type header of response documents.
API Responsibilities
Our API WILL send all JSON API data in response documents with the header Content-Type: application/vnd.api+json without any media type parameters.
Our API WILL respond with status HTTP 415 (Unsupported Media Type) if a request specifies the header Content-Type: application/vnd.api+json with any media type parameters.
Our API WILL respond with status HTTP 406 (Not Acceptable) if a request’s Accept header contains the JSON API media type and all instances of that media type are modified with media type parameters.
Fetching Data
Fetching Resources
The following request fetches a collection of contacts
GET /api/v2/contacts
Accept: application/vnd.api+json
The following request fetches a contact
GET /api/v2/contacts/1
Accept: application/vnd.api+json
Data, including resources can be fetched by sending a GET request to an endpoint.
Responses
200 OK
A GET request to a collection of contacts could return
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": [{
"type": "contacts",
"id": "1",
"attributes": {
"...": "..."
}
}, {
"type": "contacts",
"id": "2",
"attributes": {
"...": "..."
}
}]
}
An endpoint WILL respond to a successful request to fetch an individual resource or resource collection with status HTTP 200.
An endpoint WILL respond to a successful request to fetch a resource collection with an array of resource objects or an empty array ([]) as the response document’s primary data with status HTTP 200.
404 Not Found
An endpoint WILL respond with status HTTP 404 when processing a request to fetch a single resource that does not exist.
Inclusion of Related Resources
GET /api/v2/contacts?include=people,addresses
Accept: application/vnd.api+json
An endpoint MAY return resources related to the primary data by default.
An endpoint MAY also support an include request parameter to allow the client to customize which related resources should be returned. The value of the include parameter MAY be a comma-separated (U+002C COMMA, “,”) list of relationships.
Endpoints not supporting include as specified in the query parameter include WILL return with status HTTP 400.
Sparse Fieldsets
GET /api/v2/contacts?fields[contacts]=title,body
Accept: application/vnd.api+json
A client MAY request that an endpoint return only specific fields in the response on a per-type basis by including a fields[TYPE] parameter. The value of the fields parameter MAY be a comma-separated (U+002C COMMA, “,”) list that refers to the name(s) of the fields to be returned.
Sorting
GET /api/v2/contacts?sort=first_name,-created_at
Accept: application/vnd.api+json
A collection endpoint MAY support requests to sort the primary data with a sort query parameter. The value for sort MUST represent sort fields. Multiple sort fields MAY be included as a comma-separated list (U+002C COMMA, “,”). The sort order for each field is ascending unless it is prefixed with a minus (U+002D HYPHEN-MINUS, “-”).
Endpoints not supporting sorting as specified in the query parameter sort WILL return with status HTTP 400.
Pagination
{
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 1,
"total_pages": 1
}
}
}
A collection endpoint WILL always paginated unless otherwise specified. You can specify the current page and number of items per page with the page and per_page query parameters. Paginated results include a Link response header that specifies the location of the next and last pages.
Note that when this parameter is not set, results WILL be limited to the first page.
All API methods that return a collection WILL contain in the meta[pagination] object:
- the current page
- the number of items per page
- the total number of items
- the total page count
Filtering
GET /api/v2/contacts/filters
Accept: application/vnd.api+json
{
"data": [
{
"id": 1,
"type": "contact_filter_address_historics",
"attributes": {
"...": "..."
}
},
{
"id": 2,
"type": "contact_filter_appeals",
"attributes": {
"...": "..."
}
}
]
}
An collection endpoint MAY support filtering. Collection endpoints that support filtering WILL have a filter endpoint as a child of the parent namespace. Collection endpoints that support filtering take a filter query parameter that should be formatted according to the objects returned from the filter endpoint.
Dynamic Filtering
The API provides Filter [LIST] endpoint for collection endpoints that have dynamic filters. If you build your system with support for these endpoints your app will automatically support new filters as the API team develops them.
All Filter [LIST] endpoints return a data array with objects with the following attributes.
Filter Object
| Name | Description |
|---|---|
| name required | The key to use in the filter hash e.g filter[name] string |
| title required | The translated name or label to display to the user string |
| type required | One of: single_checkbox, multiselect, radio, text, daterange. This controls how the filter should display. |
| parent | The translated parent container for this filter string or null |
| default_selection | The default option id or boolean value for this filter that matches what is returned by default boolean or string |
| multiple | Specifies if multiple options be selected boolean |
| options | Array of options for multiselect, radio, text and daterange array |
| options[][name] required | The translated name to display to the user string |
| options[][id] | The value to include in the filter hash for the resource string |
| options[][start] | The beginning of the date range string |
| options[][end] | The end of the date range string |
| options[][placeholder] | The default value for a text input string |
Filtering Gotchas
Some filter options change based on the account_list_id provided and will need to be refreshed when the account list is updated. For example a list of churches for the contact_filter_churches are provided as options that are pulled from the collection of contacts for the specified account_list_ids.
If the default selection is currently selected you do not need to include it in your request. However, including it incurs no penalty.
Order is determined by the id field. Ascending as an integer from 0.
Multiselect Example
{
"name": "status",
"title": "Status",
"type": "multiselect",
"parent": null,
"default_selection": [
"active",
"null"
],
"multiple": true,
"options": [{
"name": "-- All Active --",
"id": "active"
}]
}
Here is a filter with type multiselect. The title displayed, with the default selection selected.
This would generate the filter:
filter[status]=Ask+in+Future,Cultivate+Relationship,Never+Contacted,active,null
Radio Example
{
"name": "newsletter",
"title": "Newsletter Recipients",
"type": "radio",
"parent": null,
"default_selection": "",
"multiple": false,
"options": [{
"name": "-- Any --",
"id": "",
"placeholder": "None"
}]
}
Here is a filter with type radio. The title is displayed above the options and each individual option name displayed.
This would generate the filter:
filter[newsletter]=none
Text Example
{
"name": "donation_amount_range",
"title": "Gift Amount Range",
"type": "text",
"parent": "Gift Details",
"default_selection": "",
"multiple": false,
"options": [{
"name": "Gift Amount Higher Than or Equal To",
"id": "min",
"placeholder": 0
}, {
"name": "Gift Amount Less Than or Equal To",
"id": "max",
"placeholder": null
}]
}
Here is a filter with type text. The name of each option is displayed. Each option is its own individual text box.
This would generate the filter:
filter[donation_amount_range][max]=989086756&filter[donation_amount_range][min]=0
Single Checkbox Example
{
"name": "address_historic",
"title": "Address No Longer Valid",
"type": "single_checkbox",
"parent": "Contact Location",
"default_selection": false,
"multiple": false,
"options": []
}
Here is a filter with type single_checkbox. The title of the checkbox is displayed.
This would generate the filter:
filter[address_historic]=true
Parent Examples
[{
"id": "12",
"type": "contact_filter_donations",
"attributes": {
"name": "donation",
"title": "Gift Options",
"type": "multiselect",
"parent": "Gift Details"
}
},{
"id": "14",
"type": "contact_filter_donation_amount_ranges",
"attributes": {
"name": "donation_amount_range",
"title": "Gift Amount Range",
"type": "text",
"parent": "Gift Details"
}
},{
"id": "15",
"type": "contact_filter_donation_dates",
"attributes": {
"name": "donation_date",
"title": "Gift Date",
"type": "daterange",
"parent": "Gift Details"
}
}]
For brevity some attributes have been excluded. This example shows how filters are meant to be grouped by parent name as shown above. These filters have the common parent attribute and so should be grouped accordingly. The parent group should be inserted into the list of filters in the position of the lowest id of any of the filters in the collection.
X-HTTP-Method-Override
POST /api/v2/contacts/filters
Accept: application/vnd.api+json
X-HTTP-Method-Override: get
Collection endpoints that support filtering also support the X-HTTP-Method-Override header. This is necessary because URLs have a max length of 2,083 characters. As such a GET request with a long query string can instead be disguised as a POST request and can overcome this requirement.
Modifying Data
Some endpoints MAY allow resources of a given type to be created. It MAY also allow existing resources to be modified or deleted.
A request WILL completely succeed or fail (in a single “transaction”). No partial updates are allowed.
Creating Resources
For instance, a new contact might be created with the following request:
POST /contacts HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
{
"data": {
"type": "contacts",
"attributes": {
"...": "..."
},
"relationships": {
"...": "..."
}
}
}
A resource can be created by sending a POST request to a URL that represents a collection of resources. The request MUST include a single resource object as primary data. The resource object MUST contain at least a type member.
If a relationship is provided in the relationships member of the resource object, its value MUST be a relationship object with a data member. The value of this key represents the linkage the new resource is to have.
Client-Generated IDs
All Create endpoints accept a client-generated ID along with a request to create a resource. An ID MUST be specified with an id key, the value of which MUST be a universally unique identifier. If no ID is provided it will be generated automatically. The client SHOULD use a properly generated and formatted UUID as described in RFC 4122.
Where the ID already exists the endpoint WILL return with status HTTP 409 (Conflict). You must regenerate the client formatted UUID and send the request again.
Responses
201 Created
The request WILL return with status HTTP 201 (Created) in response to a request that successfully created a resource.
403 Forbidden
The request WILL return with status HTTP 403 (Forbidden) in response to an unsupported request to create a resource.
404 Not Found
The request WILL return with status HTTP 404 (Not Found) in response to request that references a related resource that does not exist.
409 Conflict
The request WILL return with status HTTP 409 (Conflict) when processing a POST request to create a resource with a client-generated ID that already exists.
The request WILL return with status HTTP 409 (Conflict) when processing a POST request in which the resource object’s type is not among the type(s) that constitute the collection represented by the endpoint.
Updating Resources
PATCH /contacts/1 HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
{
"data": {
"type": "contacts",
"id": "1",
"attributes": {
"...": "..."
}
}
}
A resource can be updated by sending a PATCH request to the URL that represents the resource.
The PATCH request MUST include a single resource object as primary data. The resource object MUST contain type and id members.
Updating a Resource’s Attributes
Any or all of a resource’s attributes MAY be included in the resource object included in a PATCH request.
If a request does not include all of the attributes for a resource, the endpoint WILL interpret the missing attributes as if they were included with their current values. The endpoint WILL NOT interpret missing attributes as null values.
Responses
200 OK
The request WILL return with status HTTP 200 (OK) in response to a request that successfully updated a resource. The response document WILL include a representation of the updated resource(s) as if a GET request was made to the request URL.
403 Forbidden
The request WILL return with status HTTP 403 (Forbidden) in response to an unsupported request to update a resource or relationship.
404 Not Found
The request WILL return with status HTTP 404 (Not Found) in response to request to modify a resource that does not exist.
The request WILL return with status HTTP 404 (Not Found) in response to request that references a related resource that does not exist.
409 Conflict
The request WILL return with status HTTP 409 (Conflict) in response to a PATCH request to update a resource if that update would violate other server-enforced constraints (such as a uniqueness constraint on a property other than id).
The request WILL return with status HTTP 409 (Conflict) in response to a PATCH request when the resource object’s type and id do not match the endpoint’s.
Deleting Resources
An individual resource can be deleted by making a DELETE request to the resource’s URL
DELETE /photos/1 HTTP/1.1
Accept: application/vnd.api+json
Responses
204 No Content
The request WILL return with status HTTP 204 (No Content) in response to request if a deletion request is successful and no content is returned.
404 Not Found
The request WILL return with status HTTP 404 (Not Found) in response to request if a deletion request fails due to the resource not existing.
Entities
Account Lists
Account List [GET]
Account List [GET]
Request
Endpoint
GET /api/v2/account_lists/dd0b59e1-7ae1-4e96-b088-662df81a869d
Content-Type: application/vnd.api+json
GET /api/v2/account_lists/:id
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "dd0b59e1-7ae1-4e96-b088-662df81a869d",
"type": "account_lists",
"attributes": {
"active_mpd_finish_at": null,
"active_mpd_monthly_goal": null,
"active_mpd_start_at": null,
"created_at": "2018-10-12T19:15:01Z",
"currency": "USD",
"default_currency": "USD",
"home_country": "United States",
"monthly_goal": 3605,
"name": "Lubowitz-Cummerata",
"salary_organization": null,
"tester": false,
"total_pledges": 0,
"updated_at": "2018-10-12T19:15:01Z",
"updated_in_db_at": "2018-10-12T19:15:01Z"
},
"relationships": {
"notification_preferences": {
"data": [
]
},
"organization_accounts": {
"data": [
]
},
"primary_appeal": {
"data": null
}
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
currency |
string |
The currency code for the Account List, such as ‘USD’, 'CAD’ |
default_currency |
string |
The default currency code, 'USD’ |
home_country |
string |
The country of the Account List |
monthly_goal |
number |
The monthly financial goal of the Account List |
name |
string |
The name of the Account List |
settings |
Object |
List of settings associated to this Account List |
tester |
boolean |
Whether or not the Account List is a testing account |
total_pledges |
float |
The total amount of pledges donated for the Account List |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
| Relationships | ||
notification_preferences.data |
[Notification Preference] |
An array of Notification Preference references for the Account List |
organization_accounts.data |
[Organization Account] |
An array of Organization Accounts connected to the Account List |
Account List [LIST]
Account List [LIST]
Request
Endpoint
GET /api/v2/account_lists
Content-Type: application/vnd.api+json
GET /api/v2/account_lists
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": [
{
"id": "64786fb1-a6eb-4c7e-b673-57734f402211",
"type": "account_lists",
"attributes": {
"active_mpd_finish_at": null,
"active_mpd_monthly_goal": null,
"active_mpd_start_at": null,
"created_at": "2018-10-12T19:15:01Z",
"currency": "USD",
"default_currency": "USD",
"home_country": "United States",
"monthly_goal": 5854,
"name": "Abernathy-Friesen",
"salary_organization": null,
"tester": false,
"total_pledges": 0,
"updated_at": "2018-10-12T19:15:01Z",
"updated_in_db_at": "2018-10-12T19:15:01Z"
},
"relationships": {
"notification_preferences": {
"data": [
]
},
"organization_accounts": {
"data": [
]
},
"primary_appeal": {
"data": null
}
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 1,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
data |
[Account List] |
An array of Account List Objects |
Account List [PUT]
Account List [PUT]
Request
Endpoint
PUT /api/v2/account_lists/f0bb991e-1007-4f6a-ac6c-10fd379fd30a
Content-Type: application/vnd.api+json
PUT /api/v2/account_lists/:id
Parameters
{
"data": {
"type": "account_lists",
"attributes": {
"currency": "USD",
"home_country": "United States",
"monthly_goal": 7713,
"name": "Anderson, VonRueden and Kemmer",
"tester": false,
"updated_in_db_at": "2018-10-12 21:15:01 +0200"
}
}
}
| Name | Type | Description | Required |
|---|---|---|---|
| Attributes | |||
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created | - |
currency |
string |
The currency code for the Account List, such as 'USD’, 'CAD’ | - |
home_country |
string |
The country of the Account List | - |
monthly_goal |
number |
The monthly financial goal of the Account List | - |
name |
string |
The name of the Account List | - |
overwrite |
boolean |
Only used for updating a record where you want to ignore the server’s ’ ’updated_in_db_at value and force overwrite the values for the record. ’ 'Must be true to work. |
- |
settings |
Object |
List of settings associated to this Account List | - |
tester |
boolean |
Whether or not the Account List is a testing account | - |
total_pledges |
float |
The total amount of pledges donated for the Account List | - |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated | - |
updated_in_db_at |
ISO8601 timestamp |
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. | true |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "f0bb991e-1007-4f6a-ac6c-10fd379fd30a",
"type": "account_lists",
"attributes": {
"active_mpd_finish_at": null,
"active_mpd_monthly_goal": null,
"active_mpd_start_at": null,
"created_at": "2018-10-12T19:15:01Z",
"currency": "USD",
"default_currency": "USD",
"home_country": "United States",
"monthly_goal": 7713,
"name": "Anderson, VonRueden and Kemmer",
"salary_organization": null,
"tester": false,
"total_pledges": 0,
"updated_at": "2018-10-12T19:15:01Z",
"updated_in_db_at": "2018-10-12T19:15:01Z"
},
"relationships": {
"notification_preferences": {
"data": [
]
},
"organization_accounts": {
"data": [
]
},
"primary_appeal": {
"data": null
}
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
currency |
string |
The currency code for the Account List, such as 'USD’, 'CAD’ |
default_currency |
string |
The default currency code, 'USD’ |
home_country |
string |
The country of the Account List |
monthly_goal |
number |
The monthly financial goal of the Account List |
name |
string |
The name of the Account List |
settings |
Object |
List of settings associated to this Account List |
tester |
boolean |
Whether or not the Account List is a testing account |
total_pledges |
float |
The total amount of pledges donated for the Account List |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
| Relationships | ||
notification_preferences.data |
[Notification Preference] |
An array of Notification Preference references for the Account List |
organization_accounts.data |
[Organization Account] |
An array of Organization Accounts connected to the Account List |
Appeals
Appeal [DELETE]
Appeal [DELETE]
Request
Endpoint
DELETE /api/v2/appeals/a791a758-a9f9-4692-825a-019d0a74f331
Content-Type: application/vnd.api+json
DELETE /api/v2/appeals/:id
Parameters
None known.
Response
204 No Content
Appeal [GET]
Appeal [GET]
Request
Endpoint
GET /api/v2/appeals/fac3ac4b-141a-48b5-b1bb-7491ade7da52
Content-Type: application/vnd.api+json
GET /api/v2/appeals/:id
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "fac3ac4b-141a-48b5-b1bb-7491ade7da52",
"type": "appeals",
"attributes": {
"amount": "1000.0",
"created_at": "2018-10-12T19:15:03Z",
"currencies": [
"ZAR"
],
"description": "The description for my new Appeal",
"end_date": "2018-10-19",
"name": "Appeal #9",
"pledges_amount_not_received_not_processed": 0,
"pledges_amount_processed": 0,
"pledges_amount_received_not_processed": 0,
"pledges_amount_total": 0,
"total_currency": "USD",
"updated_at": "2018-10-12T19:15:03Z",
"updated_in_db_at": "2018-10-12T19:15:03Z"
},
"relationships": {
"account_list": {
"data": {
"id": "4fda791f-e53a-44ac-8674-0ca6e5f84be0",
"type": "account_lists"
}
},
"contacts": {
"data": [
]
},
"donations": {
"data": [
{
"id": "7c565b53-d904-4837-81da-0182024c0a34",
"type": "donations"
}
]
}
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
amount |
float |
The amount requested for this Appeal |
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
currencies |
[string] |
The currencies of the donations for this Appeal |
description |
string |
The description for this Appeal |
end_date |
date string |
The date in which this Appeal ends |
name |
string |
The name of the Appeal |
total_currency |
string |
The type of currency for the Appeal’s donations to be converted to |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
| Relationships | ||
account_list.data.id |
id string |
The id of the Account List that the Appeal belongs to |
contacts.data |
[Contact] |
An array of Contact references for the Appeal |
donations.data |
[Donation] |
An array of Donation references for the Appeal |
Appeal [LIST]
Appeal [LIST]
Request
Endpoint
GET /api/v2/appeals
Content-Type: application/vnd.api+json
GET /api/v2/appeals
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| Filters | |||
filter[account_list_id] |
id string |
Filter by Account List; accepts an Account List id; this is required if you want the Contact included on Donations. |
- |
filter[excluded] |
number |
Filter by excluded Contacts | - |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": [
{
"id": "d67e41a1-0633-4f4d-9014-7537a988b404",
"type": "appeals",
"attributes": {
"amount": "1000.0",
"created_at": "2018-10-12T19:15:03Z",
"currencies": [
"ZAR"
],
"description": "The description for my new Appeal",
"end_date": "2018-10-19",
"name": "Appeal #8",
"pledges_amount_not_received_not_processed": 0,
"pledges_amount_processed": 0,
"pledges_amount_received_not_processed": 0,
"pledges_amount_total": 0,
"total_currency": "USD",
"updated_at": "2018-10-12T19:15:03Z",
"updated_in_db_at": "2018-10-12T19:15:03Z"
},
"relationships": {
"account_list": {
"data": {
"id": "2ba6d1e8-f181-4bab-825d-0cbaa2750c3e",
"type": "account_lists"
}
},
"contacts": {
"data": [
]
},
"donations": {
"data": [
{
"id": "db98daa1-eedd-403b-8d0d-648875da8cfd",
"type": "donations"
}
]
}
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 1,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
data |
[Appeal] |
An array of Appeal Objects |
Appeal [POST]
Appeal [POST]
Request
Endpoint
POST /api/v2/appeals
Content-Type: application/vnd.api+json
POST /api/v2/appeals
Parameters
{
"data": {
"type": "appeals",
"attributes": {
"amount": 1000.0,
"description": "The description for my new Appeal",
"end_date": "2018-10-19",
"exclusion_filter": {
"status": "Partner - Financial"
},
"inclusion_filter": {
"status": "Partner - Financial,Partner - Pray"
},
"name": "Appeal #11",
"updated_in_db_at": "2018-10-12 21:15:04 +0200"
},
"relationships": {
"account_list": {
"data": {
"type": "account_lists",
"id": "63844226-8698-42f9-8c47-158b6e632ea0"
}
}
}
}
}
| Name | Type | Description | Required |
|---|---|---|---|
| Attributes | |||
amount |
float |
The amount requested for this Appeal | - |
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created | - |
description |
string |
The description for this Appeal | - |
end_date |
date string |
The date in which this Appeal ends | - |
name |
string |
The name of the Appeal | true |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated | - |
updated_in_db_at |
ISO8601 timestamp |
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. | - |
| Relationships | |||
account_list.data.id |
id string |
The id of the Account List that the Appeal belongs to |
true |
donations.data |
[Donation] |
An array of Donation references for the Appeal | - |
Response
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
{
"data": {
"id": "a7299ee8-e043-437c-8046-7e9db1db728f",
"type": "appeals",
"attributes": {
"amount": "1000.0",
"created_at": "2018-10-12T19:15:04Z",
"currencies": [
],
"description": "The description for my new Appeal",
"end_date": "2018-10-19",
"name": "Appeal #11",
"pledges_amount_not_received_not_processed": 0,
"pledges_amount_processed": 0,
"pledges_amount_received_not_processed": 0,
"pledges_amount_total": 0,
"total_currency": "USD",
"updated_at": "2018-10-12T19:15:04Z",
"updated_in_db_at": "2018-10-12T19:15:04Z"
},
"relationships": {
"account_list": {
"data": {
"id": "63844226-8698-42f9-8c47-158b6e632ea0",
"type": "account_lists"
}
},
"contacts": {
"data": [
{
"id": "dc74b6b1-9073-4ca6-a9d4-55136890bb70",
"type": "contacts"
}
]
},
"donations": {
"data": [
]
}
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
amount |
float |
The amount requested for this Appeal |
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
currencies |
[string] |
The currencies of the donations for this Appeal |
description |
string |
The description for this Appeal |
end_date |
date string |
The date in which this Appeal ends |
name |
string |
The name of the Appeal |
total_currency |
string |
The type of currency for the Appeal’s donations to be converted to |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
| Relationships | ||
account_list.data.id |
id string |
The id of the Account List that the Appeal belongs to |
contacts.data |
[Contact] |
An array of Contact references for the Appeal |
donations.data |
[Donation] |
An array of Donation references for the Appeal |
Appeal [PUT]
Appeal [PUT]
Request
Endpoint
PUT /api/v2/appeals/f8c9856d-0669-4e9b-96db-f85045f98ba6
Content-Type: application/vnd.api+json
PUT /api/v2/appeals/:id
Parameters
{
"data": {
"type": "appeals",
"attributes": {
"amount": 1000.0,
"description": "The description for my new Appeal",
"end_date": "2018-10-19",
"exclusion_filter": {
"status": "Partner - Financial"
},
"inclusion_filter": {
"status": "Partner - Financial,Partner - Pray"
},
"name": "Appeal #13",
"updated_in_db_at": "2018-10-12 21:15:04 +0200"
}
}
}
| Name | Type | Description | Required |
|---|---|---|---|
| Attributes | |||
amount |
float |
The amount requested for this Appeal | - |
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created | - |
description |
string |
The description for this Appeal | - |
end_date |
date string |
The date in which this Appeal ends | - |
name |
string |
The name of the Appeal | - |
overwrite |
boolean |
Only used for updating a record where you want to ignore the server’s ’ ’updated_in_db_at value and force overwrite the values for the record. ’ 'Must be true to work. |
- |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated | - |
updated_in_db_at |
ISO8601 timestamp |
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. | true |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "f8c9856d-0669-4e9b-96db-f85045f98ba6",
"type": "appeals",
"attributes": {
"amount": "1000.0",
"created_at": "2018-10-12T19:15:04Z",
"currencies": [
"ZAR"
],
"description": "The description for my new Appeal",
"end_date": "2018-10-19",
"name": "Appeal #13",
"pledges_amount_not_received_not_processed": 0,
"pledges_amount_processed": 0,
"pledges_amount_received_not_processed": 0,
"pledges_amount_total": 0,
"total_currency": "USD",
"updated_at": "2018-10-12T19:15:04Z",
"updated_in_db_at": "2018-10-12T19:15:04Z"
},
"relationships": {
"account_list": {
"data": {
"id": "4083b0db-240d-4cd4-ac07-38874c6a03a2",
"type": "account_lists"
}
},
"contacts": {
"data": [
]
},
"donations": {
"data": [
{
"id": "925da8e6-5cf8-44bb-9ae2-6b892ad09992",
"type": "donations"
}
]
}
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
amount |
float |
The amount requested for this Appeal |
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
currencies |
[string] |
The currencies of the donations for this Appeal |
description |
string |
The description for this Appeal |
end_date |
date string |
The date in which this Appeal ends |
name |
string |
The name of the Appeal |
total_currency |
string |
The type of currency for the Appeal’s donations to be converted to |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
| Relationships | ||
account_list.data.id |
id string |
The id of the Account List that the Appeal belongs to |
contacts.data |
[Contact] |
An array of Contact references for the Appeal |
donations.data |
[Donation] |
An array of Donation references for the Appeal |
Background Batches
Background Batch [DELETE]
Background Batch [DELETE]
Request
Endpoint
DELETE /api/v2/background_batches/98423338-608c-4737-9b6c-f5a05b500267
Content-Type: application/vnd.api+json
DELETE /api/v2/background_batches/:id
Parameters
None known.
Response
204 No Content
Background Batch [GET]
Background Batch [GET]
Request
Endpoint
GET /api/v2/background_batches/693c0730-f851-4f68-ad95-055a520ef99e
Content-Type: application/vnd.api+json
GET /api/v2/background_batches/:id
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "693c0730-f851-4f68-ad95-055a520ef99e",
"type": "background_batches",
"attributes": {
"created_at": "2018-10-12T19:15:04Z",
"pending": 0,
"total": 1,
"updated_at": "2018-10-12T19:15:04Z",
"updated_in_db_at": "2018-10-12T19:15:04Z"
},
"relationships": {
"requests": {
"data": [
{
"id": "40ccd221-5749-47bf-9a3d-e53bb9a03032",
"type": "background_batch_requests"
}
]
}
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
pending |
integer |
The total number of requests still to be processed |
total |
integer |
The total number of requests |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
| Relationships | ||
requests.data |
[Bulk Background Request] |
An array of Bulk Background Requests references for the Bulk Background |
user.data.id |
id string |
The id of the User that the Bulk Background belongs to |
Background Batch [LIST]
Background Batch [LIST]
Request
Endpoint
GET /api/v2/background_batches
Content-Type: application/vnd.api+json
GET /api/v2/background_batches
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": [
{
"id": "696c3198-1c8b-4c28-a5e4-4eef92a757e5",
"type": "background_batches",
"attributes": {
"created_at": "2018-10-12T19:15:04Z",
"pending": 0,
"total": 1,
"updated_at": "2018-10-12T19:15:04Z",
"updated_in_db_at": "2018-10-12T19:15:04Z"
},
"relationships": {
"requests": {
"data": [
{
"id": "ae80f5cb-2970-4888-bd81-9a34a75a752a",
"type": "background_batch_requests"
}
]
}
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 1,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
data |
[Bulk Background] |
An array of Bulk Background Objects |
Background Batch [POST]
an individual element of the
requestsarray
{
"data": {
"type": "background_batch_requests",
"id": "1d6393dd-f3f4-49d3-9fd8-7e758b056b1f",
"attributes": {
"path": "api/v2/account_lists/%{default_account_list_id}/donations"
"request_params": {
"filter": {
"account_list_id": "users default account list id"
} // Added only if default_account_list is true
} // GET params are automatically added in as query params
"request_body": ""
"request_headers": {
"accept": "application/vnd.api+json",
"authorization": "Bearer JWT", // User JWT is inserted here
"content-type": "application/vnd.api+json"
} // These headers are included by default
"request_method": "GET" // GET, POST, PUT, or DELETE (GET by default)
"default_account_list": false // should only be true on index requests
}
}
}
You are required to include at least one request relationship.
- Each request must have a path
- If you include %{default_account_list_id} template in your path string it will substitute the user’s default_account_list_id
Request
Endpoint
POST /api/v2/background_batches
Content-Type: application/vnd.api+json
POST /api/v2/background_batches
Parameters
{
"data": {
"type": "background_batches",
"attributes": {
"batch_id": "MyString"
},
"relationships": {
"requests": {
"data": [
{
"type": "background_batch_requests",
"id": "273c15d0-4770-41d1-92aa-ee0ff71fbaee",
"attributes": {
"path": "api/v2/user"
}
}
]
}
}
}
}
| Name | Type | Description | Required |
|---|---|---|---|
| Attributes | |||
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created | - |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated | - |
updated_in_db_at |
ISO8601 timestamp |
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. | - |
| Relationships | |||
requests.data |
[Bulk Background Request] |
An array of Bulk Background Requests references for the Bulk Background | - |
user.data.id |
id string |
The id of the User that the Bulk Background belongs to |
- |
Response
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
{
"data": {
"id": "7907b769-616a-460a-b89b-eced77a47535",
"type": "background_batches",
"attributes": {
"created_at": "2018-10-12T19:15:05Z",
"pending": 0,
"total": 1,
"updated_at": "2018-10-12T19:15:05Z",
"updated_in_db_at": "2018-10-12T19:15:05Z"
},
"relationships": {
"requests": {
"data": [
{
"id": "8a8b8da7-5a07-4620-ab41-318c1bd68c19",
"type": "background_batch_requests"
}
]
}
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
pending |
integer |
The total number of requests still to be processed |
total |
integer |
The total number of requests |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
| Relationships | ||
requests.data |
[Bulk Background Request] |
An array of Bulk Background Requests references for the Bulk Background |
user.data.id |
id string |
The id of the User that the Bulk Background belongs to |
Constants
List constants
List of Constants
Request
Endpoint
GET /api/v2/constants
Content-Type: application/vnd.api+json
GET /api/v2/constants
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "constantlist",
"type": "constant_list",
"attributes": {
"activities": [
"Call",
"Appointment",
"Email",
"Text Message",
"Facebook Message",
"Letter",
"Newsletter - Physical",
"Newsletter - Email",
"Pre Call Letter",
"Reminder Letter",
"Support Letter",
"Thank",
"To Do",
"Talk to In Person",
"Prayer Request"
],
"alert_frequencies": {
"0": "at the time of event",
"300": "5 minutes before",
"900": "15 minutes before",
"1800": "30 minutes before",
"3600": "1 hour before",
"7200": "2 hours before",
"86400": "1 day before",
"172800": "2 days before",
"604800": "1 week before"
},
"assignable_likely_to_give": [
"Least Likely",
"Likely",
"Most Likely"
],
"assignable_locations": [
"Home",
"Business",
"Mailing",
"Seasonal",
"Other",
"Temporary",
"Rep Address"
],
"assignable_send_newsletter": [
"Physical",
"Email",
"Both",
"None"
],
"assignable_statuses": [
"Never Contacted",
"Ask in Future",
"Cultivate Relationship",
"Contact for Appointment",
"Appointment Scheduled",
"Call for Decision",
"Partner - Financial",
"Partner - Special",
"Partner - Pray",
"Not Interested",
"Unresponsive",
"Never Ask",
"Research Abandoned",
"Expired Referral"
],
"codes": [
"AED",
"AFN",
"ALK",
"ALL",
"AMD",
"ANG",
"AOA",
"AOK",
"AON",
"AOR",
"ARA",
"ARL",
"ARM",
"ARP",
"ARS",
"ATS",
"AUD",
"AWG",
"AZM",
"AZN",
"BAD",
"BAM",
"BAN",
"BBD",
"BDT",
"BEC",
"BEF",
"BEL",
"BGL",
"BGM",
"BGN",
"BGO",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BOL",
"BOP",
"BOV",
"BRB",
"BRC",
"BRE",
"BRL",
"BRN",
"BRR",
"BRZ",
"BSD",
"BTN",
"BUK",
"BWP",
"BYB",
"BYR",
"BZD",
"CAD",
"CDF",
"CHE",
"CHF",
"CHW",
"CLE",
"CLF",
"CLP",
"CNX",
"CNY",
"COP",
"COU",
"CRC",
"CSD",
"CSK",
"CUC",
"CUP",
"CVE",
"CYP",
"CZK",
"DDM",
"DEM",
"DJF",
"DKK",
"DOP",
"DZD",
"ECS",
"ECV",
"EEK",
"EGP",
"ERN",
"ESA",
"ESB",
"ESP",
"ETB",
"EUR",
"FIM",
"FJD",
"FKP",
"FRF",
"GBP",
"GEK",
"GEL",
"GHC",
"GHS",
"GIP",
"GMD",
"GNF",
"GNS",
"GQE",
"GRD",
"GTQ",
"GWE",
"GWP",
"GYD",
"HKD",
"HNL",
"HRD",
"HRK",
"HTG",
"HUF",
"IDR",
"IEP",
"ILP",
"ILR",
"ILS",
"INR",
"IQD",
"IRR",
"ISJ",
"ISK",
"ITL",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRH",
"KRO",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LTL",
"LTT",
"LUC",
"LUF",
"LUL",
"LVL",
"LVR",
"LYD",
"MAD",
"MAF",
"MCF",
"MDC",
"MDL",
"MGA",
"MGF",
"MKD",
"MKN",
"MLF",
"MMK",
"MNT",
"MOP",
"MRO",
"MTL",
"MTP",
"MUR",
"MVP",
"MVR",
"MWK",
"MXN",
"MXP",
"MXV",
"MYR",
"MZE",
"MZM",
"MZN",
"NAD",
"NGN",
"NIC",
"NIO",
"NLG",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEI",
"PEN",
"PES",
"PGK",
"PHP",
"PKR",
"PLN",
"PLZ",
"PTE",
"PYG",
"QAR",
"RHD",
"ROL",
"RON",
"RSD",
"RUB",
"RUR",
"RWF",
"SAR",
"SBD",
"SCR",
"SDD",
"SDG",
"SDP",
"SEK",
"SGD",
"SHP",
"SIT",
"SKK",
"SLL",
"SOS",
"SRD",
"SRG",
"SSP",
"STD",
"SUR",
"SVC",
"SYP",
"SZL",
"THB",
"TJR",
"TJS",
"TMM",
"TMT",
"TND",
"TOP",
"TPE",
"TRL",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UAK",
"UGS",
"UGX",
"USD",
"USN",
"USS",
"UYI",
"UYP",
"UYU",
"UZS",
"VEB",
"VEF",
"VND",
"VNN",
"VUV",
"WST",
"XAF",
"XAG",
"XAU",
"XBA",
"XBB",
"XBC",
"XBD",
"XCD",
"XDR",
"XEU",
"XFO",
"XFU",
"XOF",
"XPD",
"XPF",
"XPT",
"XRE",
"XSU",
"XTS",
"XUA",
"XXX",
"YDD",
"YER",
"YUD",
"YUM",
"YUN",
"YUR",
"ZAL",
"ZAR",
"ZMK",
"ZMW",
"ZRN",
"ZRZ",
"ZWD",
"ZWL",
"ZWR"
],
"mobile_alert_frequencies": {
"0": "at the time of event",
"300": "5 minutes before",
"900": "15 minutes before",
"1800": "30 minutes before",
"3600": "1 hour before",
"7200": "2 hours before",
"86400": "1 day before",
"172800": "2 days before",
"604800": "1 week before"
},
"next_actions": {
"call": [
"Call",
"Email",
"Text Message",
"Facebook Message",
"Talk to In Person",
"Appointment",
"Prayer Request",
"Thank"
],
"appointment": [
"Call",
"Email",
"Text Message",
"Facebook Message",
"Talk to In Person",
"Appointment",
"Prayer Request",
"Thank"
],
"email": [
"Call",
"Email",
"Text Message",
"Facebook Message",
"Talk to In Person",
"Appointment",
"Prayer Request",
"Thank"
],
"facebook message": [
"Call",
"Email",
"Text Message",
"Facebook Message",
"Talk to In Person",
"Appointment",
"Prayer Request",
"Thank"
],
"text message": [
"Call",
"Email",
"Text Message",
"Facebook Message",
"Talk to In Person",
"Appointment",
"Prayer Request",
"Thank"
],
"talk to in person": [
"Call",
"Email",
"Text Message",
"Facebook Message",
"Talk to In Person",
"Appointment",
"Prayer Request",
"Thank"
],
"prayer request": [
"Call",
"Email",
"Text Message",
"Facebook Message",
"Talk to In Person",
"Appointment",
"Prayer Request",
"Thank"
],
"letter": [
"Call",
"Email",
"Text Message",
"Facebook Message",
"Talk to In Person",
"None"
],
"pre call letter": [
"Call",
"Email",
"Text Message",
"Facebook Message",
"Talk to In Person",
"None"
],
"reminder letter": [
"Call",
"Email",
"Text Message",
"Facebook Message",
"Talk to In Person",
"None"
],
"support letter": [
"Call",
"Email",
"Text Message",
"Facebook Message",
"Talk to In Person",
"None"
],
"thank": [
"Call",
"Email",
"Text Message",
"Facebook Message",
"Talk to In Person",
"None"
],
"default": [
"None"
]
},
"notifications": {
"201d4cfb_45e7_420f_a5c4_135d2f979591": "Partner missed a gift",
"e7bf6999_fc50_44fa_90fe_2a51fb63c3d7": "Partner started giving",
"7c39a95c_4858_4079_9df3_a645c24f8f1f": "Partner gave a larger gift than commitment",
"6693844a_dbab_4e03_a5e3_122217e9593c": "Partner gave a Special Gift",
"ea77e07e_1e59_4918_b73b_040ad64b461f": "Partner gave less than commitment",
"1f268c0c_27d6_448f_bbcc_6db70eb8be6a": "Partner recontinued giving",
"1a74ca83_485a_4d59_937d_b6a1756825b2": "Partner gave with commitment of semi-annual or more",
"e55f8a53_195a_40dc_a082_29a10d8c8794": "Partner have not had an attempted call logged in the past year",
"a5f87e17_f8bf_449b_a85e_f6551964bca4": "Partner have not had a thank you note logged in the past year",
"0674ada5_be5e_40fa_a912_8c0d39ce3740": "Partner (semiannual, annual, etc) has an expected donation one month from now. Send them a reminder.",
"5012c75b_a5d5_48c7_9c61_120f44ee70a7": "Contact is on the physical newsletter but has no mailing address.",
"f39b4e18_5486_4ac2_a3aa_985beb165fa9": "Contact is on the email newsletter but has no people with a valid email address."
},
"organizations": {
"67e4e6f7_7e93_412f_9776_75a7b60b2f71": "Organization206",
"58807109_acc9_408f_9121_19a9d6ab0ebf": "Organization207"
},
"organizations_attributes": {
"67e4e6f7_7e93_412f_9776_75a7b60b2f71": {
"name": "Organization206",
"api_class": "FakeApi",
"help_email": null,
"oauth": false
},
"58807109_acc9_408f_9121_19a9d6ab0ebf": {
"name": "Organization207",
"api_class": "DataServer",
"help_email": null,
"oauth": false
}
},
"pledge_frequencies": {
"0.23076923076923": "Weekly",
"0.46153846153846": "Every 2 Weeks",
"1.0": "Monthly",
"2.0": "Every 2 Months",
"3.0": "Quarterly",
"4.0": "Every 4 Months",
"6.0": "Every 6 Months",
"12.0": "Annual",
"24.0": "Every 2 Years"
},
"results": {
"call": [
"Attempted - Left Message",
"Attempted",
"Completed",
"Received"
],
"appointment": [
"Completed",
"Attempted"
],
"email": [
"Completed",
"Received"
],
"facebook message": [
"Completed",
"Received"
],
"text message": [
"Completed",
"Received"
],
"talk to in person": [
"Completed"
],
"letter": [
"Completed",
"Received"
],
"pre call letter": [
"Completed",
"Received"
],
"reminder letter": [
"Completed",
"Received"
],
"support letter": [
"Completed",
"Received"
],
"thank": [
"Completed",
"Received"
],
"default": [
"Done"
]
},
"statuses": [
"Never Contacted",
"Ask in Future",
"Cultivate Relationship",
"Contact for Appointment",
"Appointment Scheduled",
"Call for Decision",
"Partner - Financial",
"Partner - Special",
"Partner - Pray",
"Not Interested",
"Unresponsive",
"Never Ask",
"Research Abandoned",
"Expired Referral"
],
"csv_import": {
"constants": {
"pledge_currency": [
{
"id": "AED",
"key": "AED",
"value": "AED (AED)"
},
{
"id": "AFN",
"key": "AFN",
"value": "AFN (؋)"
},
{
"id": "ALK",
"key": "ALK",
"value": "ALK (ALK)"
},
{
"id": "ALL",
"key": "ALL",
"value": "ALL (LEK)"
},
{
"id": "AMD",
"key": "AMD",
"value": "AMD (AMD)"
},
{
"id": "ANG",
"key": "ANG",
"value": "ANG (ƒ)"
},
{
"id": "AOA",
"key": "AOA",
"value": "AOA (Kz)"
},
{
"id": "AOK",
"key": "AOK",
"value": "AOK (AOK)"
},
{
"id": "AON",
"key": "AON",
"value": "AON (AON)"
},
{
"id": "AOR",
"key": "AOR",
"value": "AOR (AOR)"
},
{
"id": "ARA",
"key": "ARA",
"value": "ARA (ARA)"
},
{
"id": "ARL",
"key": "ARL",
"value": "ARL (ARL)"
},
{
"id": "ARM",
"key": "ARM",
"value": "ARM (ARM)"
},
{
"id": "ARP",
"key": "ARP",
"value": "ARP (ARP)"
},
{
"id": "ARS",
"key": "ARS",
"value": "ARS ($)"
},
{
"id": "ATS",
"key": "ATS",
"value": "ATS (ATS)"
},
{
"id": "AUD",
"key": "AUD",
"value": "AUD ($)"
},
{
"id": "AWG",
"key": "AWG",
"value": "AWG (ƒ)"
},
{
"id": "AZM",
"key": "AZM",
"value": "AZM (AZM)"
},
{
"id": "AZN",
"key": "AZN",
"value": "AZN (ман)"
},
{
"id": "BAD",
"key": "BAD",
"value": "BAD (BAD)"
},
{
"id": "BAM",
"key": "BAM",
"value": "BAM (KM)"
},
{
"id": "BAN",
"key": "BAN",
"value": "BAN (BAN)"
},
{
"id": "BBD",
"key": "BBD",
"value": "BBD ($)"
},
{
"id": "BDT",
"key": "BDT",
"value": "BDT (৳)"
},
{
"id": "BEC",
"key": "BEC",
"value": "BEC (BEC)"
},
{
"id": "BEF",
"key": "BEF",
"value": "BEF (BEF)"
},
{
"id": "BEL",
"key": "BEL",
"value": "BEL (BEL)"
},
{
"id": "BGL",
"key": "BGL",
"value": "BGL (BGL)"
},
{
"id": "BGM",
"key": "BGM",
"value": "BGM (BGM)"
},
{
"id": "BGN",
"key": "BGN",
"value": "BGN (лв)"
},
{
"id": "BGO",
"key": "BGO",
"value": "BGO (BGO)"
},
{
"id": "BHD",
"key": "BHD",
"value": "BHD (BHD)"
},
{
"id": "BIF",
"key": "BIF",
"value": "BIF (BIF)"
},
{
"id": "BMD",
"key": "BMD",
"value": "BMD ($)"
},
{
"id": "BND",
"key": "BND",
"value": "BND ($)"
},
{
"id": "BOB",
"key": "BOB",
"value": "BOB ($b)"
},
{
"id": "BOL",
"key": "BOL",
"value": "BOL (BOL)"
},
{
"id": "BOP",
"key": "BOP",
"value": "BOP (BOP)"
},
{
"id": "BOV",
"key": "BOV",
"value": "BOV (BOV)"
},
{
"id": "BRB",
"key": "BRB",
"value": "BRB (BRB)"
},
{
"id": "BRC",
"key": "BRC",
"value": "BRC (BRC)"
},
{
"id": "BRE",
"key": "BRE",
"value": "BRE (BRE)"
},
{
"id": "BRL",
"key": "BRL",
"value": "BRL (R$)"
},
{
"id": "BRN",
"key": "BRN",
"value": "BRN (BRN)"
},
{
"id": "BRR",
"key": "BRR",
"value": "BRR (BRR)"
},
{
"id": "BRZ",
"key": "BRZ",
"value": "BRZ (BRZ)"
},
{
"id": "BSD",
"key": "BSD",
"value": "BSD ($)"
},
{
"id": "BTN",
"key": "BTN",
"value": "BTN (BTN)"
},
{
"id": "BUK",
"key": "BUK",
"value": "BUK (BUK)"
},
{
"id": "BWP",
"key": "BWP",
"value": "BWP (P)"
},
{
"id": "BYB",
"key": "BYB",
"value": "BYB (BYB)"
},
{
"id": "BYR",
"key": "BYR",
"value": "BYR (p.)"
},
{
"id": "BZD",
"key": "BZD",
"value": "BZD (BZ$)"
},
{
"id": "CAD",
"key": "CAD",
"value": "CAD ($)"
},
{
"id": "CDF",
"key": "CDF",
"value": "CDF (CDF)"
},
{
"id": "CHE",
"key": "CHE",
"value": "CHE (CHE)"
},
{
"id": "CHF",
"key": "CHF",
"value": "CHF (CHF)"
},
{
"id": "CHW",
"key": "CHW",
"value": "CHW (CHW)"
},
{
"id": "CLE",
"key": "CLE",
"value": "CLE (CLE)"
},
{
"id": "CLF",
"key": "CLF",
"value": "CLF (CLF)"
},
{
"id": "CLP",
"key": "CLP",
"value": "CLP ($)"
},
{
"id": "CNX",
"key": "CNX",
"value": "CNX (CNX)"
},
{
"id": "CNY",
"key": "CNY",
"value": "CNY (¥)"
},
{
"id": "COP",
"key": "COP",
"value": "COP ($)"
},
{
"id": "COU",
"key": "COU",
"value": "COU (COU)"
},
{
"id": "CRC",
"key": "CRC",
"value": "CRC (₡)"
},
{
"id": "CSD",
"key": "CSD",
"value": "CSD (CSD)"
},
{
"id": "CSK",
"key": "CSK",
"value": "CSK (CSK)"
},
{
"id": "CUC",
"key": "CUC",
"value": "CUC ($)"
},
{
"id": "CUP",
"key": "CUP",
"value": "CUP (₱)"
},
{
"id": "CVE",
"key": "CVE",
"value": "CVE (CVE)"
},
{
"id": "CYP",
"key": "CYP",
"value": "CYP (CYP)"
},
{
"id": "CZK",
"key": "CZK",
"value": "CZK (Kč)"
},
{
"id": "DDM",
"key": "DDM",
"value": "DDM (DDM)"
},
{
"id": "DEM",
"key": "DEM",
"value": "DEM (DEM)"
},
{
"id": "DJF",
"key": "DJF",
"value": "DJF (DJF)"
},
{
"id": "DKK",
"key": "DKK",
"value": "DKK (kr)"
},
{
"id": "DOP",
"key": "DOP",
"value": "DOP (RD$)"
},
{
"id": "DZD",
"key": "DZD",
"value": "DZD (DZD)"
},
{
"id": "ECS",
"key": "ECS",
"value": "ECS (ECS)"
},
{
"id": "ECV",
"key": "ECV",
"value": "ECV (ECV)"
},
{
"id": "EEK",
"key": "EEK",
"value": "EEK (kr)"
},
{
"id": "EGP",
"key": "EGP",
"value": "EGP (£)"
},
{
"id": "ERN",
"key": "ERN",
"value": "ERN (ERN)"
},
{
"id": "ESA",
"key": "ESA",
"value": "ESA (ESA)"
},
{
"id": "ESB",
"key": "ESB",
"value": "ESB (ESB)"
},
{
"id": "ESP",
"key": "ESP",
"value": "ESP (₧)"
},
{
"id": "ETB",
"key": "ETB",
"value": "ETB (ETB)"
},
{
"id": "EUR",
"key": "EUR",
"value": "EUR (€)"
},
{
"id": "FIM",
"key": "FIM",
"value": "FIM (FIM)"
},
{
"id": "FJD",
"key": "FJD",
"value": "FJD ($)"
},
{
"id": "FKP",
"key": "FKP",
"value": "FKP (£)"
},
{
"id": "FRF",
"key": "FRF",
"value": "FRF (FRF)"
},
{
"id": "GBP",
"key": "GBP",
"value": "GBP (£)"
},
{
"id": "GEK",
"key": "GEK",
"value": "GEK (GEK)"
},
{
"id": "GEL",
"key": "GEL",
"value": "GEL (₾)"
},
{
"id": "GHC",
"key": "GHC",
"value": "GHC (GHC)"
},
{
"id": "GHS",
"key": "GHS",
"value": "GHS (¢)"
},
{
"id": "GIP",
"key": "GIP",
"value": "GIP (£)"
},
{
"id": "GMD",
"key": "GMD",
"value": "GMD (GMD)"
},
{
"id": "GNF",
"key": "GNF",
"value": "GNF (FG)"
},
{
"id": "GNS",
"key": "GNS",
"value": "GNS (GNS)"
},
{
"id": "GQE",
"key": "GQE",
"value": "GQE (GQE)"
},
{
"id": "GRD",
"key": "GRD",
"value": "GRD (GRD)"
},
{
"id": "GTQ",
"key": "GTQ",
"value": "GTQ (Q)"
},
{
"id": "GWE",
"key": "GWE",
"value": "GWE (GWE)"
},
{
"id": "GWP",
"key": "GWP",
"value": "GWP (GWP)"
},
{
"id": "GYD",
"key": "GYD",
"value": "GYD ($)"
},
{
"id": "HKD",
"key": "HKD",
"value": "HKD ($)"
},
{
"id": "HNL",
"key": "HNL",
"value": "HNL (L)"
},
{
"id": "HRD",
"key": "HRD",
"value": "HRD (HRD)"
},
{
"id": "HRK",
"key": "HRK",
"value": "HRK (kn)"
},
{
"id": "HTG",
"key": "HTG",
"value": "HTG (HTG)"
},
{
"id": "HUF",
"key": "HUF",
"value": "HUF (Ft)"
},
{
"id": "IDR",
"key": "IDR",
"value": "IDR (Rp)"
},
{
"id": "IEP",
"key": "IEP",
"value": "IEP (IEP)"
},
{
"id": "ILP",
"key": "ILP",
"value": "ILP (ILP)"
},
{
"id": "ILR",
"key": "ILR",
"value": "ILR (ILR)"
},
{
"id": "ILS",
"key": "ILS",
"value": "ILS (₪)"
},
{
"id": "INR",
"key": "INR",
"value": "INR (₨)"
},
{
"id": "IQD",
"key": "IQD",
"value": "IQD (IQD)"
},
{
"id": "IRR",
"key": "IRR",
"value": "IRR (﷼)"
},
{
"id": "ISJ",
"key": "ISJ",
"value": "ISJ (ISJ)"
},
{
"id": "ISK",
"key": "ISK",
"value": "ISK (kr)"
},
{
"id": "ITL",
"key": "ITL",
"value": "ITL (ITL)"
},
{
"id": "JMD",
"key": "JMD",
"value": "JMD ($)"
},
{
"id": "JOD",
"key": "JOD",
"value": "JOD (JOD)"
},
{
"id": "JPY",
"key": "JPY",
"value": "JPY (¥)"
},
{
"id": "KES",
"key": "KES",
"value": "KES (KES)"
},
{
"id": "KGS",
"key": "KGS",
"value": "KGS (лв)"
},
{
"id": "KHR",
"key": "KHR",
"value": "KHR (៛)"
},
{
"id": "KMF",
"key": "KMF",
"value": "KMF (CF)"
},
{
"id": "KPW",
"key": "KPW",
"value": "KPW (₩)"
},
{
"id": "KRH",
"key": "KRH",
"value": "KRH (KRH)"
},
{
"id": "KRO",
"key": "KRO",
"value": "KRO (KRO)"
},
{
"id": "KRW",
"key": "KRW",
"value": "KRW (₩)"
},
{
"id": "KWD",
"key": "KWD",
"value": "KWD (KWD)"
},
{
"id": "KYD",
"key": "KYD",
"value": "KYD ($)"
},
{
"id": "KZT",
"key": "KZT",
"value": "KZT (лв)"
},
{
"id": "LAK",
"key": "LAK",
"value": "LAK (₭)"
},
{
"id": "LBP",
"key": "LBP",
"value": "LBP (£)"
},
{
"id": "LKR",
"key": "LKR",
"value": "LKR (₨)"
},
{
"id": "LRD",
"key": "LRD",
"value": "LRD ($)"
},
{
"id": "LSL",
"key": "LSL",
"value": "LSL (LSL)"
},
{
"id": "LTL",
"key": "LTL",
"value": "LTL (Lt)"
},
{
"id": "LTT",
"key": "LTT",
"value": "LTT (LTT)"
},
{
"id": "LUC",
"key": "LUC",
"value": "LUC (LUC)"
},
{
"id": "LUF",
"key": "LUF",
"value": "LUF (LUF)"
},
{
"id": "LUL",
"key": "LUL",
"value": "LUL (LUL)"
},
{
"id": "LVL",
"key": "LVL",
"value": "LVL (Ls)"
},
{
"id": "LVR",
"key": "LVR",
"value": "LVR (LVR)"
},
{
"id": "LYD",
"key": "LYD",
"value": "LYD (LYD)"
},
{
"id": "MAD",
"key": "MAD",
"value": "MAD (MAD)"
},
{
"id": "MAF",
"key": "MAF",
"value": "MAF (MAF)"
},
{
"id": "MCF",
"key": "MCF",
"value": "MCF (MCF)"
},
{
"id": "MDC",
"key": "MDC",
"value": "MDC (MDC)"
},
{
"id": "MDL",
"key": "MDL",
"value": "MDL (MDL)"
},
{
"id": "MGA",
"key": "MGA",
"value": "MGA (Ar)"
},
{
"id": "MGF",
"key": "MGF",
"value": "MGF (MGF)"
},
{
"id": "MKD",
"key": "MKD",
"value": "MKD (MKD)"
},
{
"id": "MKN",
"key": "MKN",
"value": "MKN (MKN)"
},
{
"id": "MLF",
"key": "MLF",
"value": "MLF (MLF)"
},
{
"id": "MMK",
"key": "MMK",
"value": "MMK (K)"
},
{
"id": "MNT",
"key": "MNT",
"value": "MNT (₮)"
},
{
"id": "MOP",
"key": "MOP",
"value": "MOP (MOP)"
},
{
"id": "MRO",
"key": "MRO",
"value": "MRO (MRO)"
},
{
"id": "MTL",
"key": "MTL",
"value": "MTL (MTL)"
},
{
"id": "MTP",
"key": "MTP",
"value": "MTP (MTP)"
},
{
"id": "MUR",
"key": "MUR",
"value": "MUR (₨)"
},
{
"id": "MVP",
"key": "MVP",
"value": "MVP (MVP)"
},
{
"id": "MVR",
"key": "MVR",
"value": "MVR (MVR)"
},
{
"id": "MWK",
"key": "MWK",
"value": "MWK (MWK)"
},
{
"id": "MXN",
"key": "MXN",
"value": "MXN ($)"
},
{
"id": "MXP",
"key": "MXP",
"value": "MXP (MXP)"
},
{
"id": "MXV",
"key": "MXV",
"value": "MXV (MXV)"
},
{
"id": "MYR",
"key": "MYR",
"value": "MYR (RM)"
},
{
"id": "MZE",
"key": "MZE",
"value": "MZE (MZE)"
},
{
"id": "MZM",
"key": "MZM",
"value": "MZM (MZM)"
},
{
"id": "MZN",
"key": "MZN",
"value": "MZN (MT)"
},
{
"id": "NAD",
"key": "NAD",
"value": "NAD ($)"
},
{
"id": "NGN",
"key": "NGN",
"value": "NGN (₦)"
},
{
"id": "NIC",
"key": "NIC",
"value": "NIC (NIC)"
},
{
"id": "NIO",
"key": "NIO",
"value": "NIO (C$)"
},
{
"id": "NLG",
"key": "NLG",
"value": "NLG (NLG)"
},
{
"id": "NOK",
"key": "NOK",
"value": "NOK (kr)"
},
{
"id": "NPR",
"key": "NPR",
"value": "NPR (₨)"
},
{
"id": "NZD",
"key": "NZD",
"value": "NZD ($)"
},
{
"id": "OMR",
"key": "OMR",
"value": "OMR (﷼)"
},
{
"id": "PAB",
"key": "PAB",
"value": "PAB (B/.)"
},
{
"id": "PEI",
"key": "PEI",
"value": "PEI (PEI)"
},
{
"id": "PEN",
"key": "PEN",
"value": "PEN (S/.)"
},
{
"id": "PES",
"key": "PES",
"value": "PES (PES)"
},
{
"id": "PGK",
"key": "PGK",
"value": "PGK (PGK)"
},
{
"id": "PHP",
"key": "PHP",
"value": "PHP (Php)"
},
{
"id": "PKR",
"key": "PKR",
"value": "PKR (₨)"
},
{
"id": "PLN",
"key": "PLN",
"value": "PLN (zł)"
},
{
"id": "PLZ",
"key": "PLZ",
"value": "PLZ (PLZ)"
},
{
"id": "PTE",
"key": "PTE",
"value": "PTE (PTE)"
},
{
"id": "PYG",
"key": "PYG",
"value": "PYG (Gs)"
},
{
"id": "QAR",
"key": "QAR",
"value": "QAR (﷼)"
},
{
"id": "RHD",
"key": "RHD",
"value": "RHD (RHD)"
},
{
"id": "ROL",
"key": "ROL",
"value": "ROL (ROL)"
},
{
"id": "RON",
"key": "RON",
"value": "RON (lei)"
},
{
"id": "RSD",
"key": "RSD",
"value": "RSD (Дин.)"
},
{
"id": "RUB",
"key": "RUB",
"value": "RUB (руб)"
},
{
"id": "RUR",
"key": "RUR",
"value": "RUR (р.)"
},
{
"id": "RWF",
"key": "RWF",
"value": "RWF (RF)"
},
{
"id": "SAR",
"key": "SAR",
"value": "SAR (﷼)"
},
{
"id": "SBD",
"key": "SBD",
"value": "SBD ($)"
},
{
"id": "SCR",
"key": "SCR",
"value": "SCR (₨)"
},
{
"id": "SDD",
"key": "SDD",
"value": "SDD (SDD)"
},
{
"id": "SDG",
"key": "SDG",
"value": "SDG (SDG)"
},
{
"id": "SDP",
"key": "SDP",
"value": "SDP (SDP)"
},
{
"id": "SEK",
"key": "SEK",
"value": "SEK (kr)"
},
{
"id": "SGD",
"key": "SGD",
"value": "SGD ($)"
},
{
"id": "SHP",
"key": "SHP",
"value": "SHP (£)"
},
{
"id": "SIT",
"key": "SIT",
"value": "SIT (SIT)"
},
{
"id": "SKK",
"key": "SKK",
"value": "SKK (SKK)"
},
{
"id": "SLL",
"key": "SLL",
"value": "SLL (SLL)"
},
{
"id": "SOS",
"key": "SOS",
"value": "SOS (S)"
},
{
"id": "SRD",
"key": "SRD",
"value": "SRD ($)"
},
{
"id": "SRG",
"key": "SRG",
"value": "SRG (SRG)"
},
{
"id": "SSP",
"key": "SSP",
"value": "SSP (£)"
},
{
"id": "STD",
"key": "STD",
"value": "STD (Db)"
},
{
"id": "SUR",
"key": "SUR",
"value": "SUR (SUR)"
},
{
"id": "SVC",
"key": "SVC",
"value": "SVC (SVC)"
},
{
"id": "SYP",
"key": "SYP",
"value": "SYP (£)"
},
{
"id": "SZL",
"key": "SZL",
"value": "SZL (SZL)"
},
{
"id": "THB",
"key": "THB",
"value": "THB (฿)"
},
{
"id": "TJR",
"key": "TJR",
"value": "TJR (TJR)"
},
{
"id": "TJS",
"key": "TJS",
"value": "TJS (TJS)"
},
{
"id": "TMM",
"key": "TMM",
"value": "TMM (TMM)"
},
{
"id": "TMT",
"key": "TMT",
"value": "TMT (TMT)"
},
{
"id": "TND",
"key": "TND",
"value": "TND (TND)"
},
{
"id": "TOP",
"key": "TOP",
"value": "TOP (T$)"
},
{
"id": "TPE",
"key": "TPE",
"value": "TPE (TPE)"
},
{
"id": "TRL",
"key": "TRL",
"value": "TRL (TRL)"
},
{
"id": "TRY",
"key": "TRY",
"value": "TRY (TL)"
},
{
"id": "TTD",
"key": "TTD",
"value": "TTD ($)"
},
{
"id": "TWD",
"key": "TWD",
"value": "TWD (NT$)"
},
{
"id": "TZS",
"key": "TZS",
"value": "TZS (TZS)"
},
{
"id": "UAH",
"key": "UAH",
"value": "UAH (₴)"
},
{
"id": "UAK",
"key": "UAK",
"value": "UAK (UAK)"
},
{
"id": "UGS",
"key": "UGS",
"value": "UGS (UGS)"
},
{
"id": "UGX",
"key": "UGX",
"value": "UGX (UGX)"
},
{
"id": "USD",
"key": "USD",
"value": "USD ($)"
},
{
"id": "USN",
"key": "USN",
"value": "USN (USN)"
},
{
"id": "USS",
"key": "USS",
"value": "USS (USS)"
},
{
"id": "UYI",
"key": "UYI",
"value": "UYI (UYI)"
},
{
"id": "UYP",
"key": "UYP",
"value": "UYP (UYP)"
},
{
"id": "UYU",
"key": "UYU",
"value": "UYU ($U)"
},
{
"id": "UZS",
"key": "UZS",
"value": "UZS (лв)"
},
{
"id": "VEB",
"key": "VEB",
"value": "VEB (VEB)"
},
{
"id": "VEF",
"key": "VEF",
"value": "VEF (Bs)"
},
{
"id": "VND",
"key": "VND",
"value": "VND (₫)"
},
{
"id": "VNN",
"key": "VNN",
"value": "VNN (VNN)"
},
{
"id": "VUV",
"key": "VUV",
"value": "VUV (VUV)"
},
{
"id": "WST",
"key": "WST",
"value": "WST (WST)"
},
{
"id": "XAF",
"key": "XAF",
"value": "XAF (FCFA)"
},
{
"id": "XAG",
"key": "XAG",
"value": "XAG (XAG)"
},
{
"id": "XAU",
"key": "XAU",
"value": "XAU (XAU)"
},
{
"id": "XBA",
"key": "XBA",
"value": "XBA (XBA)"
},
{
"id": "XBB",
"key": "XBB",
"value": "XBB (XBB)"
},
{
"id": "XBC",
"key": "XBC",
"value": "XBC (XBC)"
},
{
"id": "XBD",
"key": "XBD",
"value": "XBD (XBD)"
},
{
"id": "XCD",
"key": "XCD",
"value": "XCD ($)"
},
{
"id": "XDR",
"key": "XDR",
"value": "XDR (XDR)"
},
{
"id": "XEU",
"key": "XEU",
"value": "XEU (XEU)"
},
{
"id": "XFO",
"key": "XFO",
"value": "XFO (XFO)"
},
{
"id": "XFU",
"key": "XFU",
"value": "XFU (XFU)"
},
{
"id": "XOF",
"key": "XOF",
"value": "XOF (CFA)"
},
{
"id": "XPD",
"key": "XPD",
"value": "XPD (XPD)"
},
{
"id": "XPF",
"key": "XPF",
"value": "XPF (CFPF)"
},
{
"id": "XPT",
"key": "XPT",
"value": "XPT (XPT)"
},
{
"id": "XRE",
"key": "XRE",
"value": "XRE (XRE)"
},
{
"id": "XSU",
"key": "XSU",
"value": "XSU (XSU)"
},
{
"id": "XTS",
"key": "XTS",
"value": "XTS (XTS)"
},
{
"id": "XUA",
"key": "XUA",
"value": "XUA (XUA)"
},
{
"id": "XXX",
"key": "XXX",
"value": "XXX (XXX)"
},
{
"id": "YDD",
"key": "YDD",
"value": "YDD (YDD)"
},
{
"id": "YER",
"key": "YER",
"value": "YER (﷼)"
},
{
"id": "YUD",
"key": "YUD",
"value": "YUD (YUD)"
},
{
"id": "YUM",
"key": "YUM",
"value": "YUM (YUM)"
},
{
"id": "YUN",
"key": "YUN",
"value": "YUN (YUN)"
},
{
"id": "YUR",
"key": "YUR",
"value": "YUR (YUR)"
},
{
"id": "ZAL",
"key": "ZAL",
"value": "ZAL (ZAL)"
},
{
"id": "ZAR",
"key": "ZAR",
"value": "ZAR (R)"
},
{
"id": "ZMK",
"key": "ZMK",
"value": "ZMK (ZMK)"
},
{
"id": "ZMW",
"key": "ZMW",
"value": "ZMW (ZK)"
},
{
"id": "ZRN",
"key": "ZRN",
"value": "ZRN (ZRN)"
},
{
"id": "ZRZ",
"key": "ZRZ",
"value": "ZRZ (ZRZ)"
},
{
"id": "ZWD",
"key": "ZWD",
"value": "ZWD (Z$)"
},
{
"id": "ZWL",
"key": "ZWL",
"value": "ZWL (ZWL)"
},
{
"id": "ZWR",
"key": "ZWR",
"value": "ZWR (ZWR)"
}
],
"pledge_frequency": [
{
"id": "Weekly",
"key": "0.23076923076923",
"value": "Weekly"
},
{
"id": "Every 2 Weeks",
"key": "0.46153846153846",
"value": "Every 2 Weeks"
},
{
"id": "Monthly",
"key": "1.0",
"value": "Monthly"
},
{
"id": "Every 2 Months",
"key": "2.0",
"value": "Every 2 Months"
},
{
"id": "Quarterly",
"key": "3.0",
"value": "Quarterly"
},
{
"id": "Every 4 Months",
"key": "4.0",
"value": "Every 4 Months"
},
{
"id": "Every 6 Months",
"key": "6.0",
"value": "Every 6 Months"
},
{
"id": "Annual",
"key": "12.0",
"value": "Annual"
},
{
"id": "Every 2 Years",
"key": "24.0",
"value": "Every 2 Years"
}
],
"likely_to_give": [
{
"id": "Least Likely",
"value": "Least Likely"
},
{
"id": "Likely",
"value": "Likely"
},
{
"id": "Most Likely",
"value": "Most Likely"
}
],
"newsletter": [
{
"id": "Physical",
"value": "Physical"
},
{
"id": "Email",
"value": "Email"
},
{
"id": "Both",
"value": "Both"
},
{
"id": "None",
"value": "None"
}
],
"send_appeals": [
{
"id": true,
"value": "Yes"
},
{
"id": false,
"value": "No"
}
],
"status": [
{
"id": "Never Contacted",
"value": "Never Contacted"
},
{
"id": "Ask in Future",
"value": "Ask in Future"
},
{
"id": "Cultivate Relationship",
"value": "Cultivate Relationship"
},
{
"id": "Contact for Appointment",
"value": "Contact for Appointment"
},
{
"id": "Appointment Scheduled",
"value": "Appointment Scheduled"
},
{
"id": "Call for Decision",
"value": "Call for Decision"
},
{
"id": "Partner - Financial",
"value": "Partner - Financial"
},
{
"id": "Partner - Special",
"value": "Partner - Special"
},
{
"id": "Partner - Pray",
"value": "Partner - Pray"
},
{
"id": "Not Interested",
"value": "Not Interested"
},
{
"id": "Unresponsive",
"value": "Unresponsive"
},
{
"id": "Never Ask",
"value": "Never Ask"
},
{
"id": "Research Abandoned",
"value": "Research Abandoned"
},
{
"id": "Expired Referral",
"value": "Expired Referral"
}
]
},
"max_file_size_in_bytes": 500000000,
"required_headers": {
},
"supported_headers": {
"church": "Church",
"city": "City",
"pledge_amount": "Commitment Amount",
"pledge_currency": "Commitment Currency",
"pledge_frequency": "Commitment Frequency",
"country": "Country",
"email_1": "Email 1",
"email_2": "Email 2",
"envelope_greeting": "Envelope Greeting",
"first_name": "First Name",
"full_name": "Full Name",
"greeting": "Greeting",
"last_name": "Last Name",
"likely_to_give": "Likely To Give",
"metro_area": "Metro Area",
"newsletter": "Newsletter",
"notes": "Notes",
"phone_1": "Phone 1",
"phone_2": "Phone 2",
"phone_3": "Phone 3",
"referred_by": "Referred By",
"region": "Region",
"send_appeals": "Send Appeals?",
"spouse_email": "Spouse Email",
"spouse_first_name": "Spouse First Name",
"spouse_last_name": "Spouse Last Name",
"spouse_phone": "Spouse Phone",
"state": "State",
"status": "Status",
"street": "Street",
"tags": "Tags",
"website": "Website",
"zip": "Zip"
}
},
"sources": {
"addresses": [
"DataServer",
"GoogleContactSync",
"GoogleImport",
"MPDX",
"Siebel",
"TntImport"
],
"email_addresses": [
"MPDX"
],
"phone_numbers": [
"MPDX"
]
},
"tnt_import": {
"max_file_size_in_bytes": 500000000
},
"bulk_update_options": {
"likely_to_give": [
"Least Likely",
"Likely",
"Most Likely"
],
"send_newsletter": [
"Physical",
"Email",
"Both",
"None"
],
"pledge_currency": {
"aed": {
"code": "AED",
"code_symbol_string": "AED (AED)",
"name": "UAE dirham",
"symbol": "AED"
},
"afn": {
"code": "AFN",
"code_symbol_string": "AFN (؋)",
"name": "Afghan Afghani",
"symbol": "؋"
},
"alk": {
"code": "ALK",
"code_symbol_string": "ALK (ALK)",
"name": "Albanian lek (1946–1965)",
"symbol": "ALK"
},
"all": {
"code": "ALL",
"code_symbol_string": "ALL (LEK)",
"name": "Albanian lek",
"symbol": "LEK"
},
"amd": {
"code": "AMD",
"code_symbol_string": "AMD (AMD)",
"name": "Armenian dram",
"symbol": "AMD"
},
"ang": {
"code": "ANG",
"code_symbol_string": "ANG (ƒ)",
"name": "Netherlands Antillean guilder",
"symbol": "ƒ"
},
"aoa": {
"code": "AOA",
"code_symbol_string": "AOA (Kz)",
"name": "Angolan kwanza",
"symbol": "Kz"
},
"aok": {
"code": "AOK",
"code_symbol_string": "AOK (AOK)",
"name": "Angolan kwanza (1977–1991)",
"symbol": "AOK"
},
"aon": {
"code": "AON",
"code_symbol_string": "AON (AON)",
"name": "Angolan new kwanza (1990–2000)",
"symbol": "AON"
},
"aor": {
"code": "AOR",
"code_symbol_string": "AOR (AOR)",
"name": "Angolan readjusted kwanza (1995–1999)",
"symbol": "AOR"
},
"ara": {
"code": "ARA",
"code_symbol_string": "ARA (ARA)",
"name": "Argentine austral",
"symbol": "ARA"
},
"arl": {
"code": "ARL",
"code_symbol_string": "ARL (ARL)",
"name": "Argentine peso ley (1970–1983)",
"symbol": "ARL"
},
"arm": {
"code": "ARM",
"code_symbol_string": "ARM (ARM)",
"name": "Argentine peso (1881–1970)",
"symbol": "ARM"
},
"arp": {
"code": "ARP",
"code_symbol_string": "ARP (ARP)",
"name": "Argentine peso (1983–1985)",
"symbol": "ARP"
},
"ars": {
"code": "ARS",
"code_symbol_string": "ARS ($)",
"name": "Argentine peso",
"symbol": "$"
},
"ats": {
"code": "ATS",
"code_symbol_string": "ATS (ATS)",
"name": "Austrian schilling",
"symbol": "ATS"
},
"aud": {
"code": "AUD",
"code_symbol_string": "AUD ($)",
"name": "Australian dollar",
"symbol": "$"
},
"awg": {
"code": "AWG",
"code_symbol_string": "AWG (ƒ)",
"name": "Aruban florin",
"symbol": "ƒ"
},
"azm": {
"code": "AZM",
"code_symbol_string": "AZM (AZM)",
"name": "Azerbaijani manat (1993–2006)",
"symbol": "AZM"
},
"azn": {
"code": "AZN",
"code_symbol_string": "AZN (ман)",
"name": "Azerbaijani manat",
"symbol": "ман"
},
"bad": {
"code": "BAD",
"code_symbol_string": "BAD (BAD)",
"name": "Bosnia-Herzegovina dinar (1992–1994)",
"symbol": "BAD"
},
"bam": {
"code": "BAM",
"code_symbol_string": "BAM (KM)",
"name": "Bosnia-Herzegovina convertible mark",
"symbol": "KM"
},
"ban": {
"code": "BAN",
"code_symbol_string": "BAN (BAN)",
"name": "Bosnia-Herzegovina new dinar (1994–1997)",
"symbol": "BAN"
},
"bbd": {
"code": "BBD",
"code_symbol_string": "BBD ($)",
"name": "Barbadian dollar",
"symbol": "$"
},
"bdt": {
"code": "BDT",
"code_symbol_string": "BDT (৳)",
"name": "Bangladeshi taka",
"symbol": "৳"
},
"bec": {
"code": "BEC",
"code_symbol_string": "BEC (BEC)",
"name": "Belgian franc (convertible)",
"symbol": "BEC"
},
"bef": {
"code": "BEF",
"code_symbol_string": "BEF (BEF)",
"name": "Belgian franc",
"symbol": "BEF"
},
"bel": {
"code": "BEL",
"code_symbol_string": "BEL (BEL)",
"name": "Belgian franc (financial)",
"symbol": "BEL"
},
"bgl": {
"code": "BGL",
"code_symbol_string": "BGL (BGL)",
"name": "Bulgarian hard lev",
"symbol": "BGL"
},
"bgm": {
"code": "BGM",
"code_symbol_string": "BGM (BGM)",
"name": "Bulgarian socialist lev",
"symbol": "BGM"
},
"bgn": {
"code": "BGN",
"code_symbol_string": "BGN (лв)",
"name": "Bulgarian lev",
"symbol": "лв"
},
"bgo": {
"code": "BGO",
"code_symbol_string": "BGO (BGO)",
"name": "Bulgarian lev (1879–1952)",
"symbol": "BGO"
},
"bhd": {
"code": "BHD",
"code_symbol_string": "BHD (BHD)",
"name": "Bahraini dinar",
"symbol": "BHD"
},
"bif": {
"code": "BIF",
"code_symbol_string": "BIF (BIF)",
"name": "Burundian franc",
"symbol": "BIF"
},
"bmd": {
"code": "BMD",
"code_symbol_string": "BMD ($)",
"name": "Bermudan dollar",
"symbol": "$"
},
"bnd": {
"code": "BND",
"code_symbol_string": "BND ($)",
"name": "Brunei dollar",
"symbol": "$"
},
"bob": {
"code": "BOB",
"code_symbol_string": "BOB ($b)",
"name": "Bolivian boliviano",
"symbol": "$b"
},
"bol": {
"code": "BOL",
"code_symbol_string": "BOL (BOL)",
"name": "Bolivian boliviano (1863–1963)",
"symbol": "BOL"
},
"bop": {
"code": "BOP",
"code_symbol_string": "BOP (BOP)",
"name": "Bolivian peso",
"symbol": "BOP"
},
"bov": {
"code": "BOV",
"code_symbol_string": "BOV (BOV)",
"name": "Bolivian mvdol",
"symbol": "BOV"
},
"brb": {
"code": "BRB",
"code_symbol_string": "BRB (BRB)",
"name": "Brazilian new cruzeiro (1967–1986)",
"symbol": "BRB"
},
"brc": {
"code": "BRC",
"code_symbol_string": "BRC (BRC)",
"name": "Brazilian cruzado (1986–1989)",
"symbol": "BRC"
},
"bre": {
"code": "BRE",
"code_symbol_string": "BRE (BRE)",
"name": "Brazilian cruzeiro (1990–1993)",
"symbol": "BRE"
},
"brl": {
"code": "BRL",
"code_symbol_string": "BRL (R$)",
"name": "Brazilian real",
"symbol": "R$"
},
"brn": {
"code": "BRN",
"code_symbol_string": "BRN (BRN)",
"name": "Brazilian new cruzado (1989–1990)",
"symbol": "BRN"
},
"brr": {
"code": "BRR",
"code_symbol_string": "BRR (BRR)",
"name": "Brazilian cruzeiro (1993–1994)",
"symbol": "BRR"
},
"brz": {
"code": "BRZ",
"code_symbol_string": "BRZ (BRZ)",
"name": "Brazilian cruzeiro (1942–1967)",
"symbol": "BRZ"
},
"bsd": {
"code": "BSD",
"code_symbol_string": "BSD ($)",
"name": "Bahamian dollar",
"symbol": "$"
},
"btn": {
"code": "BTN",
"code_symbol_string": "BTN (BTN)",
"name": "Bhutanese ngultrum",
"symbol": "BTN"
},
"buk": {
"code": "BUK",
"code_symbol_string": "BUK (BUK)",
"name": "Burmese kyat",
"symbol": "BUK"
},
"bwp": {
"code": "BWP",
"code_symbol_string": "BWP (P)",
"name": "Botswanan pula",
"symbol": "P"
},
"byb": {
"code": "BYB",
"code_symbol_string": "BYB (BYB)",
"name": "Belarusian new ruble (1994–1999)",
"symbol": "BYB"
},
"byr": {
"code": "BYR",
"code_symbol_string": "BYR (p.)",
"name": "Belarusian ruble",
"symbol": "p."
},
"bzd": {
"code": "BZD",
"code_symbol_string": "BZD (BZ$)",
"name": "Belize dollar",
"symbol": "BZ$"
},
"cad": {
"code": "CAD",
"code_symbol_string": "CAD ($)",
"name": "Canadian dollar",
"symbol": "$"
},
"cdf": {
"code": "CDF",
"code_symbol_string": "CDF (CDF)",
"name": "Congolese franc",
"symbol": "CDF"
},
"che": {
"code": "CHE",
"code_symbol_string": "CHE (CHE)",
"name": "WIR euro",
"symbol": "CHE"
},
"chf": {
"code": "CHF",
"code_symbol_string": "CHF (CHF)",
"name": "Swiss franc",
"symbol": "CHF"
},
"chw": {
"code": "CHW",
"code_symbol_string": "CHW (CHW)",
"name": "WIR franc",
"symbol": "CHW"
},
"cle": {
"code": "CLE",
"code_symbol_string": "CLE (CLE)",
"name": "Chilean escudo",
"symbol": "CLE"
},
"clf": {
"code": "CLF",
"code_symbol_string": "CLF (CLF)",
"name": "Chilean unit of account (UF)",
"symbol": "CLF"
},
"clp": {
"code": "CLP",
"code_symbol_string": "CLP ($)",
"name": "Chilean peso",
"symbol": "$"
},
"cnx": {
"code": "CNX",
"code_symbol_string": "CNX (CNX)",
"name": "Chinese People’s Bank dollar",
"symbol": "CNX"
},
"cny": {
"code": "CNY",
"code_symbol_string": "CNY (¥)",
"name": "Chinese yuan",
"symbol": "¥"
},
"cop": {
"code": "COP",
"code_symbol_string": "COP ($)",
"name": "Colombian peso",
"symbol": "$"
},
"cou": {
"code": "COU",
"code_symbol_string": "COU (COU)",
"name": "Colombian real value unit",
"symbol": "COU"
},
"crc": {
"code": "CRC",
"code_symbol_string": "CRC (₡)",
"name": "Costa Rican colón",
"symbol": "₡"
},
"csd": {
"code": "CSD",
"code_symbol_string": "CSD (CSD)",
"name": "Serbian dinar (2002–2006)",
"symbol": "CSD"
},
"csk": {
"code": "CSK",
"code_symbol_string": "CSK (CSK)",
"name": "Czechoslovak hard koruna",
"symbol": "CSK"
},
"cuc": {
"code": "CUC",
"code_symbol_string": "CUC ($)",
"name": "Cuban convertible peso",
"symbol": "$"
},
"cup": {
"code": "CUP",
"code_symbol_string": "CUP (₱)",
"name": "Cuban peso",
"symbol": "₱"
},
"cve": {
"code": "CVE",
"code_symbol_string": "CVE (CVE)",
"name": "Cape Verdean escudo",
"symbol": "CVE"
},
"cyp": {
"code": "CYP",
"code_symbol_string": "CYP (CYP)",
"name": "Cypriot pound",
"symbol": "CYP"
},
"czk": {
"code": "CZK",
"code_symbol_string": "CZK (Kč)",
"name": "Czech Republic koruna",
"symbol": "Kč"
},
"ddm": {
"code": "DDM",
"code_symbol_string": "DDM (DDM)",
"name": "East German mark",
"symbol": "DDM"
},
"dem": {
"code": "DEM",
"code_symbol_string": "DEM (DEM)",
"name": "German mark",
"symbol": "DEM"
},
"djf": {
"code": "DJF",
"code_symbol_string": "DJF (DJF)",
"name": "Djiboutian franc",
"symbol": "DJF"
},
"dkk": {
"code": "DKK",
"code_symbol_string": "DKK (kr)",
"name": "Danish krone",
"symbol": "kr"
},
"dop": {
"code": "DOP",
"code_symbol_string": "DOP (RD$)",
"name": "Dominican peso",
"symbol": "RD$"
},
"dzd": {
"code": "DZD",
"code_symbol_string": "DZD (DZD)",
"name": "Algerian dinar",
"symbol": "DZD"
},
"ecs": {
"code": "ECS",
"code_symbol_string": "ECS (ECS)",
"name": "Ecuadorian sucre",
"symbol": "ECS"
},
"ecv": {
"code": "ECV",
"code_symbol_string": "ECV (ECV)",
"name": "Ecuadorian unit of constant value",
"symbol": "ECV"
},
"eek": {
"code": "EEK",
"code_symbol_string": "EEK (kr)",
"name": "Estonian kroon",
"symbol": "kr"
},
"egp": {
"code": "EGP",
"code_symbol_string": "EGP (£)",
"name": "Egyptian pound",
"symbol": "£"
},
"ern": {
"code": "ERN",
"code_symbol_string": "ERN (ERN)",
"name": "Eritrean nakfa",
"symbol": "ERN"
},
"esa": {
"code": "ESA",
"code_symbol_string": "ESA (ESA)",
"name": "Spanish peseta (A account)",
"symbol": "ESA"
},
"esb": {
"code": "ESB",
"code_symbol_string": "ESB (ESB)",
"name": "Spanish peseta (convertible account)",
"symbol": "ESB"
},
"esp": {
"code": "ESP",
"code_symbol_string": "ESP (₧)",
"name": "Spanish peseta",
"symbol": "₧"
},
"etb": {
"code": "ETB",
"code_symbol_string": "ETB (ETB)",
"name": "Ethiopian birr",
"symbol": "ETB"
},
"eur": {
"code": "EUR",
"code_symbol_string": "EUR (€)",
"name": "euro",
"symbol": "€"
},
"fim": {
"code": "FIM",
"code_symbol_string": "FIM (FIM)",
"name": "Finnish markka",
"symbol": "FIM"
},
"fjd": {
"code": "FJD",
"code_symbol_string": "FJD ($)",
"name": "Fijian dollar",
"symbol": "$"
},
"fkp": {
"code": "FKP",
"code_symbol_string": "FKP (£)",
"name": "Falkland Islands pound",
"symbol": "£"
},
"frf": {
"code": "FRF",
"code_symbol_string": "FRF (FRF)",
"name": "French franc",
"symbol": "FRF"
},
"gbp": {
"code": "GBP",
"code_symbol_string": "GBP (£)",
"name": "British pound",
"symbol": "£"
},
"gek": {
"code": "GEK",
"code_symbol_string": "GEK (GEK)",
"name": "Georgian kupon larit",
"symbol": "GEK"
},
"gel": {
"code": "GEL",
"code_symbol_string": "GEL (₾)",
"name": "Georgian lari",
"symbol": "₾"
},
"ghc": {
"code": "GHC",
"code_symbol_string": "GHC (GHC)",
"name": "Ghanaian cedi (1979–2007)",
"symbol": "GHC"
},
"ghs": {
"code": "GHS",
"code_symbol_string": "GHS (¢)",
"name": "Ghanaian cedi",
"symbol": "¢"
},
"gip": {
"code": "GIP",
"code_symbol_string": "GIP (£)",
"name": "Gibraltar pound",
"symbol": "£"
},
"gmd": {
"code": "GMD",
"code_symbol_string": "GMD (GMD)",
"name": "Gambian dalasi",
"symbol": "GMD"
},
"gnf": {
"code": "GNF",
"code_symbol_string": "GNF (FG)",
"name": "Guinean franc",
"symbol": "FG"
},
"gns": {
"code": "GNS",
"code_symbol_string": "GNS (GNS)",
"name": "Guinean syli",
"symbol": "GNS"
},
"gqe": {
"code": "GQE",
"code_symbol_string": "GQE (GQE)",
"name": "Equatorial Guinean ekwele",
"symbol": "GQE"
},
"grd": {
"code": "GRD",
"code_symbol_string": "GRD (GRD)",
"name": "Greek drachma",
"symbol": "GRD"
},
"gtq": {
"code": "GTQ",
"code_symbol_string": "GTQ (Q)",
"name": "Guatemalan quetzal",
"symbol": "Q"
},
"gwe": {
"code": "GWE",
"code_symbol_string": "GWE (GWE)",
"name": "Portuguese Guinea escudo",
"symbol": "GWE"
},
"gwp": {
"code": "GWP",
"code_symbol_string": "GWP (GWP)",
"name": "Guinea-Bissau peso",
"symbol": "GWP"
},
"gyd": {
"code": "GYD",
"code_symbol_string": "GYD ($)",
"name": "Guyanaese dollar",
"symbol": "$"
},
"hkd": {
"code": "HKD",
"code_symbol_string": "HKD ($)",
"name": "Hong Kong dollar",
"symbol": "$"
},
"hnl": {
"code": "HNL",
"code_symbol_string": "HNL (L)",
"name": "Honduran lempira",
"symbol": "L"
},
"hrd": {
"code": "HRD",
"code_symbol_string": "HRD (HRD)",
"name": "Croatian dinar",
"symbol": "HRD"
},
"hrk": {
"code": "HRK",
"code_symbol_string": "HRK (kn)",
"name": "Croatian kuna",
"symbol": "kn"
},
"htg": {
"code": "HTG",
"code_symbol_string": "HTG (HTG)",
"name": "Haitian gourde",
"symbol": "HTG"
},
"huf": {
"code": "HUF",
"code_symbol_string": "HUF (Ft)",
"name": "Hungarian forint",
"symbol": "Ft"
},
"idr": {
"code": "IDR",
"code_symbol_string": "IDR (Rp)",
"name": "Indonesian rupiah",
"symbol": "Rp"
},
"iep": {
"code": "IEP",
"code_symbol_string": "IEP (IEP)",
"name": "Irish pound",
"symbol": "IEP"
},
"ilp": {
"code": "ILP",
"code_symbol_string": "ILP (ILP)",
"name": "Israeli pound",
"symbol": "ILP"
},
"ilr": {
"code": "ILR",
"code_symbol_string": "ILR (ILR)",
"name": "Israeli sheqel (1980–1985)",
"symbol": "ILR"
},
"ils": {
"code": "ILS",
"code_symbol_string": "ILS (₪)",
"name": "Israeli new sheqel",
"symbol": "₪"
},
"inr": {
"code": "INR",
"code_symbol_string": "INR (₨)",
"name": "Indian rupee",
"symbol": "₨"
},
"iqd": {
"code": "IQD",
"code_symbol_string": "IQD (IQD)",
"name": "Iraqi dinar",
"symbol": "IQD"
},
"irr": {
"code": "IRR",
"code_symbol_string": "IRR (﷼)",
"name": "Iranian rial",
"symbol": "﷼"
},
"isj": {
"code": "ISJ",
"code_symbol_string": "ISJ (ISJ)",
"name": "Icelandic króna (1918–1981)",
"symbol": "ISJ"
},
"isk": {
"code": "ISK",
"code_symbol_string": "ISK (kr)",
"name": "Icelandic króna",
"symbol": "kr"
},
"itl": {
"code": "ITL",
"code_symbol_string": "ITL (ITL)",
"name": "Italian lira",
"symbol": "ITL"
},
"jmd": {
"code": "JMD",
"code_symbol_string": "JMD ($)",
"name": "Jamaican dollar",
"symbol": "$"
},
"jod": {
"code": "JOD",
"code_symbol_string": "JOD (JOD)",
"name": "Jordanian dinar",
"symbol": "JOD"
},
"jpy": {
"code": "JPY",
"code_symbol_string": "JPY (¥)",
"name": "Japanese yen",
"symbol": "¥"
},
"kes": {
"code": "KES",
"code_symbol_string": "KES (KES)",
"name": "Kenyan shilling",
"symbol": "KES"
},
"kgs": {
"code": "KGS",
"code_symbol_string": "KGS (лв)",
"name": "Kyrgystani som",
"symbol": "лв"
},
"khr": {
"code": "KHR",
"code_symbol_string": "KHR (៛)",
"name": "Cambodian riel",
"symbol": "៛"
},
"kmf": {
"code": "KMF",
"code_symbol_string": "KMF (CF)",
"name": "Comorian franc",
"symbol": "CF"
},
"kpw": {
"code": "KPW",
"code_symbol_string": "KPW (₩)",
"name": "North Korean won",
"symbol": "₩"
},
"krh": {
"code": "KRH",
"code_symbol_string": "KRH (KRH)",
"name": "South Korean hwan (1953–1962)",
"symbol": "KRH"
},
"kro": {
"code": "KRO",
"code_symbol_string": "KRO (KRO)",
"name": "South Korean won (1945–1953)",
"symbol": "KRO"
},
"krw": {
"code": "KRW",
"code_symbol_string": "KRW (₩)",
"name": "South Korean won",
"symbol": "₩"
},
"kwd": {
"code": "KWD",
"code_symbol_string": "KWD (KWD)",
"name": "Kuwaiti dinar",
"symbol": "KWD"
},
"kyd": {
"code": "KYD",
"code_symbol_string": "KYD ($)",
"name": "Cayman Islands dollar",
"symbol": "$"
},
"kzt": {
"code": "KZT",
"code_symbol_string": "KZT (лв)",
"name": "Kazakhstani tenge",
"symbol": "лв"
},
"lak": {
"code": "LAK",
"code_symbol_string": "LAK (₭)",
"name": "Laotian kip",
"symbol": "₭"
},
"lbp": {
"code": "LBP",
"code_symbol_string": "LBP (£)",
"name": "Lebanese pound",
"symbol": "£"
},
"lkr": {
"code": "LKR",
"code_symbol_string": "LKR (₨)",
"name": "Sri Lankan rupee",
"symbol": "₨"
},
"lrd": {
"code": "LRD",
"code_symbol_string": "LRD ($)",
"name": "Liberian dollar",
"symbol": "$"
},
"lsl": {
"code": "LSL",
"code_symbol_string": "LSL (LSL)",
"name": "Lesotho loti",
"symbol": "LSL"
},
"ltl": {
"code": "LTL",
"code_symbol_string": "LTL (Lt)",
"name": "Lithuanian litas",
"symbol": "Lt"
},
"ltt": {
"code": "LTT",
"code_symbol_string": "LTT (LTT)",
"name": "Lithuanian talonas",
"symbol": "LTT"
},
"luc": {
"code": "LUC",
"code_symbol_string": "LUC (LUC)",
"name": "Luxembourgian convertible franc",
"symbol": "LUC"
},
"luf": {
"code": "LUF",
"code_symbol_string": "LUF (LUF)",
"name": "Luxembourgian franc",
"symbol": "LUF"
},
"lul": {
"code": "LUL",
"code_symbol_string": "LUL (LUL)",
"name": "Luxembourg financial franc",
"symbol": "LUL"
},
"lvl": {
"code": "LVL",
"code_symbol_string": "LVL (Ls)",
"name": "Latvian lats",
"symbol": "Ls"
},
"lvr": {
"code": "LVR",
"code_symbol_string": "LVR (LVR)",
"name": "Latvian ruble",
"symbol": "LVR"
},
"lyd": {
"code": "LYD",
"code_symbol_string": "LYD (LYD)",
"name": "Libyan dinar",
"symbol": "LYD"
},
"mad": {
"code": "MAD",
"code_symbol_string": "MAD (MAD)",
"name": "Moroccan dirham",
"symbol": "MAD"
},
"maf": {
"code": "MAF",
"code_symbol_string": "MAF (MAF)",
"name": "Moroccan franc",
"symbol": "MAF"
},
"mcf": {
"code": "MCF",
"code_symbol_string": "MCF (MCF)",
"name": "Monegasque franc",
"symbol": "MCF"
},
"mdc": {
"code": "MDC",
"code_symbol_string": "MDC (MDC)",
"name": "Moldovan cupon",
"symbol": "MDC"
},
"mdl": {
"code": "MDL",
"code_symbol_string": "MDL (MDL)",
"name": "Moldovan leu",
"symbol": "MDL"
},
"mga": {
"code": "MGA",
"code_symbol_string": "MGA (Ar)",
"name": "Malagasy ariary",
"symbol": "Ar"
},
"mgf": {
"code": "MGF",
"code_symbol_string": "MGF (MGF)",
"name": "Malagasy franc",
"symbol": "MGF"
},
"mkd": {
"code": "MKD",
"code_symbol_string": "MKD (MKD)",
"name": "Macedonian denar",
"symbol": "MKD"
},
"mkn": {
"code": "MKN",
"code_symbol_string": "MKN (MKN)",
"name": "Macedonian denar (1992–1993)",
"symbol": "MKN"
},
"mlf": {
"code": "MLF",
"code_symbol_string": "MLF (MLF)",
"name": "Malian franc",
"symbol": "MLF"
},
"mmk": {
"code": "MMK",
"code_symbol_string": "MMK (K)",
"name": "Myanmar kyat",
"symbol": "K"
},
"mnt": {
"code": "MNT",
"code_symbol_string": "MNT (₮)",
"name": "Mongolian tugrik",
"symbol": "₮"
},
"mop": {
"code": "MOP",
"code_symbol_string": "MOP (MOP)",
"name": "Macanese pataca",
"symbol": "MOP"
},
"mro": {
"code": "MRO",
"code_symbol_string": "MRO (MRO)",
"name": "Mauritanian ouguiya",
"symbol": "MRO"
},
"mtl": {
"code": "MTL",
"code_symbol_string": "MTL (MTL)",
"name": "Maltese lira",
"symbol": "MTL"
},
"mtp": {
"code": "MTP",
"code_symbol_string": "MTP (MTP)",
"name": "Maltese pound",
"symbol": "MTP"
},
"mur": {
"code": "MUR",
"code_symbol_string": "MUR (₨)",
"name": "Mauritian rupee",
"symbol": "₨"
},
"mvp": {
"code": "MVP",
"code_symbol_string": "MVP (MVP)",
"name": "Maldivian rupee (1947–1981)",
"symbol": "MVP"
},
"mvr": {
"code": "MVR",
"code_symbol_string": "MVR (MVR)",
"name": "Maldivian rufiyaa",
"symbol": "MVR"
},
"mwk": {
"code": "MWK",
"code_symbol_string": "MWK (MWK)",
"name": "Malawian kwacha",
"symbol": "MWK"
},
"mxn": {
"code": "MXN",
"code_symbol_string": "MXN ($)",
"name": "Mexican peso",
"symbol": "$"
},
"mxp": {
"code": "MXP",
"code_symbol_string": "MXP (MXP)",
"name": "Mexican silver peso (1861–1992)",
"symbol": "MXP"
},
"mxv": {
"code": "MXV",
"code_symbol_string": "MXV (MXV)",
"name": "Mexican investment unit",
"symbol": "MXV"
},
"myr": {
"code": "MYR",
"code_symbol_string": "MYR (RM)",
"name": "Malaysian ringgit",
"symbol": "RM"
},
"mze": {
"code": "MZE",
"code_symbol_string": "MZE (MZE)",
"name": "Mozambican escudo",
"symbol": "MZE"
},
"mzm": {
"code": "MZM",
"code_symbol_string": "MZM (MZM)",
"name": "Mozambican metical (1980–2006)",
"symbol": "MZM"
},
"mzn": {
"code": "MZN",
"code_symbol_string": "MZN (MT)",
"name": "Mozambican metical",
"symbol": "MT"
},
"nad": {
"code": "NAD",
"code_symbol_string": "NAD ($)",
"name": "Namibian dollar",
"symbol": "$"
},
"ngn": {
"code": "NGN",
"code_symbol_string": "NGN (₦)",
"name": "Nigerian naira",
"symbol": "₦"
},
"nic": {
"code": "NIC",
"code_symbol_string": "NIC (NIC)",
"name": "Nicaraguan córdoba (1988–1991)",
"symbol": "NIC"
},
"nio": {
"code": "NIO",
"code_symbol_string": "NIO (C$)",
"name": "Nicaraguan córdoba",
"symbol": "C$"
},
"nlg": {
"code": "NLG",
"code_symbol_string": "NLG (NLG)",
"name": "Dutch guilder",
"symbol": "NLG"
},
"nok": {
"code": "NOK",
"code_symbol_string": "NOK (kr)",
"name": "Norwegian krone",
"symbol": "kr"
},
"npr": {
"code": "NPR",
"code_symbol_string": "NPR (₨)",
"name": "Nepalese rupee",
"symbol": "₨"
},
"nzd": {
"code": "NZD",
"code_symbol_string": "NZD ($)",
"name": "New Zealand dollar",
"symbol": "$"
},
"omr": {
"code": "OMR",
"code_symbol_string": "OMR (﷼)",
"name": "Omani rial",
"symbol": "﷼"
},
"pab": {
"code": "PAB",
"code_symbol_string": "PAB (B/.)",
"name": "Panamanian balboa",
"symbol": "B/."
},
"pei": {
"code": "PEI",
"code_symbol_string": "PEI (PEI)",
"name": "Peruvian inti",
"symbol": "PEI"
},
"pen": {
"code": "PEN",
"code_symbol_string": "PEN (S/.)",
"name": "Peruvian nuevo sol",
"symbol": "S/."
},
"pes": {
"code": "PES",
"code_symbol_string": "PES (PES)",
"name": "Peruvian sol (1863–1965)",
"symbol": "PES"
},
"pgk": {
"code": "PGK",
"code_symbol_string": "PGK (PGK)",
"name": "Papua New Guinean kina",
"symbol": "PGK"
},
"php": {
"code": "PHP",
"code_symbol_string": "PHP (Php)",
"name": "Philippine peso",
"symbol": "Php"
},
"pkr": {
"code": "PKR",
"code_symbol_string": "PKR (₨)",
"name": "Pakistani rupee",
"symbol": "₨"
},
"pln": {
"code": "PLN",
"code_symbol_string": "PLN (zł)",
"name": "Polish zloty",
"symbol": "zł"
},
"plz": {
"code": "PLZ",
"code_symbol_string": "PLZ (PLZ)",
"name": "Polish zloty (PLZ)",
"symbol": "PLZ"
},
"pte": {
"code": "PTE",
"code_symbol_string": "PTE (PTE)",
"name": "Portuguese escudo",
"symbol": "PTE"
},
"pyg": {
"code": "PYG",
"code_symbol_string": "PYG (Gs)",
"name": "Paraguayan guarani",
"symbol": "Gs"
},
"qar": {
"code": "QAR",
"code_symbol_string": "QAR (﷼)",
"name": "Qatari rial",
"symbol": "﷼"
},
"rhd": {
"code": "RHD",
"code_symbol_string": "RHD (RHD)",
"name": "Rhodesian dollar",
"symbol": "RHD"
},
"rol": {
"code": "ROL",
"code_symbol_string": "ROL (ROL)",
"name": "Romanian leu (1952–2006)",
"symbol": "ROL"
},
"ron": {
"code": "RON",
"code_symbol_string": "RON (lei)",
"name": "Romanian leu",
"symbol": "lei"
},
"rsd": {
"code": "RSD",
"code_symbol_string": "RSD (Дин.)",
"name": "Serbian dinar",
"symbol": "Дин."
},
"rub": {
"code": "RUB",
"code_symbol_string": "RUB (руб)",
"name": "Russian ruble",
"symbol": "руб"
},
"rur": {
"code": "RUR",
"code_symbol_string": "RUR (р.)",
"name": "Russian ruble (1991–1998)",
"symbol": "р."
},
"rwf": {
"code": "RWF",
"code_symbol_string": "RWF (RF)",
"name": "Rwandan franc",
"symbol": "RF"
},
"sar": {
"code": "SAR",
"code_symbol_string": "SAR (﷼)",
"name": "Saudi riyal",
"symbol": "﷼"
},
"sbd": {
"code": "SBD",
"code_symbol_string": "SBD ($)",
"name": "Solomon Islands dollar",
"symbol": "$"
},
"scr": {
"code": "SCR",
"code_symbol_string": "SCR (₨)",
"name": "Seychellois rupee",
"symbol": "₨"
},
"sdd": {
"code": "SDD",
"code_symbol_string": "SDD (SDD)",
"name": "Sudanese dinar (1992–2007)",
"symbol": "SDD"
},
"sdg": {
"code": "SDG",
"code_symbol_string": "SDG (SDG)",
"name": "Sudanese pound",
"symbol": "SDG"
},
"sdp": {
"code": "SDP",
"code_symbol_string": "SDP (SDP)",
"name": "Sudanese pound (1957–1998)",
"symbol": "SDP"
},
"sek": {
"code": "SEK",
"code_symbol_string": "SEK (kr)",
"name": "Swedish krona",
"symbol": "kr"
},
"sgd": {
"code": "SGD",
"code_symbol_string": "SGD ($)",
"name": "Singapore dollar",
"symbol": "$"
},
"shp": {
"code": "SHP",
"code_symbol_string": "SHP (£)",
"name": "St. Helena pound",
"symbol": "£"
},
"sit": {
"code": "SIT",
"code_symbol_string": "SIT (SIT)",
"name": "Slovenian tolar",
"symbol": "SIT"
},
"skk": {
"code": "SKK",
"code_symbol_string": "SKK (SKK)",
"name": "Slovak koruna",
"symbol": "SKK"
},
"sll": {
"code": "SLL",
"code_symbol_string": "SLL (SLL)",
"name": "Sierra Leonean leone",
"symbol": "SLL"
},
"sos": {
"code": "SOS",
"code_symbol_string": "SOS (S)",
"name": "Somali shilling",
"symbol": "S"
},
"srd": {
"code": "SRD",
"code_symbol_string": "SRD ($)",
"name": "Surinamese dollar",
"symbol": "$"
},
"srg": {
"code": "SRG",
"code_symbol_string": "SRG (SRG)",
"name": "Surinamese guilder",
"symbol": "SRG"
},
"ssp": {
"code": "SSP",
"code_symbol_string": "SSP (£)",
"name": "South Sudanese pound",
"symbol": "£"
},
"std": {
"code": "STD",
"code_symbol_string": "STD (Db)",
"name": "São Tomé & Príncipe dobra",
"symbol": "Db"
},
"sur": {
"code": "SUR",
"code_symbol_string": "SUR (SUR)",
"name": "Soviet rouble",
"symbol": "SUR"
},
"svc": {
"code": "SVC",
"code_symbol_string": "SVC (SVC)",
"name": "Salvadoran colón",
"symbol": "SVC"
},
"syp": {
"code": "SYP",
"code_symbol_string": "SYP (£)",
"name": "Syrian pound",
"symbol": "£"
},
"szl": {
"code": "SZL",
"code_symbol_string": "SZL (SZL)",
"name": "Swazi lilangeni",
"symbol": "SZL"
},
"thb": {
"code": "THB",
"code_symbol_string": "THB (฿)",
"name": "Thai baht",
"symbol": "฿"
},
"tjr": {
"code": "TJR",
"code_symbol_string": "TJR (TJR)",
"name": "Tajikistani ruble",
"symbol": "TJR"
},
"tjs": {
"code": "TJS",
"code_symbol_string": "TJS (TJS)",
"name": "Tajikistani somoni",
"symbol": "TJS"
},
"tmm": {
"code": "TMM",
"code_symbol_string": "TMM (TMM)",
"name": "Turkmenistani manat (1993–2009)",
"symbol": "TMM"
},
"tmt": {
"code": "TMT",
"code_symbol_string": "TMT (TMT)",
"name": "Turkmenistani manat",
"symbol": "TMT"
},
"tnd": {
"code": "TND",
"code_symbol_string": "TND (TND)",
"name": "Tunisian dinar",
"symbol": "TND"
},
"top": {
"code": "TOP",
"code_symbol_string": "TOP (T$)",
"name": "Tongan paʻanga",
"symbol": "T$"
},
"tpe": {
"code": "TPE",
"code_symbol_string": "TPE (TPE)",
"name": "Timorese escudo",
"symbol": "TPE"
},
"trl": {
"code": "TRL",
"code_symbol_string": "TRL (TRL)",
"name": "Turkish lira (1922–2005)",
"symbol": "TRL"
},
"try": {
"code": "TRY",
"code_symbol_string": "TRY (TL)",
"name": "Turkish lira",
"symbol": "TL"
},
"ttd": {
"code": "TTD",
"code_symbol_string": "TTD ($)",
"name": "Trinidad & Tobago dollar",
"symbol": "$"
},
"twd": {
"code": "TWD",
"code_symbol_string": "TWD (NT$)",
"name": "New Taiwan dollar",
"symbol": "NT$"
},
"tzs": {
"code": "TZS",
"code_symbol_string": "TZS (TZS)",
"name": "Tanzanian shilling",
"symbol": "TZS"
},
"uah": {
"code": "UAH",
"code_symbol_string": "UAH (₴)",
"name": "Ukrainian hryvnia",
"symbol": "₴"
},
"uak": {
"code": "UAK",
"code_symbol_string": "UAK (UAK)",
"name": "Ukrainian karbovanets",
"symbol": "UAK"
},
"ugs": {
"code": "UGS",
"code_symbol_string": "UGS (UGS)",
"name": "Ugandan shilling (1966–1987)",
"symbol": "UGS"
},
"ugx": {
"code": "UGX",
"code_symbol_string": "UGX (UGX)",
"name": "Ugandan shilling",
"symbol": "UGX"
},
"usd": {
"code": "USD",
"code_symbol_string": "USD ($)",
"name": "US dollar",
"symbol": "$"
},
"usn": {
"code": "USN",
"code_symbol_string": "USN (USN)",
"name": "US dollar (next day)",
"symbol": "USN"
},
"uss": {
"code": "USS",
"code_symbol_string": "USS (USS)",
"name": "US dollar (same day)",
"symbol": "USS"
},
"uyi": {
"code": "UYI",
"code_symbol_string": "UYI (UYI)",
"name": "Uruguayan peso (indexed units)",
"symbol": "UYI"
},
"uyp": {
"code": "UYP",
"code_symbol_string": "UYP (UYP)",
"name": "Uruguayan peso (1975–1993)",
"symbol": "UYP"
},
"uyu": {
"code": "UYU",
"code_symbol_string": "UYU ($U)",
"name": "Uruguayan peso",
"symbol": "$U"
},
"uzs": {
"code": "UZS",
"code_symbol_string": "UZS (лв)",
"name": "Uzbekistani som",
"symbol": "лв"
},
"veb": {
"code": "VEB",
"code_symbol_string": "VEB (VEB)",
"name": "Venezuelan bolívar (1871–2008)",
"symbol": "VEB"
},
"vef": {
"code": "VEF",
"code_symbol_string": "VEF (Bs)",
"name": "Venezuelan bolívar",
"symbol": "Bs"
},
"vnd": {
"code": "VND",
"code_symbol_string": "VND (₫)",
"name": "Vietnamese dong",
"symbol": "₫"
},
"vnn": {
"code": "VNN",
"code_symbol_string": "VNN (VNN)",
"name": "Vietnamese dong (1978–1985)",
"symbol": "VNN"
},
"vuv": {
"code": "VUV",
"code_symbol_string": "VUV (VUV)",
"name": "Vanuatu vatu",
"symbol": "VUV"
},
"wst": {
"code": "WST",
"code_symbol_string": "WST (WST)",
"name": "Samoan tala",
"symbol": "WST"
},
"xaf": {
"code": "XAF",
"code_symbol_string": "XAF (FCFA)",
"name": "Central African CFA franc",
"symbol": "FCFA"
},
"xag": {
"code": "XAG",
"code_symbol_string": "XAG (XAG)",
"name": "troy ounce of silver",
"symbol": "XAG"
},
"xau": {
"code": "XAU",
"code_symbol_string": "XAU (XAU)",
"name": "troy ounce of gold",
"symbol": "XAU"
},
"xba": {
"code": "XBA",
"code_symbol_string": "XBA (XBA)",
"name": "European composite unit",
"symbol": "XBA"
},
"xbb": {
"code": "XBB",
"code_symbol_string": "XBB (XBB)",
"name": "European monetary unit",
"symbol": "XBB"
},
"xbc": {
"code": "XBC",
"code_symbol_string": "XBC (XBC)",
"name": "European unit of account (XBC)",
"symbol": "XBC"
},
"xbd": {
"code": "XBD",
"code_symbol_string": "XBD (XBD)",
"name": "European unit of account (XBD)",
"symbol": "XBD"
},
"xcd": {
"code": "XCD",
"code_symbol_string": "XCD ($)",
"name": "East Caribbean dollar",
"symbol": "$"
},
"xdr": {
"code": "XDR",
"code_symbol_string": "XDR (XDR)",
"name": "special drawing rights",
"symbol": "XDR"
},
"xeu": {
"code": "XEU",
"code_symbol_string": "XEU (XEU)",
"name": "European currency unit",
"symbol": "XEU"
},
"xfo": {
"code": "XFO",
"code_symbol_string": "XFO (XFO)",
"name": "French gold franc",
"symbol": "XFO"
},
"xfu": {
"code": "XFU",
"code_symbol_string": "XFU (XFU)",
"name": "French UIC-franc",
"symbol": "XFU"
},
"xof": {
"code": "XOF",
"code_symbol_string": "XOF (CFA)",
"name": "West African CFA franc",
"symbol": "CFA"
},
"xpd": {
"code": "XPD",
"code_symbol_string": "XPD (XPD)",
"name": "troy ounce of palladium",
"symbol": "XPD"
},
"xpf": {
"code": "XPF",
"code_symbol_string": "XPF (CFPF)",
"name": "CFP franc",
"symbol": "CFPF"
},
"xpt": {
"code": "XPT",
"code_symbol_string": "XPT (XPT)",
"name": "troy ounce of platinum",
"symbol": "XPT"
},
"xre": {
"code": "XRE",
"code_symbol_string": "XRE (XRE)",
"name": "RINET Funds unit",
"symbol": "XRE"
},
"xsu": {
"code": "XSU",
"code_symbol_string": "XSU (XSU)",
"name": "Sucre",
"symbol": "XSU"
},
"xts": {
"code": "XTS",
"code_symbol_string": "XTS (XTS)",
"name": "Testing Currency unit",
"symbol": "XTS"
},
"xua": {
"code": "XUA",
"code_symbol_string": "XUA (XUA)",
"name": "ADB unit of account",
"symbol": "XUA"
},
"xxx": {
"code": "XXX",
"code_symbol_string": "XXX (XXX)",
"name": "(unknown unit of currency)",
"symbol": "XXX"
},
"ydd": {
"code": "YDD",
"code_symbol_string": "YDD (YDD)",
"name": "Yemeni dinar",
"symbol": "YDD"
},
"yer": {
"code": "YER",
"code_symbol_string": "YER (﷼)",
"name": "Yemeni rial",
"symbol": "﷼"
},
"yud": {
"code": "YUD",
"code_symbol_string": "YUD (YUD)",
"name": "Yugoslavian hard dinar (1966–1990)",
"symbol": "YUD"
},
"yum": {
"code": "YUM",
"code_symbol_string": "YUM (YUM)",
"name": "Yugoslavian new dinar (1994–2002)",
"symbol": "YUM"
},
"yun": {
"code": "YUN",
"code_symbol_string": "YUN (YUN)",
"name": "Yugoslavian convertible dinar (1990–1992)",
"symbol": "YUN"
},
"yur": {
"code": "YUR",
"code_symbol_string": "YUR (YUR)",
"name": "Yugoslavian reformed dinar (1992–1993)",
"symbol": "YUR"
},
"zal": {
"code": "ZAL",
"code_symbol_string": "ZAL (ZAL)",
"name": "South African rand (financial)",
"symbol": "ZAL"
},
"zar": {
"code": "ZAR",
"code_symbol_string": "ZAR (R)",
"name": "South African rand",
"symbol": "R"
},
"zmk": {
"code": "ZMK",
"code_symbol_string": "ZMK (ZMK)",
"name": "Zambian kwacha (1968–2012)",
"symbol": "ZMK"
},
"zmw": {
"code": "ZMW",
"code_symbol_string": "ZMW (ZK)",
"name": "Zambian kwacha",
"symbol": "ZK"
},
"zrn": {
"code": "ZRN",
"code_symbol_string": "ZRN (ZRN)",
"name": "Zairean new zaire (1993–1998)",
"symbol": "ZRN"
},
"zrz": {
"code": "ZRZ",
"code_symbol_string": "ZRZ (ZRZ)",
"name": "Zairean zaire (1971–1993)",
"symbol": "ZRZ"
},
"zwd": {
"code": "ZWD",
"code_symbol_string": "ZWD (Z$)",
"name": "Zimbabwean dollar (1980–2008)",
"symbol": "Z$"
},
"zwl": {
"code": "ZWL",
"code_symbol_string": "ZWL (ZWL)",
"name": "Zimbabwean dollar (2009)",
"symbol": "ZWL"
},
"zwr": {
"code": "ZWR",
"code_symbol_string": "ZWR (ZWR)",
"name": "Zimbabwean dollar (2008)",
"symbol": "ZWR"
}
},
"pledge_received": [
"Yes",
"No"
],
"status": [
"Never Contacted",
"Ask in Future",
"Cultivate Relationship",
"Contact for Appointment",
"Appointment Scheduled",
"Call for Decision",
"Partner - Financial",
"Partner - Special",
"Partner - Pray",
"Not Interested",
"Unresponsive",
"Never Ask",
"Research Abandoned",
"Expired Referral"
]
},
"dates": {
"ar_sa": "dd/MM/yy",
"bg_bg": "dd.M.yyyy",
"ca_es": "dd/MM/yyyy",
"zh_tw": "yyyy/M/d",
"cs_cz": "d.M.yyyy",
"da_dk": "dd-MM-yyyy",
"de_de": "dd.MM.yyyy",
"el_gr": "d/M/yyyy",
"en_us": "M/d/yyyy",
"fi_fi": "d.M.yyyy",
"fr_fr": "dd/MM/yyyy",
"he_il": "dd/MM/yyyy",
"hu_hu": "yyyy. MM. dd.",
"is_is": "d.M.yyyy",
"it_it": "dd/MM/yyyy",
"ja_jp": "yyyy/MM/dd",
"ko_kr": "yyyy-MM-dd",
"nl_nl": "d-M-yyyy",
"nb_no": "dd.MM.yyyy",
"pl_pl": "yyyy-MM-dd",
"pt_br": "d/M/yyyy",
"ro_ro": "dd.MM.yyyy",
"ru_ru": "dd.MM.yyyy",
"hr_hr": "d.M.yyyy",
"sk_sk": "d. M. yyyy",
"sq_al": "yyyy-MM-dd",
"sv_se": "yyyy-MM-dd",
"th_th": "d/M/yyyy",
"tr_tr": "dd.MM.yyyy",
"ur_pk": "dd/MM/yyyy",
"id_id": "dd/MM/yyyy",
"uk_ua": "dd.MM.yyyy",
"be_by": "dd.MM.yyyy",
"sl_si": "d.M.yyyy",
"et_ee": "d.MM.yyyy",
"lv_lv": "yyyy.MM.dd.",
"lt_lt": "yyyy.MM.dd",
"fa_ir": "MM/dd/yyyy",
"vi_vn": "dd/MM/yyyy",
"hy_am": "dd.MM.yyyy",
"az_latn_az": "dd.MM.yyyy",
"eu_es": "yyyy/MM/dd",
"mk_mk": "dd.MM.yyyy",
"af_za": "yyyy/MM/dd",
"ka_ge": "dd.MM.yyyy",
"fo_fo": "dd-MM-yyyy",
"hi_in": "dd-MM-yyyy",
"ms_my": "dd/MM/yyyy",
"kk_kz": "dd.MM.yyyy",
"ky_kg": "dd.MM.yy",
"sw_ke": "M/d/yyyy",
"uz_latn_uz": "dd/MM yyyy",
"tt_ru": "dd.MM.yyyy",
"pa_in": "dd-MM-yy",
"gu_in": "dd-MM-yy",
"ta_in": "dd-MM-yyyy",
"te_in": "dd-MM-yy",
"kn_in": "dd-MM-yy",
"mr_in": "dd-MM-yyyy",
"sa_in": "dd-MM-yyyy",
"mn_mn": "yy.MM.dd",
"gl_es": "dd/MM/yy",
"kok_in": "dd-MM-yyyy",
"syr_sy": "dd/MM/yyyy",
"dv_mv": "dd/MM/yy",
"ar_iq": "dd/MM/yyyy",
"zh_cn": "yyyy/M/d",
"de_ch": "dd.MM.yyyy",
"en_gb": "dd/MM/yyyy",
"es_mx": "dd/MM/yyyy",
"fr_be": "d/MM/yyyy",
"it_ch": "dd.MM.yyyy",
"nl_be": "d/MM/yyyy",
"nn_no": "dd.MM.yyyy",
"pt_pt": "dd-MM-yyyy",
"sr_latn_cs": "d.M.yyyy",
"sv_fi": "d.M.yyyy",
"az_cyrl_az": "dd.MM.yyyy",
"ms_bn": "dd/MM/yyyy",
"uz_cyrl_uz": "dd.MM.yyyy",
"ar_eg": "dd/MM/yyyy",
"zh_hk": "d/M/yyyy",
"de_at": "dd.MM.yyyy",
"en_au": "d/MM/yyyy",
"es_es": "dd/MM/yyyy",
"fr_ca": "yyyy-MM-dd",
"sr_cyrl_cs": "d.M.yyyy",
"ar_ly": "dd/MM/yyyy",
"zh_sg": "d/M/yyyy",
"de_lu": "dd.MM.yyyy",
"en_ca": "dd/MM/yyyy",
"es_gt": "dd/MM/yyyy",
"fr_ch": "dd.MM.yyyy",
"ar_dz": "dd-MM-yyyy",
"zh_mo": "d/M/yyyy",
"de_li": "dd.MM.yyyy",
"en_nz": "d/MM/yyyy",
"es_cr": "dd/MM/yyyy",
"fr_lu": "dd/MM/yyyy",
"ar_ma": "dd-MM-yyyy",
"en_ie": "dd/MM/yyyy",
"es_pa": "MM/dd/yyyy",
"fr_mc": "dd/MM/yyyy",
"ar_tn": "dd-MM-yyyy",
"en_za": "yyyy/MM/dd",
"es_do": "dd/MM/yyyy",
"ar_om": "dd/MM/yyyy",
"en_jm": "dd/MM/yyyy",
"es_ve": "dd/MM/yyyy",
"ar_ye": "dd/MM/yyyy",
"en_029": "MM/dd/yyyy",
"es_co": "dd/MM/yyyy",
"ar_sy": "dd/MM/yyyy",
"en_bz": "dd/MM/yyyy",
"es_pe": "dd/MM/yyyy",
"ar_jo": "dd/MM/yyyy",
"en_tt": "dd/MM/yyyy",
"es_ar": "dd/MM/yyyy",
"ar_lb": "dd/MM/yyyy",
"en_zw": "M/d/yyyy",
"es_ec": "dd/MM/yyyy",
"ar_kw": "dd/MM/yyyy",
"en_ph": "M/d/yyyy",
"es_cl": "dd-MM-yyyy",
"ar_ae": "dd/MM/yyyy",
"es_uy": "dd/MM/yyyy",
"ar_bh": "dd/MM/yyyy",
"es_py": "dd/MM/yyyy",
"ar_qa": "dd/MM/yyyy",
"es_bo": "dd/MM/yyyy",
"es_sv": "dd/MM/yyyy",
"es_hn": "dd/MM/yyyy",
"es_ni": "dd/MM/yyyy",
"es_pr": "dd/MM/yyyy",
"am_et": "d/M/yyyy",
"tzm_latn_dz": "dd-MM-yyyy",
"iu_latn_ca": "d/MM/yyyy",
"sma_no": "dd.MM.yyyy",
"mn_mong_cn": "yyyy/M/d",
"gd_gb": "dd/MM/yyyy",
"en_my": "d/M/yyyy",
"prs_af": "dd/MM/yy",
"bn_bd": "dd-MM-yy",
"wo_sn": "dd/MM/yyyy",
"rw_rw": "M/d/yyyy",
"qut_gt": "dd/MM/yyyy",
"sah_ru": "MM.dd.yyyy",
"gsw_fr": "dd/MM/yyyy",
"co_fr": "dd/MM/yyyy",
"oc_fr": "dd/MM/yyyy",
"mi_nz": "dd/MM/yyyy",
"ga_ie": "dd/MM/yyyy",
"se_se": "yyyy-MM-dd",
"br_fr": "dd/MM/yyyy",
"smn_fi": "d.M.yyyy",
"moh_ca": "M/d/yyyy",
"arn_cl": "dd-MM-yyyy",
"ii_cn": "yyyy/M/d",
"dsb_de": "d. M. yyyy",
"ig_ng": "d/M/yyyy",
"kl_gl": "dd-MM-yyyy",
"lb_lu": "dd/MM/yyyy",
"ba_ru": "dd.MM.yy",
"nso_za": "yyyy/MM/dd",
"quz_bo": "dd/MM/yyyy",
"yo_ng": "d/M/yyyy",
"ha_latn_ng": "d/M/yyyy",
"fil_ph": "M/d/yyyy",
"ps_af": "dd/MM/yy",
"fy_nl": "d-M-yyyy",
"ne_np": "M/d/yyyy",
"se_no": "dd.MM.yyyy",
"iu_cans_ca": "d/M/yyyy",
"sr_latn_rs": "d.M.yyyy",
"si_lk": "yyyy-MM-dd",
"sr_cyrl_rs": "d.M.yyyy",
"lo_la": "dd/MM/yyyy",
"km_kh": "yyyy-MM-dd",
"cy_gb": "dd/MM/yyyy",
"bo_cn": "yyyy/M/d",
"sms_fi": "d.M.yyyy",
"as_in": "dd-MM-yyyy",
"ml_in": "dd-MM-yy",
"en_in": "dd-MM-yyyy",
"or_in": "dd-MM-yy",
"bn_in": "dd-MM-yy",
"tk_tm": "dd.MM.yy",
"bs_latn_ba": "d.M.yyyy",
"mt_mt": "dd/MM/yyyy",
"sr_cyrl_me": "d.M.yyyy",
"se_fi": "d.M.yyyy",
"zu_za": "yyyy/MM/dd",
"xh_za": "yyyy/MM/dd",
"tn_za": "yyyy/MM/dd",
"hsb_de": "d. M. yyyy",
"bs_cyrl_ba": "d.M.yyyy",
"tg_cyrl_tj": "dd.MM.yy",
"sr_latn_ba": "d.M.yyyy",
"smj_no": "dd.MM.yyyy",
"rm_ch": "dd/MM/yyyy",
"smj_se": "yyyy-MM-dd",
"quz_ec": "dd/MM/yyyy",
"quz_pe": "dd/MM/yyyy",
"hr_ba": "d.M.yyyy.",
"sr_latn_me": "d.M.yyyy",
"sma_se": "yyyy-MM-dd",
"en_sg": "d/M/yyyy",
"ug_cn": "yyyy-M-d",
"sr_cyrl_ba": "d.M.yyyy",
"es_us": "M/d/yyyy"
},
"languages": {
"en_us": "US English",
"ar": "Arabic",
"hy": "Armenian",
"zh_hans_cn": "Chinese (Simplified)",
"nl_nl": "Dutch (Netherlands)",
"fr_fr": "French (France)",
"fr_ca": "French (Canadian)",
"de": "German",
"id": "Indonesian",
"it": "Italian",
"ko": "Korean",
"pl": "Polish",
"pt_br": "Portuguese (Brasil)",
"ru": "Russian",
"es_419": "Spanish (Latin America)",
"th": "Thai",
"tr": "Turkish",
"uk": "Ukranian"
},
"locales": {
"af": {
"native_name": "Afrikaans",
"english_name": "Afrikaans (af)"
},
"sq": {
"native_name": "shqip",
"english_name": "Albanian (sq)"
},
"ar": {
"native_name": "العربية",
"english_name": "Arabic (ar)"
},
"en_au": {
"native_name": "Australian English",
"english_name": "Australian English (en-AU)"
},
"eu": {
"native_name": "euskara",
"english_name": "Basque (eu)"
},
"be": {
"native_name": "беларуская",
"english_name": "Belarusian (be)"
},
"bn": {
"native_name": "বাংলা",
"english_name": "Bengali (bn)"
},
"bg": {
"native_name": "български",
"english_name": "Bulgarian (bg)"
},
"en_ca": {
"native_name": "Canadian English",
"english_name": "Canadian English (en-CA)"
},
"fr_ca": {
"native_name": "français canadien",
"english_name": "Canadian French (fr-CA)"
},
"ca": {
"native_name": "català",
"english_name": "Catalan (ca)"
},
"zh": {
"native_name": "中文",
"english_name": "Chinese (zh)"
},
"hr": {
"native_name": "hrvatski",
"english_name": "Croatian (hr)"
},
"cs": {
"native_name": "čeština",
"english_name": "Czech (cs)"
},
"da": {
"native_name": "dansk",
"english_name": "Danish (da)"
},
"nl": {
"native_name": "Nederlands",
"english_name": "Dutch (nl)"
},
"en": {
"native_name": "English",
"english_name": "English (en)"
},
"fil": {
"native_name": "Filipino",
"english_name": "Filipino (fil)"
},
"fi": {
"native_name": "suomi",
"english_name": "Finnish (fi)"
},
"fr": {
"native_name": "français",
"english_name": "French (fr)"
},
"gl": {
"native_name": "galego",
"english_name": "Galician (gl)"
},
"de": {
"native_name": "Deutsch",
"english_name": "German (de)"
},
"el": {
"native_name": "Ελληνικά",
"english_name": "Greek (el)"
},
"gu": {
"native_name": "ગુજરાતી",
"english_name": "Gujarati (gu)"
},
"he": {
"native_name": "עברית",
"english_name": "Hebrew (he)"
},
"hi": {
"native_name": "हिन्दी",
"english_name": "Hindi (hi)"
},
"hu": {
"native_name": "magyar",
"english_name": "Hungarian (hu)"
},
"is": {
"native_name": "íslenska",
"english_name": "Icelandic (is)"
},
"id": {
"native_name": "Indonesia",
"english_name": "Indonesian (id)"
},
"ga": {
"native_name": "Gaeilge",
"english_name": "Irish (ga)"
},
"it": {
"native_name": "italiano",
"english_name": "Italian (it)"
},
"ja": {
"native_name": "日本語",
"english_name": "Japanese (ja)"
},
"kn": {
"native_name": "ಕನ್ನಡ",
"english_name": "Kannada (kn)"
},
"ko": {
"native_name": "한국어",
"english_name": "Korean (ko)"
},
"es_419": {
"native_name": "español latinoamericano",
"english_name": "Latin American Spanish (es-419)"
},
"lv": {
"native_name": "latviešu",
"english_name": "Latvian (lv)"
},
"ms": {
"native_name": "Bahasa Melayu",
"english_name": "Malay (ms)"
},
"mr": {
"native_name": "मराठी",
"english_name": "Marathi (mr)"
},
"es_mx": {
"native_name": "español de México",
"english_name": "Mexican Spanish (es-MX)"
},
"nb": {
"native_name": "norsk bokmål",
"english_name": "Norwegian Bokmål (nb)"
},
"fa": {
"native_name": "فارسی",
"english_name": "Persian (fa)"
},
"pl": {
"native_name": "polski",
"english_name": "Polish (pl)"
},
"pt": {
"native_name": "português",
"english_name": "Portuguese (pt)"
},
"ro": {
"native_name": "română",
"english_name": "Romanian (ro)"
},
"ru": {
"native_name": "русский",
"english_name": "Russian (ru)"
},
"sr": {
"native_name": "српски",
"english_name": "Serbian (sr)"
},
"sk": {
"native_name": "slovenčina",
"english_name": "Slovak (sk)"
},
"sl": {
"native_name": "slovenščina",
"english_name": "Slovenian (sl)"
},
"es": {
"native_name": "español",
"english_name": "Spanish (es)"
},
"sv": {
"native_name": "svenska",
"english_name": "Swedish (sv)"
},
"fr_ch": {
"native_name": "français suisse",
"english_name": "Swiss French (fr-CH)"
},
"de_ch": {
"native_name": "Schweizer Hochdeutsch",
"english_name": "Swiss High German (de-CH)"
},
"ta": {
"native_name": "தமிழ்",
"english_name": "Tamil (ta)"
},
"th": {
"native_name": "ไทย",
"english_name": "Thai (th)"
},
"bo": {
"native_name": "བོད་སྐད་",
"english_name": "Tibetan (bo)"
},
"zh_hant": {
"native_name": "繁體中文",
"english_name": "Traditional Chinese (zh-Hant)"
},
"tr": {
"native_name": "Türkçe",
"english_name": "Turkish (tr)"
},
"en_gb": {
"native_name": "UK English",
"english_name": "UK English (en-GB)"
},
"uk": {
"native_name": "українська",
"english_name": "Ukrainian (uk)"
},
"ur": {
"native_name": "اردو",
"english_name": "Urdu (ur)"
},
"vi": {
"native_name": "Tiếng Việt",
"english_name": "Vietnamese (vi)"
},
"cy": {
"native_name": "Cymraeg",
"english_name": "Welsh (cy)"
}
},
"pledge_currencies": {
"aed": {
"code": "AED",
"code_symbol_string": "AED (AED)",
"name": "UAE dirham",
"symbol": "AED"
},
"afn": {
"code": "AFN",
"code_symbol_string": "AFN (؋)",
"name": "Afghan Afghani",
"symbol": "؋"
},
"alk": {
"code": "ALK",
"code_symbol_string": "ALK (ALK)",
"name": "Albanian lek (1946–1965)",
"symbol": "ALK"
},
"all": {
"code": "ALL",
"code_symbol_string": "ALL (LEK)",
"name": "Albanian lek",
"symbol": "LEK"
},
"amd": {
"code": "AMD",
"code_symbol_string": "AMD (AMD)",
"name": "Armenian dram",
"symbol": "AMD"
},
"ang": {
"code": "ANG",
"code_symbol_string": "ANG (ƒ)",
"name": "Netherlands Antillean guilder",
"symbol": "ƒ"
},
"aoa": {
"code": "AOA",
"code_symbol_string": "AOA (Kz)",
"name": "Angolan kwanza",
"symbol": "Kz"
},
"aok": {
"code": "AOK",
"code_symbol_string": "AOK (AOK)",
"name": "Angolan kwanza (1977–1991)",
"symbol": "AOK"
},
"aon": {
"code": "AON",
"code_symbol_string": "AON (AON)",
"name": "Angolan new kwanza (1990–2000)",
"symbol": "AON"
},
"aor": {
"code": "AOR",
"code_symbol_string": "AOR (AOR)",
"name": "Angolan readjusted kwanza (1995–1999)",
"symbol": "AOR"
},
"ara": {
"code": "ARA",
"code_symbol_string": "ARA (ARA)",
"name": "Argentine austral",
"symbol": "ARA"
},
"arl": {
"code": "ARL",
"code_symbol_string": "ARL (ARL)",
"name": "Argentine peso ley (1970–1983)",
"symbol": "ARL"
},
"arm": {
"code": "ARM",
"code_symbol_string": "ARM (ARM)",
"name": "Argentine peso (1881–1970)",
"symbol": "ARM"
},
"arp": {
"code": "ARP",
"code_symbol_string": "ARP (ARP)",
"name": "Argentine peso (1983–1985)",
"symbol": "ARP"
},
"ars": {
"code": "ARS",
"code_symbol_string": "ARS ($)",
"name": "Argentine peso",
"symbol": "$"
},
"ats": {
"code": "ATS",
"code_symbol_string": "ATS (ATS)",
"name": "Austrian schilling",
"symbol": "ATS"
},
"aud": {
"code": "AUD",
"code_symbol_string": "AUD ($)",
"name": "Australian dollar",
"symbol": "$"
},
"awg": {
"code": "AWG",
"code_symbol_string": "AWG (ƒ)",
"name": "Aruban florin",
"symbol": "ƒ"
},
"azm": {
"code": "AZM",
"code_symbol_string": "AZM (AZM)",
"name": "Azerbaijani manat (1993–2006)",
"symbol": "AZM"
},
"azn": {
"code": "AZN",
"code_symbol_string": "AZN (ман)",
"name": "Azerbaijani manat",
"symbol": "ман"
},
"bad": {
"code": "BAD",
"code_symbol_string": "BAD (BAD)",
"name": "Bosnia-Herzegovina dinar (1992–1994)",
"symbol": "BAD"
},
"bam": {
"code": "BAM",
"code_symbol_string": "BAM (KM)",
"name": "Bosnia-Herzegovina convertible mark",
"symbol": "KM"
},
"ban": {
"code": "BAN",
"code_symbol_string": "BAN (BAN)",
"name": "Bosnia-Herzegovina new dinar (1994–1997)",
"symbol": "BAN"
},
"bbd": {
"code": "BBD",
"code_symbol_string": "BBD ($)",
"name": "Barbadian dollar",
"symbol": "$"
},
"bdt": {
"code": "BDT",
"code_symbol_string": "BDT (৳)",
"name": "Bangladeshi taka",
"symbol": "৳"
},
"bec": {
"code": "BEC",
"code_symbol_string": "BEC (BEC)",
"name": "Belgian franc (convertible)",
"symbol": "BEC"
},
"bef": {
"code": "BEF",
"code_symbol_string": "BEF (BEF)",
"name": "Belgian franc",
"symbol": "BEF"
},
"bel": {
"code": "BEL",
"code_symbol_string": "BEL (BEL)",
"name": "Belgian franc (financial)",
"symbol": "BEL"
},
"bgl": {
"code": "BGL",
"code_symbol_string": "BGL (BGL)",
"name": "Bulgarian hard lev",
"symbol": "BGL"
},
"bgm": {
"code": "BGM",
"code_symbol_string": "BGM (BGM)",
"name": "Bulgarian socialist lev",
"symbol": "BGM"
},
"bgn": {
"code": "BGN",
"code_symbol_string": "BGN (лв)",
"name": "Bulgarian lev",
"symbol": "лв"
},
"bgo": {
"code": "BGO",
"code_symbol_string": "BGO (BGO)",
"name": "Bulgarian lev (1879–1952)",
"symbol": "BGO"
},
"bhd": {
"code": "BHD",
"code_symbol_string": "BHD (BHD)",
"name": "Bahraini dinar",
"symbol": "BHD"
},
"bif": {
"code": "BIF",
"code_symbol_string": "BIF (BIF)",
"name": "Burundian franc",
"symbol": "BIF"
},
"bmd": {
"code": "BMD",
"code_symbol_string": "BMD ($)",
"name": "Bermudan dollar",
"symbol": "$"
},
"bnd": {
"code": "BND",
"code_symbol_string": "BND ($)",
"name": "Brunei dollar",
"symbol": "$"
},
"bob": {
"code": "BOB",
"code_symbol_string": "BOB ($b)",
"name": "Bolivian boliviano",
"symbol": "$b"
},
"bol": {
"code": "BOL",
"code_symbol_string": "BOL (BOL)",
"name": "Bolivian boliviano (1863–1963)",
"symbol": "BOL"
},
"bop": {
"code": "BOP",
"code_symbol_string": "BOP (BOP)",
"name": "Bolivian peso",
"symbol": "BOP"
},
"bov": {
"code": "BOV",
"code_symbol_string": "BOV (BOV)",
"name": "Bolivian mvdol",
"symbol": "BOV"
},
"brb": {
"code": "BRB",
"code_symbol_string": "BRB (BRB)",
"name": "Brazilian new cruzeiro (1967–1986)",
"symbol": "BRB"
},
"brc": {
"code": "BRC",
"code_symbol_string": "BRC (BRC)",
"name": "Brazilian cruzado (1986–1989)",
"symbol": "BRC"
},
"bre": {
"code": "BRE",
"code_symbol_string": "BRE (BRE)",
"name": "Brazilian cruzeiro (1990–1993)",
"symbol": "BRE"
},
"brl": {
"code": "BRL",
"code_symbol_string": "BRL (R$)",
"name": "Brazilian real",
"symbol": "R$"
},
"brn": {
"code": "BRN",
"code_symbol_string": "BRN (BRN)",
"name": "Brazilian new cruzado (1989–1990)",
"symbol": "BRN"
},
"brr": {
"code": "BRR",
"code_symbol_string": "BRR (BRR)",
"name": "Brazilian cruzeiro (1993–1994)",
"symbol": "BRR"
},
"brz": {
"code": "BRZ",
"code_symbol_string": "BRZ (BRZ)",
"name": "Brazilian cruzeiro (1942–1967)",
"symbol": "BRZ"
},
"bsd": {
"code": "BSD",
"code_symbol_string": "BSD ($)",
"name": "Bahamian dollar",
"symbol": "$"
},
"btn": {
"code": "BTN",
"code_symbol_string": "BTN (BTN)",
"name": "Bhutanese ngultrum",
"symbol": "BTN"
},
"buk": {
"code": "BUK",
"code_symbol_string": "BUK (BUK)",
"name": "Burmese kyat",
"symbol": "BUK"
},
"bwp": {
"code": "BWP",
"code_symbol_string": "BWP (P)",
"name": "Botswanan pula",
"symbol": "P"
},
"byb": {
"code": "BYB",
"code_symbol_string": "BYB (BYB)",
"name": "Belarusian new ruble (1994–1999)",
"symbol": "BYB"
},
"byr": {
"code": "BYR",
"code_symbol_string": "BYR (p.)",
"name": "Belarusian ruble",
"symbol": "p."
},
"bzd": {
"code": "BZD",
"code_symbol_string": "BZD (BZ$)",
"name": "Belize dollar",
"symbol": "BZ$"
},
"cad": {
"code": "CAD",
"code_symbol_string": "CAD ($)",
"name": "Canadian dollar",
"symbol": "$"
},
"cdf": {
"code": "CDF",
"code_symbol_string": "CDF (CDF)",
"name": "Congolese franc",
"symbol": "CDF"
},
"che": {
"code": "CHE",
"code_symbol_string": "CHE (CHE)",
"name": "WIR euro",
"symbol": "CHE"
},
"chf": {
"code": "CHF",
"code_symbol_string": "CHF (CHF)",
"name": "Swiss franc",
"symbol": "CHF"
},
"chw": {
"code": "CHW",
"code_symbol_string": "CHW (CHW)",
"name": "WIR franc",
"symbol": "CHW"
},
"cle": {
"code": "CLE",
"code_symbol_string": "CLE (CLE)",
"name": "Chilean escudo",
"symbol": "CLE"
},
"clf": {
"code": "CLF",
"code_symbol_string": "CLF (CLF)",
"name": "Chilean unit of account (UF)",
"symbol": "CLF"
},
"clp": {
"code": "CLP",
"code_symbol_string": "CLP ($)",
"name": "Chilean peso",
"symbol": "$"
},
"cnx": {
"code": "CNX",
"code_symbol_string": "CNX (CNX)",
"name": "Chinese People’s Bank dollar",
"symbol": "CNX"
},
"cny": {
"code": "CNY",
"code_symbol_string": "CNY (¥)",
"name": "Chinese yuan",
"symbol": "¥"
},
"cop": {
"code": "COP",
"code_symbol_string": "COP ($)",
"name": "Colombian peso",
"symbol": "$"
},
"cou": {
"code": "COU",
"code_symbol_string": "COU (COU)",
"name": "Colombian real value unit",
"symbol": "COU"
},
"crc": {
"code": "CRC",
"code_symbol_string": "CRC (₡)",
"name": "Costa Rican colón",
"symbol": "₡"
},
"csd": {
"code": "CSD",
"code_symbol_string": "CSD (CSD)",
"name": "Serbian dinar (2002–2006)",
"symbol": "CSD"
},
"csk": {
"code": "CSK",
"code_symbol_string": "CSK (CSK)",
"name": "Czechoslovak hard koruna",
"symbol": "CSK"
},
"cuc": {
"code": "CUC",
"code_symbol_string": "CUC ($)",
"name": "Cuban convertible peso",
"symbol": "$"
},
"cup": {
"code": "CUP",
"code_symbol_string": "CUP (₱)",
"name": "Cuban peso",
"symbol": "₱"
},
"cve": {
"code": "CVE",
"code_symbol_string": "CVE (CVE)",
"name": "Cape Verdean escudo",
"symbol": "CVE"
},
"cyp": {
"code": "CYP",
"code_symbol_string": "CYP (CYP)",
"name": "Cypriot pound",
"symbol": "CYP"
},
"czk": {
"code": "CZK",
"code_symbol_string": "CZK (Kč)",
"name": "Czech Republic koruna",
"symbol": "Kč"
},
"ddm": {
"code": "DDM",
"code_symbol_string": "DDM (DDM)",
"name": "East German mark",
"symbol": "DDM"
},
"dem": {
"code": "DEM",
"code_symbol_string": "DEM (DEM)",
"name": "German mark",
"symbol": "DEM"
},
"djf": {
"code": "DJF",
"code_symbol_string": "DJF (DJF)",
"name": "Djiboutian franc",
"symbol": "DJF"
},
"dkk": {
"code": "DKK",
"code_symbol_string": "DKK (kr)",
"name": "Danish krone",
"symbol": "kr"
},
"dop": {
"code": "DOP",
"code_symbol_string": "DOP (RD$)",
"name": "Dominican peso",
"symbol": "RD$"
},
"dzd": {
"code": "DZD",
"code_symbol_string": "DZD (DZD)",
"name": "Algerian dinar",
"symbol": "DZD"
},
"ecs": {
"code": "ECS",
"code_symbol_string": "ECS (ECS)",
"name": "Ecuadorian sucre",
"symbol": "ECS"
},
"ecv": {
"code": "ECV",
"code_symbol_string": "ECV (ECV)",
"name": "Ecuadorian unit of constant value",
"symbol": "ECV"
},
"eek": {
"code": "EEK",
"code_symbol_string": "EEK (kr)",
"name": "Estonian kroon",
"symbol": "kr"
},
"egp": {
"code": "EGP",
"code_symbol_string": "EGP (£)",
"name": "Egyptian pound",
"symbol": "£"
},
"ern": {
"code": "ERN",
"code_symbol_string": "ERN (ERN)",
"name": "Eritrean nakfa",
"symbol": "ERN"
},
"esa": {
"code": "ESA",
"code_symbol_string": "ESA (ESA)",
"name": "Spanish peseta (A account)",
"symbol": "ESA"
},
"esb": {
"code": "ESB",
"code_symbol_string": "ESB (ESB)",
"name": "Spanish peseta (convertible account)",
"symbol": "ESB"
},
"esp": {
"code": "ESP",
"code_symbol_string": "ESP (₧)",
"name": "Spanish peseta",
"symbol": "₧"
},
"etb": {
"code": "ETB",
"code_symbol_string": "ETB (ETB)",
"name": "Ethiopian birr",
"symbol": "ETB"
},
"eur": {
"code": "EUR",
"code_symbol_string": "EUR (€)",
"name": "euro",
"symbol": "€"
},
"fim": {
"code": "FIM",
"code_symbol_string": "FIM (FIM)",
"name": "Finnish markka",
"symbol": "FIM"
},
"fjd": {
"code": "FJD",
"code_symbol_string": "FJD ($)",
"name": "Fijian dollar",
"symbol": "$"
},
"fkp": {
"code": "FKP",
"code_symbol_string": "FKP (£)",
"name": "Falkland Islands pound",
"symbol": "£"
},
"frf": {
"code": "FRF",
"code_symbol_string": "FRF (FRF)",
"name": "French franc",
"symbol": "FRF"
},
"gbp": {
"code": "GBP",
"code_symbol_string": "GBP (£)",
"name": "British pound",
"symbol": "£"
},
"gek": {
"code": "GEK",
"code_symbol_string": "GEK (GEK)",
"name": "Georgian kupon larit",
"symbol": "GEK"
},
"gel": {
"code": "GEL",
"code_symbol_string": "GEL (₾)",
"name": "Georgian lari",
"symbol": "₾"
},
"ghc": {
"code": "GHC",
"code_symbol_string": "GHC (GHC)",
"name": "Ghanaian cedi (1979–2007)",
"symbol": "GHC"
},
"ghs": {
"code": "GHS",
"code_symbol_string": "GHS (¢)",
"name": "Ghanaian cedi",
"symbol": "¢"
},
"gip": {
"code": "GIP",
"code_symbol_string": "GIP (£)",
"name": "Gibraltar pound",
"symbol": "£"
},
"gmd": {
"code": "GMD",
"code_symbol_string": "GMD (GMD)",
"name": "Gambian dalasi",
"symbol": "GMD"
},
"gnf": {
"code": "GNF",
"code_symbol_string": "GNF (FG)",
"name": "Guinean franc",
"symbol": "FG"
},
"gns": {
"code": "GNS",
"code_symbol_string": "GNS (GNS)",
"name": "Guinean syli",
"symbol": "GNS"
},
"gqe": {
"code": "GQE",
"code_symbol_string": "GQE (GQE)",
"name": "Equatorial Guinean ekwele",
"symbol": "GQE"
},
"grd": {
"code": "GRD",
"code_symbol_string": "GRD (GRD)",
"name": "Greek drachma",
"symbol": "GRD"
},
"gtq": {
"code": "GTQ",
"code_symbol_string": "GTQ (Q)",
"name": "Guatemalan quetzal",
"symbol": "Q"
},
"gwe": {
"code": "GWE",
"code_symbol_string": "GWE (GWE)",
"name": "Portuguese Guinea escudo",
"symbol": "GWE"
},
"gwp": {
"code": "GWP",
"code_symbol_string": "GWP (GWP)",
"name": "Guinea-Bissau peso",
"symbol": "GWP"
},
"gyd": {
"code": "GYD",
"code_symbol_string": "GYD ($)",
"name": "Guyanaese dollar",
"symbol": "$"
},
"hkd": {
"code": "HKD",
"code_symbol_string": "HKD ($)",
"name": "Hong Kong dollar",
"symbol": "$"
},
"hnl": {
"code": "HNL",
"code_symbol_string": "HNL (L)",
"name": "Honduran lempira",
"symbol": "L"
},
"hrd": {
"code": "HRD",
"code_symbol_string": "HRD (HRD)",
"name": "Croatian dinar",
"symbol": "HRD"
},
"hrk": {
"code": "HRK",
"code_symbol_string": "HRK (kn)",
"name": "Croatian kuna",
"symbol": "kn"
},
"htg": {
"code": "HTG",
"code_symbol_string": "HTG (HTG)",
"name": "Haitian gourde",
"symbol": "HTG"
},
"huf": {
"code": "HUF",
"code_symbol_string": "HUF (Ft)",
"name": "Hungarian forint",
"symbol": "Ft"
},
"idr": {
"code": "IDR",
"code_symbol_string": "IDR (Rp)",
"name": "Indonesian rupiah",
"symbol": "Rp"
},
"iep": {
"code": "IEP",
"code_symbol_string": "IEP (IEP)",
"name": "Irish pound",
"symbol": "IEP"
},
"ilp": {
"code": "ILP",
"code_symbol_string": "ILP (ILP)",
"name": "Israeli pound",
"symbol": "ILP"
},
"ilr": {
"code": "ILR",
"code_symbol_string": "ILR (ILR)",
"name": "Israeli sheqel (1980–1985)",
"symbol": "ILR"
},
"ils": {
"code": "ILS",
"code_symbol_string": "ILS (₪)",
"name": "Israeli new sheqel",
"symbol": "₪"
},
"inr": {
"code": "INR",
"code_symbol_string": "INR (₨)",
"name": "Indian rupee",
"symbol": "₨"
},
"iqd": {
"code": "IQD",
"code_symbol_string": "IQD (IQD)",
"name": "Iraqi dinar",
"symbol": "IQD"
},
"irr": {
"code": "IRR",
"code_symbol_string": "IRR (﷼)",
"name": "Iranian rial",
"symbol": "﷼"
},
"isj": {
"code": "ISJ",
"code_symbol_string": "ISJ (ISJ)",
"name": "Icelandic króna (1918–1981)",
"symbol": "ISJ"
},
"isk": {
"code": "ISK",
"code_symbol_string": "ISK (kr)",
"name": "Icelandic króna",
"symbol": "kr"
},
"itl": {
"code": "ITL",
"code_symbol_string": "ITL (ITL)",
"name": "Italian lira",
"symbol": "ITL"
},
"jmd": {
"code": "JMD",
"code_symbol_string": "JMD ($)",
"name": "Jamaican dollar",
"symbol": "$"
},
"jod": {
"code": "JOD",
"code_symbol_string": "JOD (JOD)",
"name": "Jordanian dinar",
"symbol": "JOD"
},
"jpy": {
"code": "JPY",
"code_symbol_string": "JPY (¥)",
"name": "Japanese yen",
"symbol": "¥"
},
"kes": {
"code": "KES",
"code_symbol_string": "KES (KES)",
"name": "Kenyan shilling",
"symbol": "KES"
},
"kgs": {
"code": "KGS",
"code_symbol_string": "KGS (лв)",
"name": "Kyrgystani som",
"symbol": "лв"
},
"khr": {
"code": "KHR",
"code_symbol_string": "KHR (៛)",
"name": "Cambodian riel",
"symbol": "៛"
},
"kmf": {
"code": "KMF",
"code_symbol_string": "KMF (CF)",
"name": "Comorian franc",
"symbol": "CF"
},
"kpw": {
"code": "KPW",
"code_symbol_string": "KPW (₩)",
"name": "North Korean won",
"symbol": "₩"
},
"krh": {
"code": "KRH",
"code_symbol_string": "KRH (KRH)",
"name": "South Korean hwan (1953–1962)",
"symbol": "KRH"
},
"kro": {
"code": "KRO",
"code_symbol_string": "KRO (KRO)",
"name": "South Korean won (1945–1953)",
"symbol": "KRO"
},
"krw": {
"code": "KRW",
"code_symbol_string": "KRW (₩)",
"name": "South Korean won",
"symbol": "₩"
},
"kwd": {
"code": "KWD",
"code_symbol_string": "KWD (KWD)",
"name": "Kuwaiti dinar",
"symbol": "KWD"
},
"kyd": {
"code": "KYD",
"code_symbol_string": "KYD ($)",
"name": "Cayman Islands dollar",
"symbol": "$"
},
"kzt": {
"code": "KZT",
"code_symbol_string": "KZT (лв)",
"name": "Kazakhstani tenge",
"symbol": "лв"
},
"lak": {
"code": "LAK",
"code_symbol_string": "LAK (₭)",
"name": "Laotian kip",
"symbol": "₭"
},
"lbp": {
"code": "LBP",
"code_symbol_string": "LBP (£)",
"name": "Lebanese pound",
"symbol": "£"
},
"lkr": {
"code": "LKR",
"code_symbol_string": "LKR (₨)",
"name": "Sri Lankan rupee",
"symbol": "₨"
},
"lrd": {
"code": "LRD",
"code_symbol_string": "LRD ($)",
"name": "Liberian dollar",
"symbol": "$"
},
"lsl": {
"code": "LSL",
"code_symbol_string": "LSL (LSL)",
"name": "Lesotho loti",
"symbol": "LSL"
},
"ltl": {
"code": "LTL",
"code_symbol_string": "LTL (Lt)",
"name": "Lithuanian litas",
"symbol": "Lt"
},
"ltt": {
"code": "LTT",
"code_symbol_string": "LTT (LTT)",
"name": "Lithuanian talonas",
"symbol": "LTT"
},
"luc": {
"code": "LUC",
"code_symbol_string": "LUC (LUC)",
"name": "Luxembourgian convertible franc",
"symbol": "LUC"
},
"luf": {
"code": "LUF",
"code_symbol_string": "LUF (LUF)",
"name": "Luxembourgian franc",
"symbol": "LUF"
},
"lul": {
"code": "LUL",
"code_symbol_string": "LUL (LUL)",
"name": "Luxembourg financial franc",
"symbol": "LUL"
},
"lvl": {
"code": "LVL",
"code_symbol_string": "LVL (Ls)",
"name": "Latvian lats",
"symbol": "Ls"
},
"lvr": {
"code": "LVR",
"code_symbol_string": "LVR (LVR)",
"name": "Latvian ruble",
"symbol": "LVR"
},
"lyd": {
"code": "LYD",
"code_symbol_string": "LYD (LYD)",
"name": "Libyan dinar",
"symbol": "LYD"
},
"mad": {
"code": "MAD",
"code_symbol_string": "MAD (MAD)",
"name": "Moroccan dirham",
"symbol": "MAD"
},
"maf": {
"code": "MAF",
"code_symbol_string": "MAF (MAF)",
"name": "Moroccan franc",
"symbol": "MAF"
},
"mcf": {
"code": "MCF",
"code_symbol_string": "MCF (MCF)",
"name": "Monegasque franc",
"symbol": "MCF"
},
"mdc": {
"code": "MDC",
"code_symbol_string": "MDC (MDC)",
"name": "Moldovan cupon",
"symbol": "MDC"
},
"mdl": {
"code": "MDL",
"code_symbol_string": "MDL (MDL)",
"name": "Moldovan leu",
"symbol": "MDL"
},
"mga": {
"code": "MGA",
"code_symbol_string": "MGA (Ar)",
"name": "Malagasy ariary",
"symbol": "Ar"
},
"mgf": {
"code": "MGF",
"code_symbol_string": "MGF (MGF)",
"name": "Malagasy franc",
"symbol": "MGF"
},
"mkd": {
"code": "MKD",
"code_symbol_string": "MKD (MKD)",
"name": "Macedonian denar",
"symbol": "MKD"
},
"mkn": {
"code": "MKN",
"code_symbol_string": "MKN (MKN)",
"name": "Macedonian denar (1992–1993)",
"symbol": "MKN"
},
"mlf": {
"code": "MLF",
"code_symbol_string": "MLF (MLF)",
"name": "Malian franc",
"symbol": "MLF"
},
"mmk": {
"code": "MMK",
"code_symbol_string": "MMK (K)",
"name": "Myanmar kyat",
"symbol": "K"
},
"mnt": {
"code": "MNT",
"code_symbol_string": "MNT (₮)",
"name": "Mongolian tugrik",
"symbol": "₮"
},
"mop": {
"code": "MOP",
"code_symbol_string": "MOP (MOP)",
"name": "Macanese pataca",
"symbol": "MOP"
},
"mro": {
"code": "MRO",
"code_symbol_string": "MRO (MRO)",
"name": "Mauritanian ouguiya",
"symbol": "MRO"
},
"mtl": {
"code": "MTL",
"code_symbol_string": "MTL (MTL)",
"name": "Maltese lira",
"symbol": "MTL"
},
"mtp": {
"code": "MTP",
"code_symbol_string": "MTP (MTP)",
"name": "Maltese pound",
"symbol": "MTP"
},
"mur": {
"code": "MUR",
"code_symbol_string": "MUR (₨)",
"name": "Mauritian rupee",
"symbol": "₨"
},
"mvp": {
"code": "MVP",
"code_symbol_string": "MVP (MVP)",
"name": "Maldivian rupee (1947–1981)",
"symbol": "MVP"
},
"mvr": {
"code": "MVR",
"code_symbol_string": "MVR (MVR)",
"name": "Maldivian rufiyaa",
"symbol": "MVR"
},
"mwk": {
"code": "MWK",
"code_symbol_string": "MWK (MWK)",
"name": "Malawian kwacha",
"symbol": "MWK"
},
"mxn": {
"code": "MXN",
"code_symbol_string": "MXN ($)",
"name": "Mexican peso",
"symbol": "$"
},
"mxp": {
"code": "MXP",
"code_symbol_string": "MXP (MXP)",
"name": "Mexican silver peso (1861–1992)",
"symbol": "MXP"
},
"mxv": {
"code": "MXV",
"code_symbol_string": "MXV (MXV)",
"name": "Mexican investment unit",
"symbol": "MXV"
},
"myr": {
"code": "MYR",
"code_symbol_string": "MYR (RM)",
"name": "Malaysian ringgit",
"symbol": "RM"
},
"mze": {
"code": "MZE",
"code_symbol_string": "MZE (MZE)",
"name": "Mozambican escudo",
"symbol": "MZE"
},
"mzm": {
"code": "MZM",
"code_symbol_string": "MZM (MZM)",
"name": "Mozambican metical (1980–2006)",
"symbol": "MZM"
},
"mzn": {
"code": "MZN",
"code_symbol_string": "MZN (MT)",
"name": "Mozambican metical",
"symbol": "MT"
},
"nad": {
"code": "NAD",
"code_symbol_string": "NAD ($)",
"name": "Namibian dollar",
"symbol": "$"
},
"ngn": {
"code": "NGN",
"code_symbol_string": "NGN (₦)",
"name": "Nigerian naira",
"symbol": "₦"
},
"nic": {
"code": "NIC",
"code_symbol_string": "NIC (NIC)",
"name": "Nicaraguan córdoba (1988–1991)",
"symbol": "NIC"
},
"nio": {
"code": "NIO",
"code_symbol_string": "NIO (C$)",
"name": "Nicaraguan córdoba",
"symbol": "C$"
},
"nlg": {
"code": "NLG",
"code_symbol_string": "NLG (NLG)",
"name": "Dutch guilder",
"symbol": "NLG"
},
"nok": {
"code": "NOK",
"code_symbol_string": "NOK (kr)",
"name": "Norwegian krone",
"symbol": "kr"
},
"npr": {
"code": "NPR",
"code_symbol_string": "NPR (₨)",
"name": "Nepalese rupee",
"symbol": "₨"
},
"nzd": {
"code": "NZD",
"code_symbol_string": "NZD ($)",
"name": "New Zealand dollar",
"symbol": "$"
},
"omr": {
"code": "OMR",
"code_symbol_string": "OMR (﷼)",
"name": "Omani rial",
"symbol": "﷼"
},
"pab": {
"code": "PAB",
"code_symbol_string": "PAB (B/.)",
"name": "Panamanian balboa",
"symbol": "B/."
},
"pei": {
"code": "PEI",
"code_symbol_string": "PEI (PEI)",
"name": "Peruvian inti",
"symbol": "PEI"
},
"pen": {
"code": "PEN",
"code_symbol_string": "PEN (S/.)",
"name": "Peruvian nuevo sol",
"symbol": "S/."
},
"pes": {
"code": "PES",
"code_symbol_string": "PES (PES)",
"name": "Peruvian sol (1863–1965)",
"symbol": "PES"
},
"pgk": {
"code": "PGK",
"code_symbol_string": "PGK (PGK)",
"name": "Papua New Guinean kina",
"symbol": "PGK"
},
"php": {
"code": "PHP",
"code_symbol_string": "PHP (Php)",
"name": "Philippine peso",
"symbol": "Php"
},
"pkr": {
"code": "PKR",
"code_symbol_string": "PKR (₨)",
"name": "Pakistani rupee",
"symbol": "₨"
},
"pln": {
"code": "PLN",
"code_symbol_string": "PLN (zł)",
"name": "Polish zloty",
"symbol": "zł"
},
"plz": {
"code": "PLZ",
"code_symbol_string": "PLZ (PLZ)",
"name": "Polish zloty (PLZ)",
"symbol": "PLZ"
},
"pte": {
"code": "PTE",
"code_symbol_string": "PTE (PTE)",
"name": "Portuguese escudo",
"symbol": "PTE"
},
"pyg": {
"code": "PYG",
"code_symbol_string": "PYG (Gs)",
"name": "Paraguayan guarani",
"symbol": "Gs"
},
"qar": {
"code": "QAR",
"code_symbol_string": "QAR (﷼)",
"name": "Qatari rial",
"symbol": "﷼"
},
"rhd": {
"code": "RHD",
"code_symbol_string": "RHD (RHD)",
"name": "Rhodesian dollar",
"symbol": "RHD"
},
"rol": {
"code": "ROL",
"code_symbol_string": "ROL (ROL)",
"name": "Romanian leu (1952–2006)",
"symbol": "ROL"
},
"ron": {
"code": "RON",
"code_symbol_string": "RON (lei)",
"name": "Romanian leu",
"symbol": "lei"
},
"rsd": {
"code": "RSD",
"code_symbol_string": "RSD (Дин.)",
"name": "Serbian dinar",
"symbol": "Дин."
},
"rub": {
"code": "RUB",
"code_symbol_string": "RUB (руб)",
"name": "Russian ruble",
"symbol": "руб"
},
"rur": {
"code": "RUR",
"code_symbol_string": "RUR (р.)",
"name": "Russian ruble (1991–1998)",
"symbol": "р."
},
"rwf": {
"code": "RWF",
"code_symbol_string": "RWF (RF)",
"name": "Rwandan franc",
"symbol": "RF"
},
"sar": {
"code": "SAR",
"code_symbol_string": "SAR (﷼)",
"name": "Saudi riyal",
"symbol": "﷼"
},
"sbd": {
"code": "SBD",
"code_symbol_string": "SBD ($)",
"name": "Solomon Islands dollar",
"symbol": "$"
},
"scr": {
"code": "SCR",
"code_symbol_string": "SCR (₨)",
"name": "Seychellois rupee",
"symbol": "₨"
},
"sdd": {
"code": "SDD",
"code_symbol_string": "SDD (SDD)",
"name": "Sudanese dinar (1992–2007)",
"symbol": "SDD"
},
"sdg": {
"code": "SDG",
"code_symbol_string": "SDG (SDG)",
"name": "Sudanese pound",
"symbol": "SDG"
},
"sdp": {
"code": "SDP",
"code_symbol_string": "SDP (SDP)",
"name": "Sudanese pound (1957–1998)",
"symbol": "SDP"
},
"sek": {
"code": "SEK",
"code_symbol_string": "SEK (kr)",
"name": "Swedish krona",
"symbol": "kr"
},
"sgd": {
"code": "SGD",
"code_symbol_string": "SGD ($)",
"name": "Singapore dollar",
"symbol": "$"
},
"shp": {
"code": "SHP",
"code_symbol_string": "SHP (£)",
"name": "St. Helena pound",
"symbol": "£"
},
"sit": {
"code": "SIT",
"code_symbol_string": "SIT (SIT)",
"name": "Slovenian tolar",
"symbol": "SIT"
},
"skk": {
"code": "SKK",
"code_symbol_string": "SKK (SKK)",
"name": "Slovak koruna",
"symbol": "SKK"
},
"sll": {
"code": "SLL",
"code_symbol_string": "SLL (SLL)",
"name": "Sierra Leonean leone",
"symbol": "SLL"
},
"sos": {
"code": "SOS",
"code_symbol_string": "SOS (S)",
"name": "Somali shilling",
"symbol": "S"
},
"srd": {
"code": "SRD",
"code_symbol_string": "SRD ($)",
"name": "Surinamese dollar",
"symbol": "$"
},
"srg": {
"code": "SRG",
"code_symbol_string": "SRG (SRG)",
"name": "Surinamese guilder",
"symbol": "SRG"
},
"ssp": {
"code": "SSP",
"code_symbol_string": "SSP (£)",
"name": "South Sudanese pound",
"symbol": "£"
},
"std": {
"code": "STD",
"code_symbol_string": "STD (Db)",
"name": "São Tomé & Príncipe dobra",
"symbol": "Db"
},
"sur": {
"code": "SUR",
"code_symbol_string": "SUR (SUR)",
"name": "Soviet rouble",
"symbol": "SUR"
},
"svc": {
"code": "SVC",
"code_symbol_string": "SVC (SVC)",
"name": "Salvadoran colón",
"symbol": "SVC"
},
"syp": {
"code": "SYP",
"code_symbol_string": "SYP (£)",
"name": "Syrian pound",
"symbol": "£"
},
"szl": {
"code": "SZL",
"code_symbol_string": "SZL (SZL)",
"name": "Swazi lilangeni",
"symbol": "SZL"
},
"thb": {
"code": "THB",
"code_symbol_string": "THB (฿)",
"name": "Thai baht",
"symbol": "฿"
},
"tjr": {
"code": "TJR",
"code_symbol_string": "TJR (TJR)",
"name": "Tajikistani ruble",
"symbol": "TJR"
},
"tjs": {
"code": "TJS",
"code_symbol_string": "TJS (TJS)",
"name": "Tajikistani somoni",
"symbol": "TJS"
},
"tmm": {
"code": "TMM",
"code_symbol_string": "TMM (TMM)",
"name": "Turkmenistani manat (1993–2009)",
"symbol": "TMM"
},
"tmt": {
"code": "TMT",
"code_symbol_string": "TMT (TMT)",
"name": "Turkmenistani manat",
"symbol": "TMT"
},
"tnd": {
"code": "TND",
"code_symbol_string": "TND (TND)",
"name": "Tunisian dinar",
"symbol": "TND"
},
"top": {
"code": "TOP",
"code_symbol_string": "TOP (T$)",
"name": "Tongan paʻanga",
"symbol": "T$"
},
"tpe": {
"code": "TPE",
"code_symbol_string": "TPE (TPE)",
"name": "Timorese escudo",
"symbol": "TPE"
},
"trl": {
"code": "TRL",
"code_symbol_string": "TRL (TRL)",
"name": "Turkish lira (1922–2005)",
"symbol": "TRL"
},
"try": {
"code": "TRY",
"code_symbol_string": "TRY (TL)",
"name": "Turkish lira",
"symbol": "TL"
},
"ttd": {
"code": "TTD",
"code_symbol_string": "TTD ($)",
"name": "Trinidad & Tobago dollar",
"symbol": "$"
},
"twd": {
"code": "TWD",
"code_symbol_string": "TWD (NT$)",
"name": "New Taiwan dollar",
"symbol": "NT$"
},
"tzs": {
"code": "TZS",
"code_symbol_string": "TZS (TZS)",
"name": "Tanzanian shilling",
"symbol": "TZS"
},
"uah": {
"code": "UAH",
"code_symbol_string": "UAH (₴)",
"name": "Ukrainian hryvnia",
"symbol": "₴"
},
"uak": {
"code": "UAK",
"code_symbol_string": "UAK (UAK)",
"name": "Ukrainian karbovanets",
"symbol": "UAK"
},
"ugs": {
"code": "UGS",
"code_symbol_string": "UGS (UGS)",
"name": "Ugandan shilling (1966–1987)",
"symbol": "UGS"
},
"ugx": {
"code": "UGX",
"code_symbol_string": "UGX (UGX)",
"name": "Ugandan shilling",
"symbol": "UGX"
},
"usd": {
"code": "USD",
"code_symbol_string": "USD ($)",
"name": "US dollar",
"symbol": "$"
},
"usn": {
"code": "USN",
"code_symbol_string": "USN (USN)",
"name": "US dollar (next day)",
"symbol": "USN"
},
"uss": {
"code": "USS",
"code_symbol_string": "USS (USS)",
"name": "US dollar (same day)",
"symbol": "USS"
},
"uyi": {
"code": "UYI",
"code_symbol_string": "UYI (UYI)",
"name": "Uruguayan peso (indexed units)",
"symbol": "UYI"
},
"uyp": {
"code": "UYP",
"code_symbol_string": "UYP (UYP)",
"name": "Uruguayan peso (1975–1993)",
"symbol": "UYP"
},
"uyu": {
"code": "UYU",
"code_symbol_string": "UYU ($U)",
"name": "Uruguayan peso",
"symbol": "$U"
},
"uzs": {
"code": "UZS",
"code_symbol_string": "UZS (лв)",
"name": "Uzbekistani som",
"symbol": "лв"
},
"veb": {
"code": "VEB",
"code_symbol_string": "VEB (VEB)",
"name": "Venezuelan bolívar (1871–2008)",
"symbol": "VEB"
},
"vef": {
"code": "VEF",
"code_symbol_string": "VEF (Bs)",
"name": "Venezuelan bolívar",
"symbol": "Bs"
},
"vnd": {
"code": "VND",
"code_symbol_string": "VND (₫)",
"name": "Vietnamese dong",
"symbol": "₫"
},
"vnn": {
"code": "VNN",
"code_symbol_string": "VNN (VNN)",
"name": "Vietnamese dong (1978–1985)",
"symbol": "VNN"
},
"vuv": {
"code": "VUV",
"code_symbol_string": "VUV (VUV)",
"name": "Vanuatu vatu",
"symbol": "VUV"
},
"wst": {
"code": "WST",
"code_symbol_string": "WST (WST)",
"name": "Samoan tala",
"symbol": "WST"
},
"xaf": {
"code": "XAF",
"code_symbol_string": "XAF (FCFA)",
"name": "Central African CFA franc",
"symbol": "FCFA"
},
"xag": {
"code": "XAG",
"code_symbol_string": "XAG (XAG)",
"name": "troy ounce of silver",
"symbol": "XAG"
},
"xau": {
"code": "XAU",
"code_symbol_string": "XAU (XAU)",
"name": "troy ounce of gold",
"symbol": "XAU"
},
"xba": {
"code": "XBA",
"code_symbol_string": "XBA (XBA)",
"name": "European composite unit",
"symbol": "XBA"
},
"xbb": {
"code": "XBB",
"code_symbol_string": "XBB (XBB)",
"name": "European monetary unit",
"symbol": "XBB"
},
"xbc": {
"code": "XBC",
"code_symbol_string": "XBC (XBC)",
"name": "European unit of account (XBC)",
"symbol": "XBC"
},
"xbd": {
"code": "XBD",
"code_symbol_string": "XBD (XBD)",
"name": "European unit of account (XBD)",
"symbol": "XBD"
},
"xcd": {
"code": "XCD",
"code_symbol_string": "XCD ($)",
"name": "East Caribbean dollar",
"symbol": "$"
},
"xdr": {
"code": "XDR",
"code_symbol_string": "XDR (XDR)",
"name": "special drawing rights",
"symbol": "XDR"
},
"xeu": {
"code": "XEU",
"code_symbol_string": "XEU (XEU)",
"name": "European currency unit",
"symbol": "XEU"
},
"xfo": {
"code": "XFO",
"code_symbol_string": "XFO (XFO)",
"name": "French gold franc",
"symbol": "XFO"
},
"xfu": {
"code": "XFU",
"code_symbol_string": "XFU (XFU)",
"name": "French UIC-franc",
"symbol": "XFU"
},
"xof": {
"code": "XOF",
"code_symbol_string": "XOF (CFA)",
"name": "West African CFA franc",
"symbol": "CFA"
},
"xpd": {
"code": "XPD",
"code_symbol_string": "XPD (XPD)",
"name": "troy ounce of palladium",
"symbol": "XPD"
},
"xpf": {
"code": "XPF",
"code_symbol_string": "XPF (CFPF)",
"name": "CFP franc",
"symbol": "CFPF"
},
"xpt": {
"code": "XPT",
"code_symbol_string": "XPT (XPT)",
"name": "troy ounce of platinum",
"symbol": "XPT"
},
"xre": {
"code": "XRE",
"code_symbol_string": "XRE (XRE)",
"name": "RINET Funds unit",
"symbol": "XRE"
},
"xsu": {
"code": "XSU",
"code_symbol_string": "XSU (XSU)",
"name": "Sucre",
"symbol": "XSU"
},
"xts": {
"code": "XTS",
"code_symbol_string": "XTS (XTS)",
"name": "Testing Currency unit",
"symbol": "XTS"
},
"xua": {
"code": "XUA",
"code_symbol_string": "XUA (XUA)",
"name": "ADB unit of account",
"symbol": "XUA"
},
"xxx": {
"code": "XXX",
"code_symbol_string": "XXX (XXX)",
"name": "(unknown unit of currency)",
"symbol": "XXX"
},
"ydd": {
"code": "YDD",
"code_symbol_string": "YDD (YDD)",
"name": "Yemeni dinar",
"symbol": "YDD"
},
"yer": {
"code": "YER",
"code_symbol_string": "YER (﷼)",
"name": "Yemeni rial",
"symbol": "﷼"
},
"yud": {
"code": "YUD",
"code_symbol_string": "YUD (YUD)",
"name": "Yugoslavian hard dinar (1966–1990)",
"symbol": "YUD"
},
"yum": {
"code": "YUM",
"code_symbol_string": "YUM (YUM)",
"name": "Yugoslavian new dinar (1994–2002)",
"symbol": "YUM"
},
"yun": {
"code": "YUN",
"code_symbol_string": "YUN (YUN)",
"name": "Yugoslavian convertible dinar (1990–1992)",
"symbol": "YUN"
},
"yur": {
"code": "YUR",
"code_symbol_string": "YUR (YUR)",
"name": "Yugoslavian reformed dinar (1992–1993)",
"symbol": "YUR"
},
"zal": {
"code": "ZAL",
"code_symbol_string": "ZAL (ZAL)",
"name": "South African rand (financial)",
"symbol": "ZAL"
},
"zar": {
"code": "ZAR",
"code_symbol_string": "ZAR (R)",
"name": "South African rand",
"symbol": "R"
},
"zmk": {
"code": "ZMK",
"code_symbol_string": "ZMK (ZMK)",
"name": "Zambian kwacha (1968–2012)",
"symbol": "ZMK"
},
"zmw": {
"code": "ZMW",
"code_symbol_string": "ZMW (ZK)",
"name": "Zambian kwacha",
"symbol": "ZK"
},
"zrn": {
"code": "ZRN",
"code_symbol_string": "ZRN (ZRN)",
"name": "Zairean new zaire (1993–1998)",
"symbol": "ZRN"
},
"zrz": {
"code": "ZRZ",
"code_symbol_string": "ZRZ (ZRZ)",
"name": "Zairean zaire (1971–1993)",
"symbol": "ZRZ"
},
"zwd": {
"code": "ZWD",
"code_symbol_string": "ZWD (Z$)",
"name": "Zimbabwean dollar (1980–2008)",
"symbol": "Z$"
},
"zwl": {
"code": "ZWL",
"code_symbol_string": "ZWL (ZWL)",
"name": "Zimbabwean dollar (2009)",
"symbol": "ZWL"
},
"zwr": {
"code": "ZWR",
"code_symbol_string": "ZWR (ZWR)",
"name": "Zimbabwean dollar (2008)",
"symbol": "ZWR"
}
},
"pledge_received": [
"Yes",
"No"
],
"activity_hashes": [
{
"id": "Call",
"value": "Call"
},
{
"id": "Appointment",
"value": "Appointment"
},
{
"id": "Email",
"value": "Email"
},
{
"id": "Text Message",
"value": "Text Message"
},
{
"id": "Facebook Message",
"value": "Facebook Message"
},
{
"id": "Letter",
"value": "Letter"
},
{
"id": "Newsletter - Physical",
"value": "Newsletter - Physical"
},
{
"id": "Newsletter - Email",
"value": "Newsletter - Email"
},
{
"id": "Pre Call Letter",
"value": "Pre Call Letter"
},
{
"id": "Reminder Letter",
"value": "Reminder Letter"
},
{
"id": "Support Letter",
"value": "Support Letter"
},
{
"id": "Thank",
"value": "Thank"
},
{
"id": "To Do",
"value": "To Do"
},
{
"id": "Talk to In Person",
"value": "Talk to In Person"
},
{
"id": "Prayer Request",
"value": "Prayer Request"
}
],
"assignable_likely_to_give_hashes": [
{
"id": "Least Likely",
"value": "Least Likely"
},
{
"id": "Likely",
"value": "Likely"
},
{
"id": "Most Likely",
"value": "Most Likely"
}
],
"assignable_location_hashes": [
{
"id": "Home",
"value": "Home"
},
{
"id": "Business",
"value": "Business"
},
{
"id": "Mailing",
"value": "Mailing"
},
{
"id": "Seasonal",
"value": "Seasonal"
},
{
"id": "Other",
"value": "Other"
},
{
"id": "Temporary",
"value": "Temporary"
},
{
"id": "Rep Address",
"value": "Rep Address"
}
],
"assignable_send_newsletter_hashes": [
{
"id": "Physical",
"value": "Physical"
},
{
"id": "Email",
"value": "Email"
},
{
"id": "Both",
"value": "Both"
},
{
"id": "None",
"value": "None"
}
],
"assignable_status_hashes": [
{
"id": "Never Contacted",
"value": "Never Contacted"
},
{
"id": "Ask in Future",
"value": "Ask in Future"
},
{
"id": "Cultivate Relationship",
"value": "Cultivate Relationship"
},
{
"id": "Contact for Appointment",
"value": "Contact for Appointment"
},
{
"id": "Appointment Scheduled",
"value": "Appointment Scheduled"
},
{
"id": "Call for Decision",
"value": "Call for Decision"
},
{
"id": "Partner - Financial",
"value": "Partner - Financial"
},
{
"id": "Partner - Special",
"value": "Partner - Special"
},
{
"id": "Partner - Pray",
"value": "Partner - Pray"
},
{
"id": "Not Interested",
"value": "Not Interested"
},
{
"id": "Unresponsive",
"value": "Unresponsive"
},
{
"id": "Never Ask",
"value": "Never Ask"
},
{
"id": "Research Abandoned",
"value": "Research Abandoned"
},
{
"id": "Expired Referral",
"value": "Expired Referral"
}
],
"bulk_update_option_hashes": {
"likely_to_give": [
{
"id": "Least Likely",
"value": "Least Likely"
},
{
"id": "Likely",
"value": "Likely"
},
{
"id": "Most Likely",
"value": "Most Likely"
}
],
"pledge_currency": [
{
"id": "AED",
"key": "AED",
"value": "AED (AED)"
},
{
"id": "AFN",
"key": "AFN",
"value": "AFN (؋)"
},
{
"id": "ALK",
"key": "ALK",
"value": "ALK (ALK)"
},
{
"id": "ALL",
"key": "ALL",
"value": "ALL (LEK)"
},
{
"id": "AMD",
"key": "AMD",
"value": "AMD (AMD)"
},
{
"id": "ANG",
"key": "ANG",
"value": "ANG (ƒ)"
},
{
"id": "AOA",
"key": "AOA",
"value": "AOA (Kz)"
},
{
"id": "AOK",
"key": "AOK",
"value": "AOK (AOK)"
},
{
"id": "AON",
"key": "AON",
"value": "AON (AON)"
},
{
"id": "AOR",
"key": "AOR",
"value": "AOR (AOR)"
},
{
"id": "ARA",
"key": "ARA",
"value": "ARA (ARA)"
},
{
"id": "ARL",
"key": "ARL",
"value": "ARL (ARL)"
},
{
"id": "ARM",
"key": "ARM",
"value": "ARM (ARM)"
},
{
"id": "ARP",
"key": "ARP",
"value": "ARP (ARP)"
},
{
"id": "ARS",
"key": "ARS",
"value": "ARS ($)"
},
{
"id": "ATS",
"key": "ATS",
"value": "ATS (ATS)"
},
{
"id": "AUD",
"key": "AUD",
"value": "AUD ($)"
},
{
"id": "AWG",
"key": "AWG",
"value": "AWG (ƒ)"
},
{
"id": "AZM",
"key": "AZM",
"value": "AZM (AZM)"
},
{
"id": "AZN",
"key": "AZN",
"value": "AZN (ман)"
},
{
"id": "BAD",
"key": "BAD",
"value": "BAD (BAD)"
},
{
"id": "BAM",
"key": "BAM",
"value": "BAM (KM)"
},
{
"id": "BAN",
"key": "BAN",
"value": "BAN (BAN)"
},
{
"id": "BBD",
"key": "BBD",
"value": "BBD ($)"
},
{
"id": "BDT",
"key": "BDT",
"value": "BDT (৳)"
},
{
"id": "BEC",
"key": "BEC",
"value": "BEC (BEC)"
},
{
"id": "BEF",
"key": "BEF",
"value": "BEF (BEF)"
},
{
"id": "BEL",
"key": "BEL",
"value": "BEL (BEL)"
},
{
"id": "BGL",
"key": "BGL",
"value": "BGL (BGL)"
},
{
"id": "BGM",
"key": "BGM",
"value": "BGM (BGM)"
},
{
"id": "BGN",
"key": "BGN",
"value": "BGN (лв)"
},
{
"id": "BGO",
"key": "BGO",
"value": "BGO (BGO)"
},
{
"id": "BHD",
"key": "BHD",
"value": "BHD (BHD)"
},
{
"id": "BIF",
"key": "BIF",
"value": "BIF (BIF)"
},
{
"id": "BMD",
"key": "BMD",
"value": "BMD ($)"
},
{
"id": "BND",
"key": "BND",
"value": "BND ($)"
},
{
"id": "BOB",
"key": "BOB",
"value": "BOB ($b)"
},
{
"id": "BOL",
"key": "BOL",
"value": "BOL (BOL)"
},
{
"id": "BOP",
"key": "BOP",
"value": "BOP (BOP)"
},
{
"id": "BOV",
"key": "BOV",
"value": "BOV (BOV)"
},
{
"id": "BRB",
"key": "BRB",
"value": "BRB (BRB)"
},
{
"id": "BRC",
"key": "BRC",
"value": "BRC (BRC)"
},
{
"id": "BRE",
"key": "BRE",
"value": "BRE (BRE)"
},
{
"id": "BRL",
"key": "BRL",
"value": "BRL (R$)"
},
{
"id": "BRN",
"key": "BRN",
"value": "BRN (BRN)"
},
{
"id": "BRR",
"key": "BRR",
"value": "BRR (BRR)"
},
{
"id": "BRZ",
"key": "BRZ",
"value": "BRZ (BRZ)"
},
{
"id": "BSD",
"key": "BSD",
"value": "BSD ($)"
},
{
"id": "BTN",
"key": "BTN",
"value": "BTN (BTN)"
},
{
"id": "BUK",
"key": "BUK",
"value": "BUK (BUK)"
},
{
"id": "BWP",
"key": "BWP",
"value": "BWP (P)"
},
{
"id": "BYB",
"key": "BYB",
"value": "BYB (BYB)"
},
{
"id": "BYR",
"key": "BYR",
"value": "BYR (p.)"
},
{
"id": "BZD",
"key": "BZD",
"value": "BZD (BZ$)"
},
{
"id": "CAD",
"key": "CAD",
"value": "CAD ($)"
},
{
"id": "CDF",
"key": "CDF",
"value": "CDF (CDF)"
},
{
"id": "CHE",
"key": "CHE",
"value": "CHE (CHE)"
},
{
"id": "CHF",
"key": "CHF",
"value": "CHF (CHF)"
},
{
"id": "CHW",
"key": "CHW",
"value": "CHW (CHW)"
},
{
"id": "CLE",
"key": "CLE",
"value": "CLE (CLE)"
},
{
"id": "CLF",
"key": "CLF",
"value": "CLF (CLF)"
},
{
"id": "CLP",
"key": "CLP",
"value": "CLP ($)"
},
{
"id": "CNX",
"key": "CNX",
"value": "CNX (CNX)"
},
{
"id": "CNY",
"key": "CNY",
"value": "CNY (¥)"
},
{
"id": "COP",
"key": "COP",
"value": "COP ($)"
},
{
"id": "COU",
"key": "COU",
"value": "COU (COU)"
},
{
"id": "CRC",
"key": "CRC",
"value": "CRC (₡)"
},
{
"id": "CSD",
"key": "CSD",
"value": "CSD (CSD)"
},
{
"id": "CSK",
"key": "CSK",
"value": "CSK (CSK)"
},
{
"id": "CUC",
"key": "CUC",
"value": "CUC ($)"
},
{
"id": "CUP",
"key": "CUP",
"value": "CUP (₱)"
},
{
"id": "CVE",
"key": "CVE",
"value": "CVE (CVE)"
},
{
"id": "CYP",
"key": "CYP",
"value": "CYP (CYP)"
},
{
"id": "CZK",
"key": "CZK",
"value": "CZK (Kč)"
},
{
"id": "DDM",
"key": "DDM",
"value": "DDM (DDM)"
},
{
"id": "DEM",
"key": "DEM",
"value": "DEM (DEM)"
},
{
"id": "DJF",
"key": "DJF",
"value": "DJF (DJF)"
},
{
"id": "DKK",
"key": "DKK",
"value": "DKK (kr)"
},
{
"id": "DOP",
"key": "DOP",
"value": "DOP (RD$)"
},
{
"id": "DZD",
"key": "DZD",
"value": "DZD (DZD)"
},
{
"id": "ECS",
"key": "ECS",
"value": "ECS (ECS)"
},
{
"id": "ECV",
"key": "ECV",
"value": "ECV (ECV)"
},
{
"id": "EEK",
"key": "EEK",
"value": "EEK (kr)"
},
{
"id": "EGP",
"key": "EGP",
"value": "EGP (£)"
},
{
"id": "ERN",
"key": "ERN",
"value": "ERN (ERN)"
},
{
"id": "ESA",
"key": "ESA",
"value": "ESA (ESA)"
},
{
"id": "ESB",
"key": "ESB",
"value": "ESB (ESB)"
},
{
"id": "ESP",
"key": "ESP",
"value": "ESP (₧)"
},
{
"id": "ETB",
"key": "ETB",
"value": "ETB (ETB)"
},
{
"id": "EUR",
"key": "EUR",
"value": "EUR (€)"
},
{
"id": "FIM",
"key": "FIM",
"value": "FIM (FIM)"
},
{
"id": "FJD",
"key": "FJD",
"value": "FJD ($)"
},
{
"id": "FKP",
"key": "FKP",
"value": "FKP (£)"
},
{
"id": "FRF",
"key": "FRF",
"value": "FRF (FRF)"
},
{
"id": "GBP",
"key": "GBP",
"value": "GBP (£)"
},
{
"id": "GEK",
"key": "GEK",
"value": "GEK (GEK)"
},
{
"id": "GEL",
"key": "GEL",
"value": "GEL (₾)"
},
{
"id": "GHC",
"key": "GHC",
"value": "GHC (GHC)"
},
{
"id": "GHS",
"key": "GHS",
"value": "GHS (¢)"
},
{
"id": "GIP",
"key": "GIP",
"value": "GIP (£)"
},
{
"id": "GMD",
"key": "GMD",
"value": "GMD (GMD)"
},
{
"id": "GNF",
"key": "GNF",
"value": "GNF (FG)"
},
{
"id": "GNS",
"key": "GNS",
"value": "GNS (GNS)"
},
{
"id": "GQE",
"key": "GQE",
"value": "GQE (GQE)"
},
{
"id": "GRD",
"key": "GRD",
"value": "GRD (GRD)"
},
{
"id": "GTQ",
"key": "GTQ",
"value": "GTQ (Q)"
},
{
"id": "GWE",
"key": "GWE",
"value": "GWE (GWE)"
},
{
"id": "GWP",
"key": "GWP",
"value": "GWP (GWP)"
},
{
"id": "GYD",
"key": "GYD",
"value": "GYD ($)"
},
{
"id": "HKD",
"key": "HKD",
"value": "HKD ($)"
},
{
"id": "HNL",
"key": "HNL",
"value": "HNL (L)"
},
{
"id": "HRD",
"key": "HRD",
"value": "HRD (HRD)"
},
{
"id": "HRK",
"key": "HRK",
"value": "HRK (kn)"
},
{
"id": "HTG",
"key": "HTG",
"value": "HTG (HTG)"
},
{
"id": "HUF",
"key": "HUF",
"value": "HUF (Ft)"
},
{
"id": "IDR",
"key": "IDR",
"value": "IDR (Rp)"
},
{
"id": "IEP",
"key": "IEP",
"value": "IEP (IEP)"
},
{
"id": "ILP",
"key": "ILP",
"value": "ILP (ILP)"
},
{
"id": "ILR",
"key": "ILR",
"value": "ILR (ILR)"
},
{
"id": "ILS",
"key": "ILS",
"value": "ILS (₪)"
},
{
"id": "INR",
"key": "INR",
"value": "INR (₨)"
},
{
"id": "IQD",
"key": "IQD",
"value": "IQD (IQD)"
},
{
"id": "IRR",
"key": "IRR",
"value": "IRR (﷼)"
},
{
"id": "ISJ",
"key": "ISJ",
"value": "ISJ (ISJ)"
},
{
"id": "ISK",
"key": "ISK",
"value": "ISK (kr)"
},
{
"id": "ITL",
"key": "ITL",
"value": "ITL (ITL)"
},
{
"id": "JMD",
"key": "JMD",
"value": "JMD ($)"
},
{
"id": "JOD",
"key": "JOD",
"value": "JOD (JOD)"
},
{
"id": "JPY",
"key": "JPY",
"value": "JPY (¥)"
},
{
"id": "KES",
"key": "KES",
"value": "KES (KES)"
},
{
"id": "KGS",
"key": "KGS",
"value": "KGS (лв)"
},
{
"id": "KHR",
"key": "KHR",
"value": "KHR (៛)"
},
{
"id": "KMF",
"key": "KMF",
"value": "KMF (CF)"
},
{
"id": "KPW",
"key": "KPW",
"value": "KPW (₩)"
},
{
"id": "KRH",
"key": "KRH",
"value": "KRH (KRH)"
},
{
"id": "KRO",
"key": "KRO",
"value": "KRO (KRO)"
},
{
"id": "KRW",
"key": "KRW",
"value": "KRW (₩)"
},
{
"id": "KWD",
"key": "KWD",
"value": "KWD (KWD)"
},
{
"id": "KYD",
"key": "KYD",
"value": "KYD ($)"
},
{
"id": "KZT",
"key": "KZT",
"value": "KZT (лв)"
},
{
"id": "LAK",
"key": "LAK",
"value": "LAK (₭)"
},
{
"id": "LBP",
"key": "LBP",
"value": "LBP (£)"
},
{
"id": "LKR",
"key": "LKR",
"value": "LKR (₨)"
},
{
"id": "LRD",
"key": "LRD",
"value": "LRD ($)"
},
{
"id": "LSL",
"key": "LSL",
"value": "LSL (LSL)"
},
{
"id": "LTL",
"key": "LTL",
"value": "LTL (Lt)"
},
{
"id": "LTT",
"key": "LTT",
"value": "LTT (LTT)"
},
{
"id": "LUC",
"key": "LUC",
"value": "LUC (LUC)"
},
{
"id": "LUF",
"key": "LUF",
"value": "LUF (LUF)"
},
{
"id": "LUL",
"key": "LUL",
"value": "LUL (LUL)"
},
{
"id": "LVL",
"key": "LVL",
"value": "LVL (Ls)"
},
{
"id": "LVR",
"key": "LVR",
"value": "LVR (LVR)"
},
{
"id": "LYD",
"key": "LYD",
"value": "LYD (LYD)"
},
{
"id": "MAD",
"key": "MAD",
"value": "MAD (MAD)"
},
{
"id": "MAF",
"key": "MAF",
"value": "MAF (MAF)"
},
{
"id": "MCF",
"key": "MCF",
"value": "MCF (MCF)"
},
{
"id": "MDC",
"key": "MDC",
"value": "MDC (MDC)"
},
{
"id": "MDL",
"key": "MDL",
"value": "MDL (MDL)"
},
{
"id": "MGA",
"key": "MGA",
"value": "MGA (Ar)"
},
{
"id": "MGF",
"key": "MGF",
"value": "MGF (MGF)"
},
{
"id": "MKD",
"key": "MKD",
"value": "MKD (MKD)"
},
{
"id": "MKN",
"key": "MKN",
"value": "MKN (MKN)"
},
{
"id": "MLF",
"key": "MLF",
"value": "MLF (MLF)"
},
{
"id": "MMK",
"key": "MMK",
"value": "MMK (K)"
},
{
"id": "MNT",
"key": "MNT",
"value": "MNT (₮)"
},
{
"id": "MOP",
"key": "MOP",
"value": "MOP (MOP)"
},
{
"id": "MRO",
"key": "MRO",
"value": "MRO (MRO)"
},
{
"id": "MTL",
"key": "MTL",
"value": "MTL (MTL)"
},
{
"id": "MTP",
"key": "MTP",
"value": "MTP (MTP)"
},
{
"id": "MUR",
"key": "MUR",
"value": "MUR (₨)"
},
{
"id": "MVP",
"key": "MVP",
"value": "MVP (MVP)"
},
{
"id": "MVR",
"key": "MVR",
"value": "MVR (MVR)"
},
{
"id": "MWK",
"key": "MWK",
"value": "MWK (MWK)"
},
{
"id": "MXN",
"key": "MXN",
"value": "MXN ($)"
},
{
"id": "MXP",
"key": "MXP",
"value": "MXP (MXP)"
},
{
"id": "MXV",
"key": "MXV",
"value": "MXV (MXV)"
},
{
"id": "MYR",
"key": "MYR",
"value": "MYR (RM)"
},
{
"id": "MZE",
"key": "MZE",
"value": "MZE (MZE)"
},
{
"id": "MZM",
"key": "MZM",
"value": "MZM (MZM)"
},
{
"id": "MZN",
"key": "MZN",
"value": "MZN (MT)"
},
{
"id": "NAD",
"key": "NAD",
"value": "NAD ($)"
},
{
"id": "NGN",
"key": "NGN",
"value": "NGN (₦)"
},
{
"id": "NIC",
"key": "NIC",
"value": "NIC (NIC)"
},
{
"id": "NIO",
"key": "NIO",
"value": "NIO (C$)"
},
{
"id": "NLG",
"key": "NLG",
"value": "NLG (NLG)"
},
{
"id": "NOK",
"key": "NOK",
"value": "NOK (kr)"
},
{
"id": "NPR",
"key": "NPR",
"value": "NPR (₨)"
},
{
"id": "NZD",
"key": "NZD",
"value": "NZD ($)"
},
{
"id": "OMR",
"key": "OMR",
"value": "OMR (﷼)"
},
{
"id": "PAB",
"key": "PAB",
"value": "PAB (B/.)"
},
{
"id": "PEI",
"key": "PEI",
"value": "PEI (PEI)"
},
{
"id": "PEN",
"key": "PEN",
"value": "PEN (S/.)"
},
{
"id": "PES",
"key": "PES",
"value": "PES (PES)"
},
{
"id": "PGK",
"key": "PGK",
"value": "PGK (PGK)"
},
{
"id": "PHP",
"key": "PHP",
"value": "PHP (Php)"
},
{
"id": "PKR",
"key": "PKR",
"value": "PKR (₨)"
},
{
"id": "PLN",
"key": "PLN",
"value": "PLN (zł)"
},
{
"id": "PLZ",
"key": "PLZ",
"value": "PLZ (PLZ)"
},
{
"id": "PTE",
"key": "PTE",
"value": "PTE (PTE)"
},
{
"id": "PYG",
"key": "PYG",
"value": "PYG (Gs)"
},
{
"id": "QAR",
"key": "QAR",
"value": "QAR (﷼)"
},
{
"id": "RHD",
"key": "RHD",
"value": "RHD (RHD)"
},
{
"id": "ROL",
"key": "ROL",
"value": "ROL (ROL)"
},
{
"id": "RON",
"key": "RON",
"value": "RON (lei)"
},
{
"id": "RSD",
"key": "RSD",
"value": "RSD (Дин.)"
},
{
"id": "RUB",
"key": "RUB",
"value": "RUB (руб)"
},
{
"id": "RUR",
"key": "RUR",
"value": "RUR (р.)"
},
{
"id": "RWF",
"key": "RWF",
"value": "RWF (RF)"
},
{
"id": "SAR",
"key": "SAR",
"value": "SAR (﷼)"
},
{
"id": "SBD",
"key": "SBD",
"value": "SBD ($)"
},
{
"id": "SCR",
"key": "SCR",
"value": "SCR (₨)"
},
{
"id": "SDD",
"key": "SDD",
"value": "SDD (SDD)"
},
{
"id": "SDG",
"key": "SDG",
"value": "SDG (SDG)"
},
{
"id": "SDP",
"key": "SDP",
"value": "SDP (SDP)"
},
{
"id": "SEK",
"key": "SEK",
"value": "SEK (kr)"
},
{
"id": "SGD",
"key": "SGD",
"value": "SGD ($)"
},
{
"id": "SHP",
"key": "SHP",
"value": "SHP (£)"
},
{
"id": "SIT",
"key": "SIT",
"value": "SIT (SIT)"
},
{
"id": "SKK",
"key": "SKK",
"value": "SKK (SKK)"
},
{
"id": "SLL",
"key": "SLL",
"value": "SLL (SLL)"
},
{
"id": "SOS",
"key": "SOS",
"value": "SOS (S)"
},
{
"id": "SRD",
"key": "SRD",
"value": "SRD ($)"
},
{
"id": "SRG",
"key": "SRG",
"value": "SRG (SRG)"
},
{
"id": "SSP",
"key": "SSP",
"value": "SSP (£)"
},
{
"id": "STD",
"key": "STD",
"value": "STD (Db)"
},
{
"id": "SUR",
"key": "SUR",
"value": "SUR (SUR)"
},
{
"id": "SVC",
"key": "SVC",
"value": "SVC (SVC)"
},
{
"id": "SYP",
"key": "SYP",
"value": "SYP (£)"
},
{
"id": "SZL",
"key": "SZL",
"value": "SZL (SZL)"
},
{
"id": "THB",
"key": "THB",
"value": "THB (฿)"
},
{
"id": "TJR",
"key": "TJR",
"value": "TJR (TJR)"
},
{
"id": "TJS",
"key": "TJS",
"value": "TJS (TJS)"
},
{
"id": "TMM",
"key": "TMM",
"value": "TMM (TMM)"
},
{
"id": "TMT",
"key": "TMT",
"value": "TMT (TMT)"
},
{
"id": "TND",
"key": "TND",
"value": "TND (TND)"
},
{
"id": "TOP",
"key": "TOP",
"value": "TOP (T$)"
},
{
"id": "TPE",
"key": "TPE",
"value": "TPE (TPE)"
},
{
"id": "TRL",
"key": "TRL",
"value": "TRL (TRL)"
},
{
"id": "TRY",
"key": "TRY",
"value": "TRY (TL)"
},
{
"id": "TTD",
"key": "TTD",
"value": "TTD ($)"
},
{
"id": "TWD",
"key": "TWD",
"value": "TWD (NT$)"
},
{
"id": "TZS",
"key": "TZS",
"value": "TZS (TZS)"
},
{
"id": "UAH",
"key": "UAH",
"value": "UAH (₴)"
},
{
"id": "UAK",
"key": "UAK",
"value": "UAK (UAK)"
},
{
"id": "UGS",
"key": "UGS",
"value": "UGS (UGS)"
},
{
"id": "UGX",
"key": "UGX",
"value": "UGX (UGX)"
},
{
"id": "USD",
"key": "USD",
"value": "USD ($)"
},
{
"id": "USN",
"key": "USN",
"value": "USN (USN)"
},
{
"id": "USS",
"key": "USS",
"value": "USS (USS)"
},
{
"id": "UYI",
"key": "UYI",
"value": "UYI (UYI)"
},
{
"id": "UYP",
"key": "UYP",
"value": "UYP (UYP)"
},
{
"id": "UYU",
"key": "UYU",
"value": "UYU ($U)"
},
{
"id": "UZS",
"key": "UZS",
"value": "UZS (лв)"
},
{
"id": "VEB",
"key": "VEB",
"value": "VEB (VEB)"
},
{
"id": "VEF",
"key": "VEF",
"value": "VEF (Bs)"
},
{
"id": "VND",
"key": "VND",
"value": "VND (₫)"
},
{
"id": "VNN",
"key": "VNN",
"value": "VNN (VNN)"
},
{
"id": "VUV",
"key": "VUV",
"value": "VUV (VUV)"
},
{
"id": "WST",
"key": "WST",
"value": "WST (WST)"
},
{
"id": "XAF",
"key": "XAF",
"value": "XAF (FCFA)"
},
{
"id": "XAG",
"key": "XAG",
"value": "XAG (XAG)"
},
{
"id": "XAU",
"key": "XAU",
"value": "XAU (XAU)"
},
{
"id": "XBA",
"key": "XBA",
"value": "XBA (XBA)"
},
{
"id": "XBB",
"key": "XBB",
"value": "XBB (XBB)"
},
{
"id": "XBC",
"key": "XBC",
"value": "XBC (XBC)"
},
{
"id": "XBD",
"key": "XBD",
"value": "XBD (XBD)"
},
{
"id": "XCD",
"key": "XCD",
"value": "XCD ($)"
},
{
"id": "XDR",
"key": "XDR",
"value": "XDR (XDR)"
},
{
"id": "XEU",
"key": "XEU",
"value": "XEU (XEU)"
},
{
"id": "XFO",
"key": "XFO",
"value": "XFO (XFO)"
},
{
"id": "XFU",
"key": "XFU",
"value": "XFU (XFU)"
},
{
"id": "XOF",
"key": "XOF",
"value": "XOF (CFA)"
},
{
"id": "XPD",
"key": "XPD",
"value": "XPD (XPD)"
},
{
"id": "XPF",
"key": "XPF",
"value": "XPF (CFPF)"
},
{
"id": "XPT",
"key": "XPT",
"value": "XPT (XPT)"
},
{
"id": "XRE",
"key": "XRE",
"value": "XRE (XRE)"
},
{
"id": "XSU",
"key": "XSU",
"value": "XSU (XSU)"
},
{
"id": "XTS",
"key": "XTS",
"value": "XTS (XTS)"
},
{
"id": "XUA",
"key": "XUA",
"value": "XUA (XUA)"
},
{
"id": "XXX",
"key": "XXX",
"value": "XXX (XXX)"
},
{
"id": "YDD",
"key": "YDD",
"value": "YDD (YDD)"
},
{
"id": "YER",
"key": "YER",
"value": "YER (﷼)"
},
{
"id": "YUD",
"key": "YUD",
"value": "YUD (YUD)"
},
{
"id": "YUM",
"key": "YUM",
"value": "YUM (YUM)"
},
{
"id": "YUN",
"key": "YUN",
"value": "YUN (YUN)"
},
{
"id": "YUR",
"key": "YUR",
"value": "YUR (YUR)"
},
{
"id": "ZAL",
"key": "ZAL",
"value": "ZAL (ZAL)"
},
{
"id": "ZAR",
"key": "ZAR",
"value": "ZAR (R)"
},
{
"id": "ZMK",
"key": "ZMK",
"value": "ZMK (ZMK)"
},
{
"id": "ZMW",
"key": "ZMW",
"value": "ZMW (ZK)"
},
{
"id": "ZRN",
"key": "ZRN",
"value": "ZRN (ZRN)"
},
{
"id": "ZRZ",
"key": "ZRZ",
"value": "ZRZ (ZRZ)"
},
{
"id": "ZWD",
"key": "ZWD",
"value": "ZWD (Z$)"
},
{
"id": "ZWL",
"key": "ZWL",
"value": "ZWL (ZWL)"
},
{
"id": "ZWR",
"key": "ZWR",
"value": "ZWR (ZWR)"
}
],
"pledge_received": [
{
"id": "Yes",
"value": "Yes"
},
{
"id": "No",
"value": "No"
}
],
"send_newsletter": [
{
"id": "Physical",
"value": "Physical"
},
{
"id": "Email",
"value": "Email"
},
{
"id": "Both",
"value": "Both"
},
{
"id": "None",
"value": "None"
}
],
"status": [
{
"id": "Never Contacted",
"value": "Never Contacted"
},
{
"id": "Ask in Future",
"value": "Ask in Future"
},
{
"id": "Cultivate Relationship",
"value": "Cultivate Relationship"
},
{
"id": "Contact for Appointment",
"value": "Contact for Appointment"
},
{
"id": "Appointment Scheduled",
"value": "Appointment Scheduled"
},
{
"id": "Call for Decision",
"value": "Call for Decision"
},
{
"id": "Partner - Financial",
"value": "Partner - Financial"
},
{
"id": "Partner - Special",
"value": "Partner - Special"
},
{
"id": "Partner - Pray",
"value": "Partner - Pray"
},
{
"id": "Not Interested",
"value": "Not Interested"
},
{
"id": "Unresponsive",
"value": "Unresponsive"
},
{
"id": "Never Ask",
"value": "Never Ask"
},
{
"id": "Research Abandoned",
"value": "Research Abandoned"
},
{
"id": "Expired Referral",
"value": "Expired Referral"
}
]
},
"notification_hashes": [
{
"id": "Partner missed a gift",
"key": "201d4cfb-45e7-420f-a5c4-135d2f979591",
"value": "Partner missed a gift"
},
{
"id": "Partner started giving",
"key": "e7bf6999-fc50-44fa-90fe-2a51fb63c3d7",
"value": "Partner started giving"
},
{
"id": "Partner gave a larger gift than commitment",
"key": "7c39a95c-4858-4079-9df3-a645c24f8f1f",
"value": "Partner gave a larger gift than commitment"
},
{
"id": "Partner gave a Special Gift",
"key": "6693844a-dbab-4e03-a5e3-122217e9593c",
"value": "Partner gave a Special Gift"
},
{
"id": "Partner gave less than commitment",
"key": "ea77e07e-1e59-4918-b73b-040ad64b461f",
"value": "Partner gave less than commitment"
},
{
"id": "Partner recontinued giving",
"key": "1f268c0c-27d6-448f-bbcc-6db70eb8be6a",
"value": "Partner recontinued giving"
},
{
"id": "Partner gave with commitment of semi-annual or more",
"key": "1a74ca83-485a-4d59-937d-b6a1756825b2",
"value": "Partner gave with commitment of semi-annual or more"
},
{
"id": "Partner have not had an attempted call logged in the past year",
"key": "e55f8a53-195a-40dc-a082-29a10d8c8794",
"value": "Partner have not had an attempted call logged in the past year"
},
{
"id": "Partner have not had a thank you note logged in the past year",
"key": "a5f87e17-f8bf-449b-a85e-f6551964bca4",
"value": "Partner have not had a thank you note logged in the past year"
},
{
"id": "Partner (semiannual, annual, etc) has an expected donation one month from now. Send them a reminder.",
"key": "0674ada5-be5e-40fa-a912-8c0d39ce3740",
"value": "Partner (semiannual, annual, etc) has an expected donation one month from now. Send them a reminder."
},
{
"id": "Contact is on the physical newsletter but has no mailing address.",
"key": "5012c75b-a5d5-48c7-9c61-120f44ee70a7",
"value": "Contact is on the physical newsletter but has no mailing address."
},
{
"id": "Contact is on the email newsletter but has no people with a valid email address.",
"key": "f39b4e18-5486-4ac2-a3aa-985beb165fa9",
"value": "Contact is on the email newsletter but has no people with a valid email address."
}
],
"notification_translated_hashes": [
{
"id": "Partner missed a gift",
"key": "201d4cfb-45e7-420f-a5c4-135d2f979591",
"value": "Partner missed a gift"
},
{
"id": "Partner started giving",
"key": "e7bf6999-fc50-44fa-90fe-2a51fb63c3d7",
"value": "Partner started giving"
},
{
"id": "Partner gave a larger gift than commitment",
"key": "7c39a95c-4858-4079-9df3-a645c24f8f1f",
"value": "Partner gave a larger gift than commitment"
},
{
"id": "Partner gave a Special Gift",
"key": "6693844a-dbab-4e03-a5e3-122217e9593c",
"value": "Partner gave a Special Gift"
},
{
"id": "Partner gave less than commitment",
"key": "ea77e07e-1e59-4918-b73b-040ad64b461f",
"value": "Partner gave less than commitment"
},
{
"id": "Partner recontinued giving",
"key": "1f268c0c-27d6-448f-bbcc-6db70eb8be6a",
"value": "Partner recontinued giving"
},
{
"id": "Partner gave with commitment of semi-annual or more",
"key": "1a74ca83-485a-4d59-937d-b6a1756825b2",
"value": "Partner gave with commitment of semi-annual or more"
},
{
"id": "Partner have not had an attempted call logged in the past year",
"key": "e55f8a53-195a-40dc-a082-29a10d8c8794",
"value": "Partner have not had an attempted call logged in the past year"
},
{
"id": "Partner have not had a thank you note logged in the past year",
"key": "a5f87e17-f8bf-449b-a85e-f6551964bca4",
"value": "Partner have not had a thank you note logged in the past year"
},
{
"id": "Partner (semiannual, annual, etc) has an expected donation one month from now. Send them a reminder.",
"key": "0674ada5-be5e-40fa-a912-8c0d39ce3740",
"value": "Partner (semiannual, annual, etc) has an expected donation one month from now. Send them a reminder."
},
{
"id": "Contact is on the physical newsletter but has no mailing address.",
"key": "5012c75b-a5d5-48c7-9c61-120f44ee70a7",
"value": "Contact is on the physical newsletter but has no mailing address."
},
{
"id": "Contact is on the email newsletter but has no people with a valid email address.",
"key": "f39b4e18-5486-4ac2-a3aa-985beb165fa9",
"value": "Contact is on the email newsletter but has no people with a valid email address."
}
],
"pledge_currency_hashes": [
{
"id": "AED",
"key": "AED",
"value": "AED (AED)"
},
{
"id": "AFN",
"key": "AFN",
"value": "AFN (؋)"
},
{
"id": "ALK",
"key": "ALK",
"value": "ALK (ALK)"
},
{
"id": "ALL",
"key": "ALL",
"value": "ALL (LEK)"
},
{
"id": "AMD",
"key": "AMD",
"value": "AMD (AMD)"
},
{
"id": "ANG",
"key": "ANG",
"value": "ANG (ƒ)"
},
{
"id": "AOA",
"key": "AOA",
"value": "AOA (Kz)"
},
{
"id": "AOK",
"key": "AOK",
"value": "AOK (AOK)"
},
{
"id": "AON",
"key": "AON",
"value": "AON (AON)"
},
{
"id": "AOR",
"key": "AOR",
"value": "AOR (AOR)"
},
{
"id": "ARA",
"key": "ARA",
"value": "ARA (ARA)"
},
{
"id": "ARL",
"key": "ARL",
"value": "ARL (ARL)"
},
{
"id": "ARM",
"key": "ARM",
"value": "ARM (ARM)"
},
{
"id": "ARP",
"key": "ARP",
"value": "ARP (ARP)"
},
{
"id": "ARS",
"key": "ARS",
"value": "ARS ($)"
},
{
"id": "ATS",
"key": "ATS",
"value": "ATS (ATS)"
},
{
"id": "AUD",
"key": "AUD",
"value": "AUD ($)"
},
{
"id": "AWG",
"key": "AWG",
"value": "AWG (ƒ)"
},
{
"id": "AZM",
"key": "AZM",
"value": "AZM (AZM)"
},
{
"id": "AZN",
"key": "AZN",
"value": "AZN (ман)"
},
{
"id": "BAD",
"key": "BAD",
"value": "BAD (BAD)"
},
{
"id": "BAM",
"key": "BAM",
"value": "BAM (KM)"
},
{
"id": "BAN",
"key": "BAN",
"value": "BAN (BAN)"
},
{
"id": "BBD",
"key": "BBD",
"value": "BBD ($)"
},
{
"id": "BDT",
"key": "BDT",
"value": "BDT (৳)"
},
{
"id": "BEC",
"key": "BEC",
"value": "BEC (BEC)"
},
{
"id": "BEF",
"key": "BEF",
"value": "BEF (BEF)"
},
{
"id": "BEL",
"key": "BEL",
"value": "BEL (BEL)"
},
{
"id": "BGL",
"key": "BGL",
"value": "BGL (BGL)"
},
{
"id": "BGM",
"key": "BGM",
"value": "BGM (BGM)"
},
{
"id": "BGN",
"key": "BGN",
"value": "BGN (лв)"
},
{
"id": "BGO",
"key": "BGO",
"value": "BGO (BGO)"
},
{
"id": "BHD",
"key": "BHD",
"value": "BHD (BHD)"
},
{
"id": "BIF",
"key": "BIF",
"value": "BIF (BIF)"
},
{
"id": "BMD",
"key": "BMD",
"value": "BMD ($)"
},
{
"id": "BND",
"key": "BND",
"value": "BND ($)"
},
{
"id": "BOB",
"key": "BOB",
"value": "BOB ($b)"
},
{
"id": "BOL",
"key": "BOL",
"value": "BOL (BOL)"
},
{
"id": "BOP",
"key": "BOP",
"value": "BOP (BOP)"
},
{
"id": "BOV",
"key": "BOV",
"value": "BOV (BOV)"
},
{
"id": "BRB",
"key": "BRB",
"value": "BRB (BRB)"
},
{
"id": "BRC",
"key": "BRC",
"value": "BRC (BRC)"
},
{
"id": "BRE",
"key": "BRE",
"value": "BRE (BRE)"
},
{
"id": "BRL",
"key": "BRL",
"value": "BRL (R$)"
},
{
"id": "BRN",
"key": "BRN",
"value": "BRN (BRN)"
},
{
"id": "BRR",
"key": "BRR",
"value": "BRR (BRR)"
},
{
"id": "BRZ",
"key": "BRZ",
"value": "BRZ (BRZ)"
},
{
"id": "BSD",
"key": "BSD",
"value": "BSD ($)"
},
{
"id": "BTN",
"key": "BTN",
"value": "BTN (BTN)"
},
{
"id": "BUK",
"key": "BUK",
"value": "BUK (BUK)"
},
{
"id": "BWP",
"key": "BWP",
"value": "BWP (P)"
},
{
"id": "BYB",
"key": "BYB",
"value": "BYB (BYB)"
},
{
"id": "BYR",
"key": "BYR",
"value": "BYR (p.)"
},
{
"id": "BZD",
"key": "BZD",
"value": "BZD (BZ$)"
},
{
"id": "CAD",
"key": "CAD",
"value": "CAD ($)"
},
{
"id": "CDF",
"key": "CDF",
"value": "CDF (CDF)"
},
{
"id": "CHE",
"key": "CHE",
"value": "CHE (CHE)"
},
{
"id": "CHF",
"key": "CHF",
"value": "CHF (CHF)"
},
{
"id": "CHW",
"key": "CHW",
"value": "CHW (CHW)"
},
{
"id": "CLE",
"key": "CLE",
"value": "CLE (CLE)"
},
{
"id": "CLF",
"key": "CLF",
"value": "CLF (CLF)"
},
{
"id": "CLP",
"key": "CLP",
"value": "CLP ($)"
},
{
"id": "CNX",
"key": "CNX",
"value": "CNX (CNX)"
},
{
"id": "CNY",
"key": "CNY",
"value": "CNY (¥)"
},
{
"id": "COP",
"key": "COP",
"value": "COP ($)"
},
{
"id": "COU",
"key": "COU",
"value": "COU (COU)"
},
{
"id": "CRC",
"key": "CRC",
"value": "CRC (₡)"
},
{
"id": "CSD",
"key": "CSD",
"value": "CSD (CSD)"
},
{
"id": "CSK",
"key": "CSK",
"value": "CSK (CSK)"
},
{
"id": "CUC",
"key": "CUC",
"value": "CUC ($)"
},
{
"id": "CUP",
"key": "CUP",
"value": "CUP (₱)"
},
{
"id": "CVE",
"key": "CVE",
"value": "CVE (CVE)"
},
{
"id": "CYP",
"key": "CYP",
"value": "CYP (CYP)"
},
{
"id": "CZK",
"key": "CZK",
"value": "CZK (Kč)"
},
{
"id": "DDM",
"key": "DDM",
"value": "DDM (DDM)"
},
{
"id": "DEM",
"key": "DEM",
"value": "DEM (DEM)"
},
{
"id": "DJF",
"key": "DJF",
"value": "DJF (DJF)"
},
{
"id": "DKK",
"key": "DKK",
"value": "DKK (kr)"
},
{
"id": "DOP",
"key": "DOP",
"value": "DOP (RD$)"
},
{
"id": "DZD",
"key": "DZD",
"value": "DZD (DZD)"
},
{
"id": "ECS",
"key": "ECS",
"value": "ECS (ECS)"
},
{
"id": "ECV",
"key": "ECV",
"value": "ECV (ECV)"
},
{
"id": "EEK",
"key": "EEK",
"value": "EEK (kr)"
},
{
"id": "EGP",
"key": "EGP",
"value": "EGP (£)"
},
{
"id": "ERN",
"key": "ERN",
"value": "ERN (ERN)"
},
{
"id": "ESA",
"key": "ESA",
"value": "ESA (ESA)"
},
{
"id": "ESB",
"key": "ESB",
"value": "ESB (ESB)"
},
{
"id": "ESP",
"key": "ESP",
"value": "ESP (₧)"
},
{
"id": "ETB",
"key": "ETB",
"value": "ETB (ETB)"
},
{
"id": "EUR",
"key": "EUR",
"value": "EUR (€)"
},
{
"id": "FIM",
"key": "FIM",
"value": "FIM (FIM)"
},
{
"id": "FJD",
"key": "FJD",
"value": "FJD ($)"
},
{
"id": "FKP",
"key": "FKP",
"value": "FKP (£)"
},
{
"id": "FRF",
"key": "FRF",
"value": "FRF (FRF)"
},
{
"id": "GBP",
"key": "GBP",
"value": "GBP (£)"
},
{
"id": "GEK",
"key": "GEK",
"value": "GEK (GEK)"
},
{
"id": "GEL",
"key": "GEL",
"value": "GEL (₾)"
},
{
"id": "GHC",
"key": "GHC",
"value": "GHC (GHC)"
},
{
"id": "GHS",
"key": "GHS",
"value": "GHS (¢)"
},
{
"id": "GIP",
"key": "GIP",
"value": "GIP (£)"
},
{
"id": "GMD",
"key": "GMD",
"value": "GMD (GMD)"
},
{
"id": "GNF",
"key": "GNF",
"value": "GNF (FG)"
},
{
"id": "GNS",
"key": "GNS",
"value": "GNS (GNS)"
},
{
"id": "GQE",
"key": "GQE",
"value": "GQE (GQE)"
},
{
"id": "GRD",
"key": "GRD",
"value": "GRD (GRD)"
},
{
"id": "GTQ",
"key": "GTQ",
"value": "GTQ (Q)"
},
{
"id": "GWE",
"key": "GWE",
"value": "GWE (GWE)"
},
{
"id": "GWP",
"key": "GWP",
"value": "GWP (GWP)"
},
{
"id": "GYD",
"key": "GYD",
"value": "GYD ($)"
},
{
"id": "HKD",
"key": "HKD",
"value": "HKD ($)"
},
{
"id": "HNL",
"key": "HNL",
"value": "HNL (L)"
},
{
"id": "HRD",
"key": "HRD",
"value": "HRD (HRD)"
},
{
"id": "HRK",
"key": "HRK",
"value": "HRK (kn)"
},
{
"id": "HTG",
"key": "HTG",
"value": "HTG (HTG)"
},
{
"id": "HUF",
"key": "HUF",
"value": "HUF (Ft)"
},
{
"id": "IDR",
"key": "IDR",
"value": "IDR (Rp)"
},
{
"id": "IEP",
"key": "IEP",
"value": "IEP (IEP)"
},
{
"id": "ILP",
"key": "ILP",
"value": "ILP (ILP)"
},
{
"id": "ILR",
"key": "ILR",
"value": "ILR (ILR)"
},
{
"id": "ILS",
"key": "ILS",
"value": "ILS (₪)"
},
{
"id": "INR",
"key": "INR",
"value": "INR (₨)"
},
{
"id": "IQD",
"key": "IQD",
"value": "IQD (IQD)"
},
{
"id": "IRR",
"key": "IRR",
"value": "IRR (﷼)"
},
{
"id": "ISJ",
"key": "ISJ",
"value": "ISJ (ISJ)"
},
{
"id": "ISK",
"key": "ISK",
"value": "ISK (kr)"
},
{
"id": "ITL",
"key": "ITL",
"value": "ITL (ITL)"
},
{
"id": "JMD",
"key": "JMD",
"value": "JMD ($)"
},
{
"id": "JOD",
"key": "JOD",
"value": "JOD (JOD)"
},
{
"id": "JPY",
"key": "JPY",
"value": "JPY (¥)"
},
{
"id": "KES",
"key": "KES",
"value": "KES (KES)"
},
{
"id": "KGS",
"key": "KGS",
"value": "KGS (лв)"
},
{
"id": "KHR",
"key": "KHR",
"value": "KHR (៛)"
},
{
"id": "KMF",
"key": "KMF",
"value": "KMF (CF)"
},
{
"id": "KPW",
"key": "KPW",
"value": "KPW (₩)"
},
{
"id": "KRH",
"key": "KRH",
"value": "KRH (KRH)"
},
{
"id": "KRO",
"key": "KRO",
"value": "KRO (KRO)"
},
{
"id": "KRW",
"key": "KRW",
"value": "KRW (₩)"
},
{
"id": "KWD",
"key": "KWD",
"value": "KWD (KWD)"
},
{
"id": "KYD",
"key": "KYD",
"value": "KYD ($)"
},
{
"id": "KZT",
"key": "KZT",
"value": "KZT (лв)"
},
{
"id": "LAK",
"key": "LAK",
"value": "LAK (₭)"
},
{
"id": "LBP",
"key": "LBP",
"value": "LBP (£)"
},
{
"id": "LKR",
"key": "LKR",
"value": "LKR (₨)"
},
{
"id": "LRD",
"key": "LRD",
"value": "LRD ($)"
},
{
"id": "LSL",
"key": "LSL",
"value": "LSL (LSL)"
},
{
"id": "LTL",
"key": "LTL",
"value": "LTL (Lt)"
},
{
"id": "LTT",
"key": "LTT",
"value": "LTT (LTT)"
},
{
"id": "LUC",
"key": "LUC",
"value": "LUC (LUC)"
},
{
"id": "LUF",
"key": "LUF",
"value": "LUF (LUF)"
},
{
"id": "LUL",
"key": "LUL",
"value": "LUL (LUL)"
},
{
"id": "LVL",
"key": "LVL",
"value": "LVL (Ls)"
},
{
"id": "LVR",
"key": "LVR",
"value": "LVR (LVR)"
},
{
"id": "LYD",
"key": "LYD",
"value": "LYD (LYD)"
},
{
"id": "MAD",
"key": "MAD",
"value": "MAD (MAD)"
},
{
"id": "MAF",
"key": "MAF",
"value": "MAF (MAF)"
},
{
"id": "MCF",
"key": "MCF",
"value": "MCF (MCF)"
},
{
"id": "MDC",
"key": "MDC",
"value": "MDC (MDC)"
},
{
"id": "MDL",
"key": "MDL",
"value": "MDL (MDL)"
},
{
"id": "MGA",
"key": "MGA",
"value": "MGA (Ar)"
},
{
"id": "MGF",
"key": "MGF",
"value": "MGF (MGF)"
},
{
"id": "MKD",
"key": "MKD",
"value": "MKD (MKD)"
},
{
"id": "MKN",
"key": "MKN",
"value": "MKN (MKN)"
},
{
"id": "MLF",
"key": "MLF",
"value": "MLF (MLF)"
},
{
"id": "MMK",
"key": "MMK",
"value": "MMK (K)"
},
{
"id": "MNT",
"key": "MNT",
"value": "MNT (₮)"
},
{
"id": "MOP",
"key": "MOP",
"value": "MOP (MOP)"
},
{
"id": "MRO",
"key": "MRO",
"value": "MRO (MRO)"
},
{
"id": "MTL",
"key": "MTL",
"value": "MTL (MTL)"
},
{
"id": "MTP",
"key": "MTP",
"value": "MTP (MTP)"
},
{
"id": "MUR",
"key": "MUR",
"value": "MUR (₨)"
},
{
"id": "MVP",
"key": "MVP",
"value": "MVP (MVP)"
},
{
"id": "MVR",
"key": "MVR",
"value": "MVR (MVR)"
},
{
"id": "MWK",
"key": "MWK",
"value": "MWK (MWK)"
},
{
"id": "MXN",
"key": "MXN",
"value": "MXN ($)"
},
{
"id": "MXP",
"key": "MXP",
"value": "MXP (MXP)"
},
{
"id": "MXV",
"key": "MXV",
"value": "MXV (MXV)"
},
{
"id": "MYR",
"key": "MYR",
"value": "MYR (RM)"
},
{
"id": "MZE",
"key": "MZE",
"value": "MZE (MZE)"
},
{
"id": "MZM",
"key": "MZM",
"value": "MZM (MZM)"
},
{
"id": "MZN",
"key": "MZN",
"value": "MZN (MT)"
},
{
"id": "NAD",
"key": "NAD",
"value": "NAD ($)"
},
{
"id": "NGN",
"key": "NGN",
"value": "NGN (₦)"
},
{
"id": "NIC",
"key": "NIC",
"value": "NIC (NIC)"
},
{
"id": "NIO",
"key": "NIO",
"value": "NIO (C$)"
},
{
"id": "NLG",
"key": "NLG",
"value": "NLG (NLG)"
},
{
"id": "NOK",
"key": "NOK",
"value": "NOK (kr)"
},
{
"id": "NPR",
"key": "NPR",
"value": "NPR (₨)"
},
{
"id": "NZD",
"key": "NZD",
"value": "NZD ($)"
},
{
"id": "OMR",
"key": "OMR",
"value": "OMR (﷼)"
},
{
"id": "PAB",
"key": "PAB",
"value": "PAB (B/.)"
},
{
"id": "PEI",
"key": "PEI",
"value": "PEI (PEI)"
},
{
"id": "PEN",
"key": "PEN",
"value": "PEN (S/.)"
},
{
"id": "PES",
"key": "PES",
"value": "PES (PES)"
},
{
"id": "PGK",
"key": "PGK",
"value": "PGK (PGK)"
},
{
"id": "PHP",
"key": "PHP",
"value": "PHP (Php)"
},
{
"id": "PKR",
"key": "PKR",
"value": "PKR (₨)"
},
{
"id": "PLN",
"key": "PLN",
"value": "PLN (zł)"
},
{
"id": "PLZ",
"key": "PLZ",
"value": "PLZ (PLZ)"
},
{
"id": "PTE",
"key": "PTE",
"value": "PTE (PTE)"
},
{
"id": "PYG",
"key": "PYG",
"value": "PYG (Gs)"
},
{
"id": "QAR",
"key": "QAR",
"value": "QAR (﷼)"
},
{
"id": "RHD",
"key": "RHD",
"value": "RHD (RHD)"
},
{
"id": "ROL",
"key": "ROL",
"value": "ROL (ROL)"
},
{
"id": "RON",
"key": "RON",
"value": "RON (lei)"
},
{
"id": "RSD",
"key": "RSD",
"value": "RSD (Дин.)"
},
{
"id": "RUB",
"key": "RUB",
"value": "RUB (руб)"
},
{
"id": "RUR",
"key": "RUR",
"value": "RUR (р.)"
},
{
"id": "RWF",
"key": "RWF",
"value": "RWF (RF)"
},
{
"id": "SAR",
"key": "SAR",
"value": "SAR (﷼)"
},
{
"id": "SBD",
"key": "SBD",
"value": "SBD ($)"
},
{
"id": "SCR",
"key": "SCR",
"value": "SCR (₨)"
},
{
"id": "SDD",
"key": "SDD",
"value": "SDD (SDD)"
},
{
"id": "SDG",
"key": "SDG",
"value": "SDG (SDG)"
},
{
"id": "SDP",
"key": "SDP",
"value": "SDP (SDP)"
},
{
"id": "SEK",
"key": "SEK",
"value": "SEK (kr)"
},
{
"id": "SGD",
"key": "SGD",
"value": "SGD ($)"
},
{
"id": "SHP",
"key": "SHP",
"value": "SHP (£)"
},
{
"id": "SIT",
"key": "SIT",
"value": "SIT (SIT)"
},
{
"id": "SKK",
"key": "SKK",
"value": "SKK (SKK)"
},
{
"id": "SLL",
"key": "SLL",
"value": "SLL (SLL)"
},
{
"id": "SOS",
"key": "SOS",
"value": "SOS (S)"
},
{
"id": "SRD",
"key": "SRD",
"value": "SRD ($)"
},
{
"id": "SRG",
"key": "SRG",
"value": "SRG (SRG)"
},
{
"id": "SSP",
"key": "SSP",
"value": "SSP (£)"
},
{
"id": "STD",
"key": "STD",
"value": "STD (Db)"
},
{
"id": "SUR",
"key": "SUR",
"value": "SUR (SUR)"
},
{
"id": "SVC",
"key": "SVC",
"value": "SVC (SVC)"
},
{
"id": "SYP",
"key": "SYP",
"value": "SYP (£)"
},
{
"id": "SZL",
"key": "SZL",
"value": "SZL (SZL)"
},
{
"id": "THB",
"key": "THB",
"value": "THB (฿)"
},
{
"id": "TJR",
"key": "TJR",
"value": "TJR (TJR)"
},
{
"id": "TJS",
"key": "TJS",
"value": "TJS (TJS)"
},
{
"id": "TMM",
"key": "TMM",
"value": "TMM (TMM)"
},
{
"id": "TMT",
"key": "TMT",
"value": "TMT (TMT)"
},
{
"id": "TND",
"key": "TND",
"value": "TND (TND)"
},
{
"id": "TOP",
"key": "TOP",
"value": "TOP (T$)"
},
{
"id": "TPE",
"key": "TPE",
"value": "TPE (TPE)"
},
{
"id": "TRL",
"key": "TRL",
"value": "TRL (TRL)"
},
{
"id": "TRY",
"key": "TRY",
"value": "TRY (TL)"
},
{
"id": "TTD",
"key": "TTD",
"value": "TTD ($)"
},
{
"id": "TWD",
"key": "TWD",
"value": "TWD (NT$)"
},
{
"id": "TZS",
"key": "TZS",
"value": "TZS (TZS)"
},
{
"id": "UAH",
"key": "UAH",
"value": "UAH (₴)"
},
{
"id": "UAK",
"key": "UAK",
"value": "UAK (UAK)"
},
{
"id": "UGS",
"key": "UGS",
"value": "UGS (UGS)"
},
{
"id": "UGX",
"key": "UGX",
"value": "UGX (UGX)"
},
{
"id": "USD",
"key": "USD",
"value": "USD ($)"
},
{
"id": "USN",
"key": "USN",
"value": "USN (USN)"
},
{
"id": "USS",
"key": "USS",
"value": "USS (USS)"
},
{
"id": "UYI",
"key": "UYI",
"value": "UYI (UYI)"
},
{
"id": "UYP",
"key": "UYP",
"value": "UYP (UYP)"
},
{
"id": "UYU",
"key": "UYU",
"value": "UYU ($U)"
},
{
"id": "UZS",
"key": "UZS",
"value": "UZS (лв)"
},
{
"id": "VEB",
"key": "VEB",
"value": "VEB (VEB)"
},
{
"id": "VEF",
"key": "VEF",
"value": "VEF (Bs)"
},
{
"id": "VND",
"key": "VND",
"value": "VND (₫)"
},
{
"id": "VNN",
"key": "VNN",
"value": "VNN (VNN)"
},
{
"id": "VUV",
"key": "VUV",
"value": "VUV (VUV)"
},
{
"id": "WST",
"key": "WST",
"value": "WST (WST)"
},
{
"id": "XAF",
"key": "XAF",
"value": "XAF (FCFA)"
},
{
"id": "XAG",
"key": "XAG",
"value": "XAG (XAG)"
},
{
"id": "XAU",
"key": "XAU",
"value": "XAU (XAU)"
},
{
"id": "XBA",
"key": "XBA",
"value": "XBA (XBA)"
},
{
"id": "XBB",
"key": "XBB",
"value": "XBB (XBB)"
},
{
"id": "XBC",
"key": "XBC",
"value": "XBC (XBC)"
},
{
"id": "XBD",
"key": "XBD",
"value": "XBD (XBD)"
},
{
"id": "XCD",
"key": "XCD",
"value": "XCD ($)"
},
{
"id": "XDR",
"key": "XDR",
"value": "XDR (XDR)"
},
{
"id": "XEU",
"key": "XEU",
"value": "XEU (XEU)"
},
{
"id": "XFO",
"key": "XFO",
"value": "XFO (XFO)"
},
{
"id": "XFU",
"key": "XFU",
"value": "XFU (XFU)"
},
{
"id": "XOF",
"key": "XOF",
"value": "XOF (CFA)"
},
{
"id": "XPD",
"key": "XPD",
"value": "XPD (XPD)"
},
{
"id": "XPF",
"key": "XPF",
"value": "XPF (CFPF)"
},
{
"id": "XPT",
"key": "XPT",
"value": "XPT (XPT)"
},
{
"id": "XRE",
"key": "XRE",
"value": "XRE (XRE)"
},
{
"id": "XSU",
"key": "XSU",
"value": "XSU (XSU)"
},
{
"id": "XTS",
"key": "XTS",
"value": "XTS (XTS)"
},
{
"id": "XUA",
"key": "XUA",
"value": "XUA (XUA)"
},
{
"id": "XXX",
"key": "XXX",
"value": "XXX (XXX)"
},
{
"id": "YDD",
"key": "YDD",
"value": "YDD (YDD)"
},
{
"id": "YER",
"key": "YER",
"value": "YER (﷼)"
},
{
"id": "YUD",
"key": "YUD",
"value": "YUD (YUD)"
},
{
"id": "YUM",
"key": "YUM",
"value": "YUM (YUM)"
},
{
"id": "YUN",
"key": "YUN",
"value": "YUN (YUN)"
},
{
"id": "YUR",
"key": "YUR",
"value": "YUR (YUR)"
},
{
"id": "ZAL",
"key": "ZAL",
"value": "ZAL (ZAL)"
},
{
"id": "ZAR",
"key": "ZAR",
"value": "ZAR (R)"
},
{
"id": "ZMK",
"key": "ZMK",
"value": "ZMK (ZMK)"
},
{
"id": "ZMW",
"key": "ZMW",
"value": "ZMW (ZK)"
},
{
"id": "ZRN",
"key": "ZRN",
"value": "ZRN (ZRN)"
},
{
"id": "ZRZ",
"key": "ZRZ",
"value": "ZRZ (ZRZ)"
},
{
"id": "ZWD",
"key": "ZWD",
"value": "ZWD (Z$)"
},
{
"id": "ZWL",
"key": "ZWL",
"value": "ZWL (ZWL)"
},
{
"id": "ZWR",
"key": "ZWR",
"value": "ZWR (ZWR)"
}
],
"pledge_frequency_hashes": [
{
"id": "Weekly",
"key": "0.23076923076923",
"value": "Weekly"
},
{
"id": "Every 2 Weeks",
"key": "0.46153846153846",
"value": "Every 2 Weeks"
},
{
"id": "Monthly",
"key": "1.0",
"value": "Monthly"
},
{
"id": "Every 2 Months",
"key": "2.0",
"value": "Every 2 Months"
},
{
"id": "Quarterly",
"key": "3.0",
"value": "Quarterly"
},
{
"id": "Every 4 Months",
"key": "4.0",
"value": "Every 4 Months"
},
{
"id": "Every 6 Months",
"key": "6.0",
"value": "Every 6 Months"
},
{
"id": "Annual",
"key": "12.0",
"value": "Annual"
},
{
"id": "Every 2 Years",
"key": "24.0",
"value": "Every 2 Years"
}
],
"pledge_received_hashes": [
{
"id": "Yes",
"value": "Yes"
},
{
"id": "No",
"value": "No"
}
],
"send_appeals_hashes": [
{
"id": true,
"value": "Yes"
},
{
"id": false,
"value": "No"
}
],
"status_hashes": [
{
"id": "Never Contacted",
"value": "Never Contacted"
},
{
"id": "Ask in Future",
"value": "Ask in Future"
},
{
"id": "Cultivate Relationship",
"value": "Cultivate Relationship"
},
{
"id": "Contact for Appointment",
"value": "Contact for Appointment"
},
{
"id": "Appointment Scheduled",
"value": "Appointment Scheduled"
},
{
"id": "Call for Decision",
"value": "Call for Decision"
},
{
"id": "Partner - Financial",
"value": "Partner - Financial"
},
{
"id": "Partner - Special",
"value": "Partner - Special"
},
{
"id": "Partner - Pray",
"value": "Partner - Pray"
},
{
"id": "Not Interested",
"value": "Not Interested"
},
{
"id": "Unresponsive",
"value": "Unresponsive"
},
{
"id": "Never Ask",
"value": "Never Ask"
},
{
"id": "Research Abandoned",
"value": "Research Abandoned"
},
{
"id": "Expired Referral",
"value": "Expired Referral"
}
]
}
}
}
Contacts
Contact [DELETE]
Contact [DELETE]
Request
Endpoint
DELETE /api/v2/contacts/9efbd93d-ed28-478f-8804-be94d428e0b2
Content-Type: application/vnd.api+json
DELETE /api/v2/contacts/:id
Parameters
None known.
Response
204 No Content
Contact [GET]
Contact [GET]
Request
Endpoint
GET /api/v2/contacts/0306086c-9acb-496c-a135-3b4c78aa48a1
Content-Type: application/vnd.api+json
GET /api/v2/contacts/:id
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "0306086c-9acb-496c-a135-3b4c78aa48a1",
"type": "contacts",
"attributes": {
"avatar": "https://mpdx.org/images/avatar.png",
"church_name": null,
"created_at": "2018-10-12T19:15:23Z",
"deceased": false,
"direct_deposit": false,
"envelope_greeting": "Nigel Raynor",
"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": "2018-10-07",
"lifetime_donations": "0.0",
"likely_to_give": null,
"locale": "en",
"magazine": false,
"name": "Raynor, Nigel",
"next_ask": null,
"no_appeals": null,
"no_gift_aid": null,
"notes": "Test Note.",
"notes_saved_at": "2018-10-12T19:15:23Z",
"pledge_amount": "100.0",
"pledge_currency": "USD",
"pledge_currency_symbol": "$",
"pledge_frequency": "1",
"pledge_received": false,
"pledge_start_date": "2018-09-07",
"send_newsletter": null,
"square_avatar": "https://mpdx.org/images/avatar.png",
"status": "Partner - Financial",
"status_valid": null,
"suggested_changes": {
},
"tag_list": [
],
"timezone": null,
"uncompleted_tasks_count": 0,
"updated_at": "2018-10-12T19:15:23Z",
"updated_in_db_at": "2018-10-12T19:15:23Z",
"website": "http://rogahnstoltenberg.co/walton"
},
"relationships": {
"account_list": {
"data": {
"id": "e0dfa11c-c5f7-44f7-8612-19be6a360b30",
"type": "account_lists"
}
},
"addresses": {
"data": [
]
},
"appeals": {
"data": [
]
},
"contact_referrals_by_me": {
"data": [
]
},
"contact_referrals_to_me": {
"data": [
]
},
"contacts_referred_by_me": {
"data": [
]
},
"contacts_that_referred_me": {
"data": [
]
},
"donation_amount_recommendations": {
"data": [
]
},
"donor_accounts": {
"data": [
]
},
"last_six_donations": {
"data": [
]
},
"people": {
"data": [
]
},
"tasks": {
"data": [
]
},
"primary_person": {
"data": null
},
"primary_or_first_person": {
"data": {
"id": "",
"type": "people"
}
},
"spouse": {
"data": null
}
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
avatar |
string |
The avatar url of the Contact |
church_name |
string |
The name of the Church for this Contact |
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
deceased |
boolean |
Whether or not the Contact is deceased |
direct_deposit |
boolean |
If the contact is setup for direct deposit |
envelope_greeting |
string |
The greeting for this Contact for use on an envelope |
greeting |
string |
The greeting for this contact |
last_activity |
string |
The date of the last activity for the Contact |
last_appointment |
string |
The date of the last appointment for the Contact |
last_donation |
string |
The date of the last donation for the Contact |
last_letter |
string |
The date of the last letter for the Contact |
last_phone_call |
string |
The date of the last phone call for the Contact |
last_pre_call |
string |
The date of the last pre-phone call for the Contact |
last_thank |
string |
The date of the last thank you for the Contact |
late_at |
string |
The date at which the contact started being late on payments |
lifetime_donations |
number |
Total donation amount |
likely_to_give |
boolean |
Whether or not the Contact is likely to give |
locale |
string |
The locale of the Contact |
magazine |
booelan |
Whether or not the Contact receives a magazine |
name |
string |
The name of the Contact |
next_ask |
string |
The date of the next ask for the Contact |
no_appeals |
boolean |
Whether or not the Contact has no appeals |
no_gift_aid |
boolean |
Whether or not the Contact is eligible for Gift Aid (UK government subsidies) |
notes |
string |
Notes for this contact |
notes_saved_at |
string |
the datetime of when the notes for this Contact were last saved |
pledge_amount |
float |
The amount that the Contact has pledged |
pledge_currency |
string |
The currency format for the Contact’s pledge |
pledge_currency_symbol |
string |
The symbol that represents the currency format for the Contact’s pledge |
pledge_frequency |
float |
The requency in which the Contact pledges |
pledge_received |
boolean |
Whether or not a pledge has been received for this Contact |
pledge_start_date |
string |
Date in which the Contact’s pledge starts |
send_newsletter |
string |
The type of newsletter to be sent to this Contact. Physical, Email, or Both |
square_avatar |
string |
A url for the Contact’s avatar - but in a square format |
status |
string |
The partner status of the Contact |
status_valid |
boolean |
Whether or not the Contact’s status is valid |
suggested_changes |
string |
thing |
tag_list |
[string] |
A list of tags |
timezone |
string |
The Contact’s timezone |
uncompleted_tasks_count |
number |
The number of uncompleted tasks for this Contact |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
website |
string |
The website of the Contact |
| Relationships | ||
account_list.data.id |
id string |
The id of the Account List that the Appeal belongs to |
addresses.data |
[Address] |
An array of Address references for the Contact |
appeals.data |
[Appeal] |
An array of Appeal references for the Contact |
contact_referrals_by_me.data |
[Contact Referral] |
An array of Contact Referrals references the Contacts that were referred by the current Contact |
contact_referrals_to_me.data |
[Contact Referral] |
An array of Contact Referrals references the Contacts that referred the current Contact |
contacts_referred_by_me.data |
[Contact] |
An array of referred Contact references for the Contact |
contacts_that_referred_me.data |
[Contact] |
An array of Contact referral references for the Contact |
donor_accounts.data |
[Donor Account] |
An array of Donor Account references for the Contact |
last_six_donations.data |
[Donation] |
An array of the last six Donation references for the Contact |
people.data |
[People] |
An array of People references for the Contact |
tasks.data |
[Tasks] |
An array of Tasks references for the Contact |
Contact [LIST]
Contact [LIST]
Request
Endpoint
GET /api/v2/contacts
Content-Type: application/vnd.api+json
GET /api/v2/contacts
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| Sorts | |||
sort[created_at] |
- |
Sort objects by their created_at time |
- |
sort[name] |
- |
Sort objects by name | - |
sort[updated_at] |
- |
Sort objects by their updated_at time |
- |
| Filters | |||
filter[account_list_id] |
- |
Filter by Account List; Accepts Account List ID | - |
filter[address_historic] |
- |
Filter by Address No Longer Valid; Accepts values 'true’, or 'false’ | - |
filter[appeal] |
- |
Filter by Appeal; Accepts multiple parameters, with value 'no_appeals’, or an appeal ID | - |
filter[church] |
- |
Filter by Church; Accepts multiple parameters, with value 'none’, or a church name | - |
filter[city] |
- |
Filter by City; Accepts multiple parameters, with value 'none’, or a city name | - |
filter[contact_info_addr] |
- |
Filter by Address; Accepts values 'Yes’, or 'No’ | - |
filter[contact_info_email] |
- |
Filter by Email; Accepts values 'Yes’, or 'No’ | - |
filter[contact_info_facebook] |
- |
Filter by Facebook Profile; Accepts values 'Yes’, or 'No’ | - |
filter[contact_info_mobile] |
- |
Filter by Mobile Phone; Accepts values 'Yes’, or 'No’ | - |
filter[contact_info_phone] |
- |
Filter by Home Phone; Accepts values 'Yes’, or 'No’ | - |
filter[contact_info_work_phone] |
- |
Filter by Work Phone; Accepts values 'Yes’, or 'No’ | - |
filter[contact_type] |
- |
Filter by Type; Accepts multiple parameters, with values 'person’, and 'company’ | - |
filter[country] |
- |
Filter by Country; Accepts multiple parameters, with values 'none’, or a country | - |
filter[donation] |
- |
Filter by Gift Options; Accepts multiple parameters, with values 'none’, 'one’, 'first’, and 'last’ | - |
filter[donation_amount] |
- |
Filter by Exact Gift Amount; Accepts multiple parameters, with values like '9.99’ | - |
filter[donation_amount_range[max]] |
- |
Filter by Gift Amount Range, Maximum; Accepts values like '9.99’ | - |
filter[donation_amount_range[min]] |
- |
Filter by Gift Amount Range, Minimum; Accepts values like '9.99’ | - |
filter[donation_date] |
- |
Filter by Gift Date; Accepts date range with text value like 'MM/DD/YYYY - MM/DD/YYYY’ | - |
filter[likely] |
- |
Filter by Likely To Give; Accepts multiple parameters, with values 'none’, 'Least Likely’, 'Likely’, and 'Most Likely’ | - |
filter[locale] |
- |
Filter by Language; Accepts multiple parameters, | - |
filter[metro_area] |
- |
Filter by Metro Area; Accepts multiple parameters, with values 'none’, or a metro area name | - |
filter[newsletter] |
- |
Filter by Newsletter Recipients; Accepts values 'none’, 'all’, 'address’, 'email’, and 'both’ | - |
filter[pledge_amount] |
- |
Filter by Commitment Amount; Accepts multiple parameters, with values like '100.0’ | - |
filter[pledge_currency] |
- |
Filter by Commitment Currency; Accepts multiple parameters, with values like 'USD’ | - |
filter[pledge_frequencies] |
- |
Filter by Commitment Frequency; Accepts multiple parameters, with numeric values like '0.23076923076923’ (Weekly), '0.46153846153846’ (Every 2 Weeks), '1.0’ (Monthly), '2.0’ (Every 2 Months), '3.0’, '4.0’, '6.0’, '12.0’ (Yearly), and '24.0’ (Every 2 Years) | - |
filter[pledge_late_by] |
- |
Filter by Late By; Accepts values “, '0_30’ (Less than 30 days late), '30_60’ (More than 30 days late), '60_90’ (More than 60 days late), or '90’ (More than 90 days late) | - |
filter[pledge_received] |
- |
Filter by Commitment Received; Accepts values 'true’, or 'false’ | - |
filter[referrer] |
- |
Filter by Referrer; Accepts multiple parameters, with values 'none’, 'any’, or a Contact ID | - |
filter[region] |
- |
Filter by Region; Accepts multiple parameters, with values 'none’, or a region name | - |
filter[related_task_action] |
- |
Filter by Action; Accepts multiple parameters, with values 'none’, or an activity type like 'Call’ | - |
filter[state] |
- |
Filter by State; Accepts multiple parameters, with values 'none’, or a state | - |
filter[status] |
- |
Filter by Status; Accepts multiple parameters, with values 'active’, 'hidden’, 'null’, 'Never Contacted’, 'Ask in Future’, 'Cultivate Relationship’, 'Contact for Appointment’, 'Appointment Scheduled’, 'Call for Decision’, 'Partner - Financial’, 'Partner - Special’, 'Partner - Pray’, 'Not Interested’, 'Unresponsive’, 'Never Ask’, 'Research Abandoned’, and 'Expired Referral’ | - |
filter[status_valid] |
- |
Filter by Status Valid; Accepts values 'true’, or 'false’ | - |
filter[task_due_date] |
- |
Filter by Due Date; Accepts date range with text value like 'MM/DD/YYYY - MM/DD/YYYY’ | - |
filter[timezone] |
- |
Filter by Timezone; Accepts multiple parameters, | - |
filter[filter] |
- |
Filter the list of returned contacts. Any filter can be reversed by adding reverse_FILTER_NAME_HERE = true | - |
filter[filter[{:any_filters=>"If set to true any result where at least one of the filters apply will be returned", :reverse_FILTER_NAME=>"If set to true, the filter defined as FILTER_NAME will return results that don't apply", :account_list_id=>"Filter by Account List; Accepts Account List ID", :address_historic=>"Filter by Address Historic; Accepts values \"true\", or \"false\"", :address_valid=>"Filter by Address Invalid; A Contact's Address is invalid if the Address's valid attribute is set to false, or if the Contact has multiple Addresses marked as primary; Accepts value \"false\"", :appeal=>"Filter by Appeal; Accepts multiple parameters, with value \"no_appeals\", or an appeal ID", :church=>"Filter by Church; Accepts multiple parameters, with value \"none\", or a church name", :city=>"Filter by City; Accepts multiple parameters, with value \"none\", or a city name", :contact_info_addr=>"Filter by Address; Accepts values \"Yes\", or \"No\"", :contact_info_email=>"Filter by Email; Accepts values \"Yes\", or \"No\"", :contact_info_facebook=>"Filter by Facebook Profile; Accepts values \"Yes\", or \"No\"", :contact_info_mobile=>"Filter by Mobile Phone; Accepts values \"Yes\", or \"No\"", :contact_info_phone=>"Filter by Home Phone; Accepts values \"Yes\", or \"No\"", :contact_info_work_phone=>"Filter by Work Phone; Accepts values \"Yes\", or \"No\"", :contact_type=>"Filter by Type; Accepts multiple parameters, with values \"person\", and \"company\"", :country=>"Filter by Country; Accepts multiple parameters, with values \"none\", or a country", :donation=>"Filter by Gift Options; Accepts multiple parameters, with values \"none\", \"one\", \"first\", and \"last\"", :donation_amount=>"Filter by Exact Gift Amount; Accepts multiple parameters, with values like \"9.99\"", "donation_amount_range:min"=>"Filter by Gift Amount Range, Minimum; Accepts values like \"9.99\"", "donation_amount_range:max"=>"Filter by Gift Amount Range, Maximum; Accepts values like \"9.99\"", :donation_date=>"Filter by Gift Date; Accepts date range with text value like \"YYY-MM-DD..YYYY-MM-DD\"", :gave_more_than_pledged_range=>"Will return contacts that have given more than pledged within a date range.\n Accepts date range with text value like \"MM/DD/YYYY - MM/DD/YYYY\"", :likely=>"Filter by Likely To Give; Accepts multiple parameters, with values \"none\", \"Least Likely\", \"Likely\", and \"Most Likely\"", :locale=>"Filter by Language; Accepts multiple parameters,", :metro_area=>"Filter by Metro Area; Accepts multiple parameters, with values \"none\", or a metro area name", :newsletter=>"Filter by Newsletter Recipients; Accepts values \"none\", \"all\", \"address\", \"email\", and \"both\"", :no_appeals=>"Filter by Due Date; Pass the value \"true\" if the contacts do not wish to be contacted for appeals.", :pledge_amount=>"Filter by Commitment Amount; Accepts multiple parameters, with values like \"100.0\"", :pledge_amount_increased_range=>"Will return contacts that have increased their pledge within the time range. Accepts date range with text value like \"YYY-MM-DD..YYYY-MM-DD\"", :pledge_currency=>"Filter by Commitment Currency; Accepts multiple parameters, with values like \"USD\"", :pledge_frequencies=>"Filter by Commitment Frequency; Accepts multiple parameters, with numeric values like \"0.23076923076923\" (Weekly), \"0.46153846153846\" (Every 2 Weeks), \"1.0\" (Monthly), \"2.0\" (Every 2 Months), \"3.0\", \"4.0\", \"6.0\", \"12.0\" (Yearly), and \"24.0\" (Every 2 Years)", :pledge_late_by=>"Filter by Late By; Accepts values \"\", \"0_30\" (Less than 30 days late), \"30_60\" (30-60 days late), \"60_90\" (60-90 days late), or \"90\" (More than 90 days late)", :pledge_received=>"Filter by Commitment Received; Accepts values \"true\", or \"false\"", :referrer=>"Filter by Referrer; Accepts multiple parameters, with values \"none\", \"any\", or a Contact ID", :region=>"Filter by Region; Accepts multiple parameters, with values \"none\", or a region name", :related_task_action=>"Filter by Action; Accepts multiple parameters, with values \"none\", or an activity type like \"Call\"", :state=>"Filter by State; Accepts multiple parameters, with values \"none\", or a state", :status=>"Filter by Status; Accepts multiple parameters, with values \"active\", \"hidden\", \"null\", \"Never Contacted\", \"Ask in Future\", \"Cultivate Relationship\", \"Contact for Appointment\", \"Appointment Scheduled\", \"Call for Decision\", \"Partner - Financial\", \"Partner - Special\", \"Partner - Pray\", \"Not Interested\", \"Unresponsive\", \"Never Ask\", \"Research Abandoned\", and \"Expired Referral\"", :status_valid=>"Filter by Status Valid; Accepts values \"true\", or \"false\"", :started_giving_range=>"Will return contacts that have started giving within the date range;Accepts date range with text value like \"YYY-MM-DD..YYYY-MM-DD\"", :stopped_giving_range=>"Will return contacts that have stopped giving during the date range;Note that for this filter to work the end date must be more than 1 month ago.Accepts date range with text value like \"YYY-MM-DD..YYYY-MM-DD\"", :tasks_all_completed=>"Return contacts that have no incomplete tasks if given the value \"true\"", :task_due_date=>"Filter by Due Date; Accepts date range with text value like \"YYY-MM-DD..YYYY-MM-DD\"", :timezone=>"Filter by Timezone; Accepts multiple parameters,", :wildcard_search=>"Filter by keyword, searches through name, notes, donor account numbers, email_addresses, phone_numbers and people names"}]] |
- |
filter[{:any filters=>"if set to true any result where at least one of the filters apply will be returned”, :reverse filter name=>“if set to true, the filter defined as filter name will return results that don’t apply”, :account list id=>“filter by account list; accepts account list id”, :address historic=>“filter by address historic; accepts values \"true\”, or \“false\”“, :address valid=>"filter by address invalid; a contact’s address is invalid if the address’s valid attribute is set to false, or if the contact has multiple addresses marked as primary; accepts value \"false\”“, :appeal=>"filter by appeal; accepts multiple parameters, with value \"no appeals\”, or an appeal id", :church=>“filter by church; accepts multiple parameters, with value \"none\”, or a church name", :city=>“filter by city; accepts multiple parameters, with value \"none\”, or a city name", :contact info addr=>“filter by address; accepts values \"yes\”, or \“no\”“, :contact info email=>"filter by email; accepts values \"yes\”, or \“no\”“, :contact info facebook=>"filter by facebook profile; accepts values \"yes\”, or \“no\”“, :contact info mobile=>"filter by mobile phone; accepts values \"yes\”, or \“no\”“, :contact info phone=>"filter by home phone; accepts values \"yes\”, or \“no\”“, :contact info work phone=>"filter by work phone; accepts values \"yes\”, or \“no\”“, :contact type=>"filter by type; accepts multiple parameters, with values \"person\”, and \“company\”“, :country=>"filter by country; accepts multiple parameters, with values \"none\”, or a country", :donation=>“filter by gift options; accepts multiple parameters, with values \"none\”, \“one\”, \“first\”, and \“last\”“, :donation amount=>"filter by exact gift amount; accepts multiple parameters, with values like \"9.99\”“, "donation amount range:min”=>“filter by gift amount range, minimum; accepts values like \"9.99\”“, "donation amount range:max”=>“filter by gift amount range, maximum; accepts values like \"9.99\”“, :donation date=>"filter by gift date; accepts date range with text value like \"yyy-mm-dd..yyyy-mm-dd\”“, :gave more than pledged range=>"will return contacts that have given more than pledged within a date range.\n accepts date range with text value like \"mm/dd/yyyy - mm/dd/yyyy\”“, :likely=>"filter by likely to give; accepts multiple parameters, with values \"none\”, \“least likely\”, \“likely\”, and \“most likely\”“, :locale=>"filter by language; accepts multiple parameters,”, :metro area=>“filter by metro area; accepts multiple parameters, with values \"none\”, or a metro area name", :newsletter=>“filter by newsletter recipients; accepts values \"none\”, \“all\”, \“address\”, \“email\”, and \“both\”“, :no appeals=>"filter by due date; pass the value \"true\” if the contacts do not wish to be contacted for appeals.“, :pledge amount=>"filter by commitment amount; accepts multiple parameters, with values like \"100.0\”“, :pledge amount increased range=>"will return contacts that have increased their pledge within the time range. accepts date range with text value like \"yyy-mm-dd..yyyy-mm-dd\”“, :pledge currency=>"filter by commitment currency; accepts multiple parameters, with values like \"usd\”“, :pledge frequencies=>"filter by commitment frequency; accepts multiple parameters, with numeric values like \"0.23076923076923\” (weekly), \“0.46153846153846\” (every 2 weeks), \“1.0\” (monthly), \“2.0\” (every 2 months), \“3.0\”, \“4.0\”, \“6.0\”, \“12.0\” (yearly), and \“24.0\” (every 2 years)“, :pledge late by=>"filter by late by; accepts values \”\“, \"0 30\” (less than 30 days late), \“30 60\” (30-60 days late), \“60 90\” (60-90 days late), or \“90\” (more than 90 days late)“, :pledge received=>"filter by commitment received; accepts values \"true\”, or \“false\”“, :referrer=>"filter by referrer; accepts multiple parameters, with values \"none\”, \“any\”, or a contact id", :region=>“filter by region; accepts multiple parameters, with values \"none\”, or a region name", :related task action=>“filter by action; accepts multiple parameters, with values \"none\”, or an activity type like \“call\”“, :state=>"filter by state; accepts multiple parameters, with values \"none\”, or a state", :status=>“filter by status; accepts multiple parameters, with values \"active\”, \“hidden\”, \“null\”, \“never contacted\”, \“ask in future\”, \“cultivate relationship\”, \“contact for appointment\”, \“appointment scheduled\”, \“call for decision\”, \“partner - financial\”, \“partner - special\”, \“partner - pray\”, \“not interested\”, \“unresponsive\”, \“never ask\”, \“research abandoned\”, and \“expired referral\”“, :status valid=>"filter by status valid; accepts values \"true\”, or \“false\”“, :started giving range=>"will return contacts that have started giving within the date range;accepts date range with text value like \"yyy-mm-dd..yyyy-mm-dd\”“, :stopped giving range=>"will return contacts that have stopped giving during the date range;note that for this filter to work the end date must be more than 1 month ago.accepts date range with text value like \"yyy-mm-dd..yyyy-mm-dd\”“, :tasks all completed=>"return contacts that have no incomplete tasks if given the value \"true\”“, :task due date=>"filter by due date; accepts date range with text value like \"yyy-mm-dd..yyyy-mm-dd\”“, :timezone=>"filter by timezone; accepts multiple parameters,”, :wildcard search=>“filter by keyword, searches through name, notes, donor account numbers, email addresses, phone numbers and people names”}] | - |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": [
{
"id": "39f485ec-743c-40e2-8bbe-48c49ac66ab6",
"type": "contacts",
"attributes": {
"avatar": "https://mpdx.org/images/avatar.png",
"church_name": null,
"created_at": "2018-10-12T19:15:23Z",
"deceased": false,
"direct_deposit": false,
"envelope_greeting": "Nikolas Torphy",
"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": "2018-10-07",
"likely_to_give": null,
"locale": "en",
"magazine": false,
"name": "Torphy, Nikolas",
"next_ask": null,
"no_appeals": null,
"no_gift_aid": null,
"notes": "Test Note.",
"notes_saved_at": "2018-10-12T19:15:23Z",
"pledge_amount": "100.0",
"pledge_currency": "USD",
"pledge_currency_symbol": "$",
"pledge_frequency": "1",
"pledge_received": false,
"pledge_start_date": "2018-09-07",
"send_newsletter": null,
"square_avatar": "https://mpdx.org/images/avatar.png",
"status": "Partner - Financial",
"status_valid": null,
"suggested_changes": {
},
"tag_list": [
],
"timezone": null,
"uncompleted_tasks_count": 0,
"updated_at": "2018-10-12T19:15:23Z",
"updated_in_db_at": "2018-10-12T19:15:23Z",
"website": "http://weberleffler.co/destini"
},
"relationships": {
"account_list": {
"data": {
"id": "c5acd352-7efa-4829-99fe-588c0eb5211d",
"type": "account_lists"
}
},
"addresses": {
"data": [
]
},
"appeals": {
"data": [
]
},
"contact_referrals_by_me": {
"data": [
]
},
"contact_referrals_to_me": {
"data": [
]
},
"contacts_referred_by_me": {
"data": [
]
},
"contacts_that_referred_me": {
"data": [
]
},
"donation_amount_recommendations": {
"data": [
]
},
"donor_accounts": {
"data": [
]
},
"last_six_donations": {
"data": [
]
},
"people": {
"data": [
]
},
"tasks": {
"data": [
]
},
"primary_person": {
"data": null
},
"primary_or_first_person": {
"data": {
"id": "",
"type": "people"
}
},
"spouse": {
"data": null
}
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 1,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
data |
[Contact] |
An array of Contact Objects |
data |
- |
Data |
Contact [POST]
Contact [POST]
Request
Endpoint
POST /api/v2/contacts
Content-Type: application/vnd.api+json
POST /api/v2/contacts
Parameters
{
"data": {
"type": "contacts",
"attributes": {
"locale": "en",
"name": "Grimes, Verona",
"notes": "Test Note.",
"overwrite": true,
"pledge_amount": 100,
"pledge_frequency": 1,
"pledge_start_date": "2018-09-07 21:15:23 +0200",
"status": "Partner - Financial",
"website": "http://christiansen.biz/trycia"
},
"relationships": {
"account_list": {
"data": {
"type": "account_lists",
"id": "fdfd409f-1609-4254-9672-990b0b559db7"
}
}
}
}
}
| Name | Type | Description | Required |
|---|---|---|---|
| Attributes | |||
avatar |
string |
The avatar url of the Contact | - |
church_name |
string |
The name of the Church for this Contact | - |
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created | - |
deceased |
boolean |
Whether or not the Contact is deceased | - |
direct_deposit |
boolean |
If the contact is setup for direct deposit | - |
envelope_greeting |
string |
The greeting for this Contact for use on an envelope | - |
greeting |
string |
The greeting for this contact | - |
late_at |
string |
The date at which the contact started being late on payments | - |
locale |
string |
The locale of the Contact | - |
magazine |
booelan |
Whether or not the Contact receives a magazine | - |
name |
string |
The name of the Contact | - |
next_ask |
string |
The date of the next ask for the Contact | - |
no_appeals |
boolean |
Whether or not the Contact has no appeals | - |
no_gift_aid |
boolean |
Whether or not the Contact is eligible for Gift Aid (UK government subsidies) | - |
notes |
string |
Notes for this contact | - |
pledge_amount |
float |
The amount that the Contact has pledged | - |
pledge_currency |
string |
The currency format for the Contact’s pledge | - |
pledge_frequency |
float |
The requency in which the Contact pledges | - |
pledge_received |
boolean |
Whether or not a pledge has been received for this Contact | - |
pledge_start_date |
string |
Date in which the Contact’s pledge starts | - |
send_newsletter |
string |
The type of newsletter to be sent to this Contact. Physical, Email, or Both | - |
square_avatar |
string |
A url for the Contact’s avatar - but in a square format | - |
status |
string |
The partner status of the Contact | - |
status_valid |
boolean |
Whether or not the Contact’s status is valid | - |
tag_list |
[string] |
A list of tags | - |
timezone |
string |
The Contact’s timezone | - |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated | - |
updated_in_db_at |
ISO8601 timestamp |
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. | - |
website |
string |
The website of the Contact | - |
| Relationships | |||
account_list.data.id |
id string |
The id of the Account List that the Appeal belongs to |
true |
contact_referrals_by_me.data |
[Contact Referral] |
An array of Contact Referrals references the Contacts that were referred by the current Contact | - |
contact_referrals_to_me.data |
[Contact Referral] |
An array of Contact Referrals references the Contacts that referred the current Contact | - |
Response
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
{
"data": {
"id": "e42f0a08-096d-48cd-b88c-873a63e591a7",
"type": "contacts",
"attributes": {
"avatar": "https://mpdx.org/images/avatar.png",
"church_name": null,
"created_at": "2018-10-12T19:15:23Z",
"deceased": false,
"direct_deposit": false,
"envelope_greeting": "Verona Grimes",
"greeting": "Verona",
"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": "2018-10-07",
"lifetime_donations": "0.0",
"likely_to_give": null,
"locale": "en",
"magazine": false,
"name": "Grimes, Verona",
"next_ask": null,
"no_appeals": null,
"no_gift_aid": null,
"notes": "Test Note.",
"notes_saved_at": "2018-10-12T19:15:23Z",
"pledge_amount": "100.0",
"pledge_currency": "USD",
"pledge_currency_symbol": "$",
"pledge_frequency": "1",
"pledge_received": false,
"pledge_start_date": "2018-09-07",
"send_newsletter": null,
"square_avatar": "https://mpdx.org/images/avatar.png",
"status": "Partner - Financial",
"status_valid": null,
"suggested_changes": {
},
"tag_list": [
],
"timezone": null,
"uncompleted_tasks_count": 0,
"updated_at": "2018-10-12T19:15:23Z",
"updated_in_db_at": "2018-10-12T19:15:23Z",
"website": "http://christiansen.biz/trycia"
},
"relationships": {
"account_list": {
"data": {
"id": "fdfd409f-1609-4254-9672-990b0b559db7",
"type": "account_lists"
}
},
"addresses": {
"data": [
]
},
"appeals": {
"data": [
]
},
"contact_referrals_by_me": {
"data": [
]
},
"contact_referrals_to_me": {
"data": [
]
},
"contacts_referred_by_me": {
"data": [
]
},
"contacts_that_referred_me": {
"data": [
]
},
"donation_amount_recommendations": {
"data": [
]
},
"donor_accounts": {
"data": [
]
},
"last_six_donations": {
"data": [
]
},
"people": {
"data": [
{
"id": "63ef394b-39f8-42e8-9ba3-f5d8154c657f",
"type": "people"
}
]
},
"tasks": {
"data": [
]
},
"primary_person": {
"data": {
"id": "63ef394b-39f8-42e8-9ba3-f5d8154c657f",
"type": "people"
}
},
"primary_or_first_person": {
"data": {
"id": "63ef394b-39f8-42e8-9ba3-f5d8154c657f",
"type": "people"
}
},
"spouse": {
"data": null
}
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
avatar |
string |
The avatar url of the Contact |
church_name |
string |
The name of the Church for this Contact |
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
deceased |
boolean |
Whether or not the Contact is deceased |
direct_deposit |
boolean |
If the contact is setup for direct deposit |
envelope_greeting |
string |
The greeting for this Contact for use on an envelope |
greeting |
string |
The greeting for this contact |
last_activity |
string |
The date of the last activity for the Contact |
last_appointment |
string |
The date of the last appointment for the Contact |
last_donation |
string |
The date of the last donation for the Contact |
last_letter |
string |
The date of the last letter for the Contact |
last_phone_call |
string |
The date of the last phone call for the Contact |
last_pre_call |
string |
The date of the last pre-phone call for the Contact |
last_thank |
string |
The date of the last thank you for the Contact |
late_at |
string |
The date at which the contact started being late on payments |
lifetime_donations |
number |
Total donation amount |
likely_to_give |
boolean |
Whether or not the Contact is likely to give |
locale |
string |
The locale of the Contact |
magazine |
booelan |
Whether or not the Contact receives a magazine |
name |
string |
The name of the Contact |
next_ask |
string |
The date of the next ask for the Contact |
no_appeals |
boolean |
Whether or not the Contact has no appeals |
no_gift_aid |
boolean |
Whether or not the Contact is eligible for Gift Aid (UK government subsidies) |
notes |
string |
Notes for this contact |
notes_saved_at |
string |
the datetime of when the notes for this Contact were last saved |
pledge_amount |
float |
The amount that the Contact has pledged |
pledge_currency |
string |
The currency format for the Contact’s pledge |
pledge_currency_symbol |
string |
The symbol that represents the currency format for the Contact’s pledge |
pledge_frequency |
float |
The requency in which the Contact pledges |
pledge_received |
boolean |
Whether or not a pledge has been received for this Contact |
pledge_start_date |
string |
Date in which the Contact’s pledge starts |
send_newsletter |
string |
The type of newsletter to be sent to this Contact. Physical, Email, or Both |
square_avatar |
string |
A url for the Contact’s avatar - but in a square format |
status |
string |
The partner status of the Contact |
status_valid |
boolean |
Whether or not the Contact’s status is valid |
suggested_changes |
string |
thing |
tag_list |
[string] |
A list of tags |
timezone |
string |
The Contact’s timezone |
uncompleted_tasks_count |
number |
The number of uncompleted tasks for this Contact |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
website |
string |
The website of the Contact |
| Relationships | ||
account_list.data.id |
id string |
The id of the Account List that the Appeal belongs to |
addresses.data |
[Address] |
An array of Address references for the Contact |
appeals.data |
[Appeal] |
An array of Appeal references for the Contact |
contact_referrals_by_me.data |
[Contact Referral] |
An array of Contact Referrals references the Contacts that were referred by the current Contact |
contact_referrals_to_me.data |
[Contact Referral] |
An array of Contact Referrals references the Contacts that referred the current Contact |
contacts_referred_by_me.data |
[Contact] |
An array of referred Contact references for the Contact |
contacts_that_referred_me.data |
[Contact] |
An array of Contact referral references for the Contact |
donor_accounts.data |
[Donor Account] |
An array of Donor Account references for the Contact |
last_six_donations.data |
[Donation] |
An array of the last six Donation references for the Contact |
people.data |
[People] |
An array of People references for the Contact |
tasks.data |
[Tasks] |
An array of Tasks references for the Contact |
Contact [PUT]
Contact [PUT]
Request
Endpoint
PUT /api/v2/contacts/6025369c-436c-4b69-87f6-82e72ce9a634
Content-Type: application/vnd.api+json
PUT /api/v2/contacts/:id
Parameters
{
"data": {
"type": "contacts",
"attributes": {
"locale": "en",
"name": "Swift, Jackie",
"notes": "Test Note.",
"overwrite": true,
"pledge_amount": 100,
"pledge_frequency": 1,
"pledge_start_date": "2018-09-07 21:15:23 +0200",
"status": "Partner - Financial",
"website": "http://friesen.name/sandrine"
},
"relationships": {
"account_list": {
"data": {
"type": "account_lists",
"id": "73a8e145-b3f1-4869-bae7-c0bce917fc27"
}
}
}
}
}
| Name | Type | Description | Required |
|---|---|---|---|
| Attributes | |||
avatar |
string |
The avatar url of the Contact | - |
church_name |
string |
The name of the Church for this Contact | - |
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created | - |
deceased |
boolean |
Whether or not the Contact is deceased | - |
direct_deposit |
boolean |
If the contact is setup for direct deposit | - |
envelope_greeting |
string |
The greeting for this Contact for use on an envelope | - |
greeting |
string |
The greeting for this contact | - |
late_at |
string |
The date at which the contact started being late on payments | - |
locale |
string |
The locale of the Contact | - |
magazine |
booelan |
Whether or not the Contact receives a magazine | - |
name |
string |
The name of the Contact | - |
next_ask |
string |
The date of the next ask for the Contact | - |
no_appeals |
boolean |
Whether or not the Contact has no appeals | - |
no_gift_aid |
boolean |
Whether or not the Contact is eligible for Gift Aid (UK government subsidies) | - |
notes |
string |
Notes for this contact | - |
overwrite |
boolean |
Only used for updating a record where you want to ignore the server’s ’ ’updated_in_db_at value and force overwrite the values for the record. ’ 'Must be true to work. |
- |
pledge_amount |
float |
The amount that the Contact has pledged | - |
pledge_currency |
string |
The currency format for the Contact’s pledge | - |
pledge_frequency |
float |
The requency in which the Contact pledges | - |
pledge_received |
boolean |
Whether or not a pledge has been received for this Contact | - |
pledge_start_date |
string |
Date in which the Contact’s pledge starts | - |
send_newsletter |
string |
The type of newsletter to be sent to this Contact. Physical, Email, or Both | - |
square_avatar |
string |
A url for the Contact’s avatar - but in a square format | - |
status |
string |
The partner status of the Contact | - |
status_valid |
boolean |
Whether or not the Contact’s status is valid | - |
tag_list |
[string] |
A list of tags | - |
timezone |
string |
The Contact’s timezone | - |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated | - |
updated_in_db_at |
ISO8601 timestamp |
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. | true |
website |
string |
The website of the Contact | - |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "6025369c-436c-4b69-87f6-82e72ce9a634",
"type": "contacts",
"attributes": {
"avatar": "https://mpdx.org/images/avatar.png",
"church_name": null,
"created_at": "2018-10-12T19:15:23Z",
"deceased": false,
"direct_deposit": false,
"envelope_greeting": "Jackie Swift",
"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": "2018-10-07",
"lifetime_donations": "0.0",
"likely_to_give": null,
"locale": "en",
"magazine": false,
"name": "Swift, Jackie",
"next_ask": null,
"no_appeals": null,
"no_gift_aid": null,
"notes": "Test Note.",
"notes_saved_at": "2018-10-12T19:15:23Z",
"pledge_amount": "100.0",
"pledge_currency": "USD",
"pledge_currency_symbol": "$",
"pledge_frequency": "1",
"pledge_received": false,
"pledge_start_date": "2018-09-07",
"send_newsletter": null,
"square_avatar": "https://mpdx.org/images/avatar.png",
"status": "Partner - Financial",
"status_valid": null,
"suggested_changes": {
},
"tag_list": [
],
"timezone": null,
"uncompleted_tasks_count": 0,
"updated_at": "2018-10-12T19:15:23Z",
"updated_in_db_at": "2018-10-12T19:15:23Z",
"website": "http://friesen.name/sandrine"
},
"relationships": {
"account_list": {
"data": {
"id": "73a8e145-b3f1-4869-bae7-c0bce917fc27",
"type": "account_lists"
}
},
"addresses": {
"data": [
]
},
"appeals": {
"data": [
]
},
"contact_referrals_by_me": {
"data": [
]
},
"contact_referrals_to_me": {
"data": [
]
},
"contacts_referred_by_me": {
"data": [
]
},
"contacts_that_referred_me": {
"data": [
]
},
"donation_amount_recommendations": {
"data": [
]
},
"donor_accounts": {
"data": [
]
},
"last_six_donations": {
"data": [
]
},
"people": {
"data": [
]
},
"tasks": {
"data": [
]
},
"primary_person": {
"data": null
},
"primary_or_first_person": {
"data": {
"id": "",
"type": "people"
}
},
"spouse": {
"data": null
}
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
avatar |
string |
The avatar url of the Contact |
church_name |
string |
The name of the Church for this Contact |
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
deceased |
boolean |
Whether or not the Contact is deceased |
direct_deposit |
boolean |
If the contact is setup for direct deposit |
envelope_greeting |
string |
The greeting for this Contact for use on an envelope |
greeting |
string |
The greeting for this contact |
last_activity |
string |
The date of the last activity for the Contact |
last_appointment |
string |
The date of the last appointment for the Contact |
last_donation |
string |
The date of the last donation for the Contact |
last_letter |
string |
The date of the last letter for the Contact |
last_phone_call |
string |
The date of the last phone call for the Contact |
last_pre_call |
string |
The date of the last pre-phone call for the Contact |
last_thank |
string |
The date of the last thank you for the Contact |
late_at |
string |
The date at which the contact started being late on payments |
lifetime_donations |
number |
Total donation amount |
likely_to_give |
boolean |
Whether or not the Contact is likely to give |
locale |
string |
The locale of the Contact |
magazine |
booelan |
Whether or not the Contact receives a magazine |
name |
string |
The name of the Contact |
next_ask |
string |
The date of the next ask for the Contact |
no_appeals |
boolean |
Whether or not the Contact has no appeals |
no_gift_aid |
boolean |
Whether or not the Contact is eligible for Gift Aid (UK government subsidies) |
notes |
string |
Notes for this contact |
notes_saved_at |
string |
the datetime of when the notes for this Contact were last saved |
pledge_amount |
float |
The amount that the Contact has pledged |
pledge_currency |
string |
The currency format for the Contact’s pledge |
pledge_currency_symbol |
string |
The symbol that represents the currency format for the Contact’s pledge |
pledge_frequency |
float |
The requency in which the Contact pledges |
pledge_received |
boolean |
Whether or not a pledge has been received for this Contact |
pledge_start_date |
string |
Date in which the Contact’s pledge starts |
send_newsletter |
string |
The type of newsletter to be sent to this Contact. Physical, Email, or Both |
square_avatar |
string |
A url for the Contact’s avatar - but in a square format |
status |
string |
The partner status of the Contact |
status_valid |
boolean |
Whether or not the Contact’s status is valid |
suggested_changes |
string |
thing |
tag_list |
[string] |
A list of tags |
timezone |
string |
The Contact’s timezone |
uncompleted_tasks_count |
number |
The number of uncompleted tasks for this Contact |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
website |
string |
The website of the Contact |
| Relationships | ||
account_list.data.id |
id string |
The id of the Account List that the Appeal belongs to |
addresses.data |
[Address] |
An array of Address references for the Contact |
appeals.data |
[Appeal] |
An array of Appeal references for the Contact |
contact_referrals_by_me.data |
[Contact Referral] |
An array of Contact Referrals references the Contacts that were referred by the current Contact |
contact_referrals_to_me.data |
[Contact Referral] |
An array of Contact Referrals references the Contacts that referred the current Contact |
contacts_referred_by_me.data |
[Contact] |
An array of referred Contact references for the Contact |
contacts_that_referred_me.data |
[Contact] |
An array of Contact referral references for the Contact |
donor_accounts.data |
[Donor Account] |
An array of Donor Account references for the Contact |
last_six_donations.data |
[Donation] |
An array of the last six Donation references for the Contact |
people.data |
[People] |
An array of People references for the Contact |
tasks.data |
[Tasks] |
An array of Tasks references for the Contact |
Contacts [BULK DELETE]
Contacts [BULK DELETE]
Request
Endpoint
DELETE /api/v2/contacts/bulk
Content-Type: application/vnd.api+json
DELETE /api/v2/contacts/bulk
Parameters
{
"data": [
{
"data": {
"type": "contacts",
"id": "a157c69f-60c5-4e0e-9146-ca30eb1de84c"
}
},
{
"data": {
"type": "contacts",
"id": "c5a94379-f21d-4d91-9575-1c7317db3267"
}
}
]
}
| Name | Type | Description | Required |
|---|---|---|---|
data |
[object w/ type and id] |
An array of objects that have both a type and id for the contacts being deleted |
true |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
[
{
"data": {
"id": "c5a94379-f21d-4d91-9575-1c7317db3267",
"type": "contacts",
"attributes": {
"avatar": "https://mpdx.org/images/avatar.png",
"church_name": null,
"created_at": "2018-10-12T19:15:09Z",
"deceased": false,
"direct_deposit": false,
"envelope_greeting": "Malachi Toy",
"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": "2018-10-07",
"likely_to_give": null,
"locale": "en",
"magazine": false,
"name": "Toy, Malachi",
"next_ask": null,
"no_appeals": null,
"no_gift_aid": null,
"notes": "Test Note.",
"notes_saved_at": "2018-10-12T19:15:09Z",
"pledge_amount": "100.0",
"pledge_currency": "USD",
"pledge_currency_symbol": "$",
"pledge_frequency": "1",
"pledge_received": false,
"pledge_start_date": "2018-09-07",
"send_newsletter": null,
"square_avatar": "https://mpdx.org/images/avatar.png",
"status": "Partner - Financial",
"status_valid": null,
"suggested_changes": {
},
"tag_list": [
],
"timezone": null,
"uncompleted_tasks_count": 0,
"updated_at": "2018-10-12T19:15:09Z",
"updated_in_db_at": "2018-10-12T19:15:09Z",
"website": "http://hermanboyle.info/kasey"
},
"relationships": {
"account_list": {
"data": {
"id": "964cff62-e475-4f85-831b-e114297a9e71",
"type": "account_lists"
}
},
"addresses": {
"data": [
]
},
"appeals": {
"data": [
]
},
"contact_referrals_by_me": {
"data": [
]
},
"contact_referrals_to_me": {
"data": [
]
},
"contacts_referred_by_me": {
"data": [
]
},
"contacts_that_referred_me": {
"data": [
]
},
"donation_amount_recommendations": {
"data": [
]
},
"donor_accounts": {
"data": [
]
},
"last_six_donations": {
"data": [
]
},
"people": {
"data": [
]
},
"tasks": {
"data": [
]
},
"primary_person": {
"data": null
},
"primary_or_first_person": {
"data": {
"id": "",
"type": "people"
}
},
"spouse": {
"data": null
}
}
}
},
{
"data": {
"id": "a157c69f-60c5-4e0e-9146-ca30eb1de84c",
"type": "contacts",
"attributes": {
"avatar": "https://mpdx.org/images/avatar.png",
"church_name": null,
"created_at": "2018-10-12T19:15:09Z",
"deceased": false,
"direct_deposit": false,
"envelope_greeting": "Aurelia McGlynn",
"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": "2018-10-07",
"likely_to_give": null,
"locale": "en",
"magazine": false,
"name": "McGlynn, Aurelia",
"next_ask": null,
"no_appeals": null,
"no_gift_aid": null,
"notes": "Test Note.",
"notes_saved_at": "2018-10-12T19:15:09Z",
"pledge_amount": "100.0",
"pledge_currency": "USD",
"pledge_currency_symbol": "$",
"pledge_frequency": "1",
"pledge_received": false,
"pledge_start_date": "2018-09-07",
"send_newsletter": null,
"square_avatar": "https://mpdx.org/images/avatar.png",
"status": "Partner - Financial",
"status_valid": null,
"suggested_changes": {
},
"tag_list": [
],
"timezone": null,
"uncompleted_tasks_count": 0,
"updated_at": "2018-10-12T19:15:09Z",
"updated_in_db_at": "2018-10-12T19:15:09Z",
"website": "http://green.org/lia"
},
"relationships": {
"account_list": {
"data": {
"id": "964cff62-e475-4f85-831b-e114297a9e71",
"type": "account_lists"
}
},
"addresses": {
"data": [
]
},
"appeals": {
"data": [
]
},
"contact_referrals_by_me": {
"data": [
]
},
"contact_referrals_to_me": {
"data": [
]
},
"contacts_referred_by_me": {
"data": [
]
},
"contacts_that_referred_me": {
"data": [
]
},
"donation_amount_recommendations": {
"data": [
]
},
"donor_accounts": {
"data": [
]
},
"last_six_donations": {
"data": [
]
},
"people": {
"data": [
]
},
"tasks": {
"data": [
]
},
"primary_person": {
"data": null
},
"primary_or_first_person": {
"data": {
"id": "",
"type": "people"
}
},
"spouse": {
"data": null
}
}
}
}
]
Fields
| Name | Type | Description |
|---|---|---|
data |
[Contact] |
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+json
POST /api/v2/contacts/bulk
Parameters
{
"data": [
{
"data": {
"type": "contacts",
"id": "29189fff-4e07-4dc3-bf34-00b65c095fd2",
"attributes": {
"locale": "en",
"name": "Heidenreich, Dariana",
"notes": "Test Note.",
"pledge_amount": 100,
"pledge_frequency": 1,
"pledge_start_date": "2018-09-07 21:15:08 +0200",
"status": "Partner - Financial",
"website": "http://wyman.co/esperanza",
"updated_in_db_at": "2018-10-12 21:15:08 +0200"
},
"relationships": {
"account_list": {
"data": {
"id": "6b72ec64-19f6-426d-bf80-80d40ca7d2a0",
"type": "account_lists"
}
}
}
}
}
]
}
| Name | Type | Description | Required |
|---|---|---|---|
data |
[Contact] |
An array of Contacts to be created | true |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
[
{
"data": {
"id": "29189fff-4e07-4dc3-bf34-00b65c095fd2",
"type": "contacts",
"attributes": {
"avatar": "https://mpdx.org/images/avatar.png",
"church_name": null,
"created_at": "2018-10-12T19:15:08Z",
"deceased": false,
"direct_deposit": false,
"envelope_greeting": "Dariana Heidenreich",
"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": "2018-10-07",
"likely_to_give": null,
"locale": "en",
"magazine": false,
"name": "Heidenreich, Dariana",
"next_ask": null,
"no_appeals": null,
"no_gift_aid": null,
"notes": "Test Note.",
"notes_saved_at": "2018-10-12T19:15:08Z",
"pledge_amount": "100.0",
"pledge_currency": "USD",
"pledge_currency_symbol": "$",
"pledge_frequency": "1",
"pledge_received": false,
"pledge_start_date": "2018-09-07",
"send_newsletter": null,
"square_avatar": "https://mpdx.org/images/avatar.png",
"status": "Partner - Financial",
"status_valid": null,
"suggested_changes": {
},
"tag_list": [
],
"timezone": null,
"uncompleted_tasks_count": 0,
"updated_at": "2018-10-12T19:15:08Z",
"updated_in_db_at": "2018-10-12T19:15:08Z",
"website": "http://wyman.co/esperanza"
},
"relationships": {
"account_list": {
"data": {
"id": "6b72ec64-19f6-426d-bf80-80d40ca7d2a0",
"type": "account_lists"
}
},
"addresses": {
"data": [
]
},
"appeals": {
"data": [
]
},
"contact_referrals_by_me": {
"data": [
]
},
"contact_referrals_to_me": {
"data": [
]
},
"contacts_referred_by_me": {
"data": [
]
},
"contacts_that_referred_me": {
"data": [
]
},
"donation_amount_recommendations": {
"data": [
]
},
"donor_accounts": {
"data": [
]
},
"last_six_donations": {
"data": [
]
},
"people": {
"data": [
]
},
"tasks": {
"data": [
]
},
"primary_person": {
"data": null
},
"primary_or_first_person": {
"data": {
"id": "",
"type": "people"
}
},
"spouse": {
"data": null
}
}
}
}
]
Fields
| Name | Type | Description |
|---|---|---|
data |
[Contact / error] |
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+json
PUT /api/v2/contacts/bulk
Parameters
{
"data": [
{
"data": {
"type": "contacts",
"id": "ada1a3ed-092f-41d1-8906-483ea16fc799",
"attributes": {
"locale": "en",
"name": "Raynor, Tavares",
"notes": "Test Note.",
"pledge_amount": 100,
"pledge_frequency": 1,
"pledge_start_date": "2018-09-07 21:15:08 +0200",
"status": "Partner - Financial",
"website": "http://skiles.com/marisol_dicki",
"updated_in_db_at": "2018-10-12 21:15:08 +0200"
}
}
}
]
}
| Name | Type | Description | Required |
|---|---|---|---|
data |
[Contact] |
An array of Contacts to be updated | true |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
[
{
"data": {
"id": "ada1a3ed-092f-41d1-8906-483ea16fc799",
"type": "contacts",
"attributes": {
"avatar": "https://mpdx.org/images/avatar.png",
"church_name": null,
"created_at": "2018-10-12T19:15:08Z",
"deceased": false,
"direct_deposit": false,
"envelope_greeting": "Tavares Raynor",
"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": "2018-10-07",
"likely_to_give": null,
"locale": "en",
"magazine": false,
"name": "Raynor, Tavares",
"next_ask": null,
"no_appeals": null,
"no_gift_aid": null,
"notes": "Test Note.",
"notes_saved_at": "2018-10-12T19:15:08Z",
"pledge_amount": "100.0",
"pledge_currency": "USD",
"pledge_currency_symbol": "$",
"pledge_frequency": "1",
"pledge_received": false,
"pledge_start_date": "2018-09-07",
"send_newsletter": null,
"square_avatar": "https://mpdx.org/images/avatar.png",
"status": "Partner - Financial",
"status_valid": null,
"suggested_changes": {
},
"tag_list": [
],
"timezone": null,
"uncompleted_tasks_count": 0,
"updated_at": "2018-10-12T19:15:08Z",
"updated_in_db_at": "2018-10-12T19:15:08Z",
"website": "http://skiles.com/marisol_dicki"
},
"relationships": {
"account_list": {
"data": {
"id": "bd49edb9-edca-4c4e-b1db-49fe264c1363",
"type": "account_lists"
}
},
"addresses": {
"data": [
]
},
"appeals": {
"data": [
]
},
"contact_referrals_by_me": {
"data": [
]
},
"contact_referrals_to_me": {
"data": [
]
},
"contacts_referred_by_me": {
"data": [
]
},
"contacts_that_referred_me": {
"data": [
]
},
"donation_amount_recommendations": {
"data": [
]
},
"donor_accounts": {
"data": [
]
},
"last_six_donations": {
"data": [
]
},
"people": {
"data": [
]
},
"tasks": {
"data": [
]
},
"primary_person": {
"data": null
},
"primary_or_first_person": {
"data": {
"id": "",
"type": "people"
}
},
"spouse": {
"data": null
}
}
}
}
]
Fields
| Name | Type | Description |
|---|---|---|
data |
[Contact / error] |
Array of both Contact objects that have been successfully updated and of errors related to Contact objects that were not updated successfully |
People
Create a person
Create a Person associated with the Contact
Request
Endpoint
POST /api/v2/contacts/d92447fd-34a2-4155-9f87-1f07017b09ed/people
Content-Type: application/vnd.api+json
POST /api/v2/contacts/:contact_id/people
Parameters
{
"data": {
"type": "people",
"attributes": {
"first_name": "Mpdx",
"last_name": "Grady",
"overwrite": true
}
}
}
| Name | Type | Description | Required |
|---|---|---|---|
| Attributes | |||
email_addresses_attributes[:key][_destroy] |
Number |
Destroy Email Address if set to 1, where :key is an integer | - |
email_addresses_attributes[:key][email] |
String |
Email Address Email, where :key is an integer | - |
email_addresses_attributes[:key][historic] |
Boolean |
Email Address Historic, where :key is an integer | - |
email_addresses_attributes[:key][id] |
String |
Email Address ID, omit to create a new record, where :key is an integer | - |
email_addresses_attributes[:key][primary] |
String |
Email Address Primary, where :key is an integer | - |
family_relationships_attributes[:key][_destroy] |
Number |
Destroy Family Relationship if set to 1, where :key is an integer | - |
family_relationships_attributes[:key][id] |
String |
Family Relationship ID, omit to create a new record, where :key is an integer | - |
family_relationships_attributes[:key][related_person_id] |
String |
Family Relationship Related Persion ID, where :key is an integer | - |
family_relationships_attributes[:key][relationship] |
String |
Family Relationship Relationship, where :key is an integer | - |
linkedin_accounts_attributes[:key][_destroy] |
Number |
Destroy LinkedIn Account if set to 1, where :key is an integer | - |
linkedin_accounts_attributes[:key][id] |
String |
LinkedIn Account ID, omit to create a new record, where :key is an integer | - |
linkedin_accounts_attributes[:key][url] |
String |
LinkedIn Account URL, where :key is an integer | - |
phone_numbers_attributes[:key][_destroy] |
Number |
Destroy Phone Number if set to 1, where :key is an integer | - |
phone_numbers_attributes[:key][historic] |
String |
Phone Number Historic, where :key is an integer | - |
phone_numbers_attributes[:key][id] |
String |
Phone Number ID, omit to create a new record, where :key is an integer | - |
phone_numbers_attributes[:key][location] |
String |
Phone Number Location, where :key is an integer | - |
phone_numbers_attributes[:key][number] |
String |
Phone Number, where :key is an integer | - |
phone_numbers_attributes[:key][primary] |
Boolean |
Phone Number Primary, where :key is an integer | - |
pictures_attributes[:key][_destroy] |
Number |
Destroy Picture if set to 1, where :key is an integer | - |
pictures_attributes[:key][id] |
String |
Picture ID, omit to create a new record, where :key is an integer | - |
pictures_attributes[:key][image_cache] |
String |
Picture Image Cache, where :key is an integer | - |
pictures_attributes[:key][image] |
String |
Picture Image, where :key is an integer | - |
pictures_attributes[:key][primary] |
Boolean |
Picture Primary, where :key is an integer | - |
twitter_accounts_attributes[:key][_destroy] |
Number |
Destroy Twitter Account if set to 1, where :key is an integer | - |
twitter_accounts_attributes[:key][id] |
String |
Twitter Account ID, omit to create a new record, where :key is an integer | - |
twitter_accounts_attributes[:key][screen_name] |
String |
Twitter Account Screen Name, where :key is an integer | - |
websites_attributes[:key][_destroy] |
Number |
Destroy Website if set to 1, where :key is an integer | - |
websites_attributes[:key][id] |
String |
Website ID, omit to create a new record, where :key is an integer | - |
websites_attributes[:key][primary] |
Boolean |
Website Primary, where :key is an integer | - |
websites_attributes[:key][url] |
String |
Website URL, where :key is an integer | - |
| Relationships | |||
family_relationships_attributes[:key][_destroy] |
Number |
Destroy Family Relationship if set to 1, where :key is an integer | - |
family_relationships_attributes[:key][id] |
String |
Family Relationship ID, omit to create a new record, where :key is an integer | - |
family_relationships_attributes[:key][related_person_id] |
String |
Family Relationship Related Persion ID, where :key is an integer | - |
family_relationships_attributes[:key][relationship] |
String |
Family Relationship Relationship, where :key is an integer | - |
Response
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
{
"data": {
"id": "59396f3c-a709-45ea-a5ea-57bdc1b9b2e7",
"type": "people",
"attributes": {
"anniversary_day": null,
"anniversary_month": null,
"anniversary_year": null,
"avatar": "https://mpdx.org/images/avatar.png",
"birthday_day": null,
"birthday_month": null,
"birthday_year": null,
"created_at": "2018-10-12T19:15:20Z",
"deceased": false,
"employer": null,
"first_name": "Mpdx",
"gender": null,
"last_name": "Grady",
"legal_first_name": null,
"marital_status": null,
"middle_name": null,
"occupation": null,
"optout_enewsletter": false,
"parent_contacts": [
"d92447fd-34a2-4155-9f87-1f07017b09ed"
],
"suffix": null,
"title": null,
"updated_at": "2018-10-12T19:15:20Z",
"updated_in_db_at": "2018-10-12T19:15:20Z"
},
"relationships": {
"email_addresses": {
"data": [
]
},
"facebook_accounts": {
"data": [
]
},
"family_relationships": {
"data": [
]
},
"linkedin_accounts": {
"data": [
]
},
"phone_numbers": {
"data": [
]
},
"twitter_accounts": {
"data": [
]
},
"websites": {
"data": [
]
}
}
}
}
Retrieve a person
The Contact’s Person with the given ID and Contact ID
Request
Endpoint
GET /api/v2/contacts/9a35ae5d-784e-4b4a-8978-75357b37fd8a/people/ccf2a8db-3a5c-4162-bfeb-3c2ea576a0cd
Content-Type: application/vnd.api+json
GET /api/v2/contacts/:contact_id/people/:id
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "ccf2a8db-3a5c-4162-bfeb-3c2ea576a0cd",
"type": "people",
"attributes": {
"anniversary_day": null,
"anniversary_month": null,
"anniversary_year": null,
"avatar": "https://mpdx.org/images/avatar.png",
"birthday_day": null,
"birthday_month": null,
"birthday_year": null,
"created_at": "2018-10-12T19:15:20Z",
"deceased": false,
"employer": null,
"first_name": "Wilhelm",
"gender": null,
"last_name": "Bogisich",
"legal_first_name": null,
"marital_status": null,
"middle_name": null,
"occupation": null,
"optout_enewsletter": false,
"parent_contacts": [
"9a35ae5d-784e-4b4a-8978-75357b37fd8a"
],
"suffix": null,
"title": null,
"updated_at": "2018-10-12T19:15:20Z",
"updated_in_db_at": "2018-10-12T19:15:20Z"
},
"relationships": {
"email_addresses": {
"data": [
]
},
"facebook_accounts": {
"data": [
]
},
"family_relationships": {
"data": [
]
},
"linkedin_accounts": {
"data": [
]
},
"phone_numbers": {
"data": [
]
},
"twitter_accounts": {
"data": [
]
},
"websites": {
"data": [
]
}
}
}
}
Fields
| Name | Type | Description |
|---|
Update a person
Update the Contact’s Person with the given ID and Contact ID
Request
Endpoint
PUT /api/v2/contacts/83258e07-e032-4c38-8b6a-8b6d942f7466/people/059bd55d-283d-445b-a86d-9d222aee7618
Content-Type: application/vnd.api+json
PUT /api/v2/contacts/:contact_id/people/:id
Parameters
{
"data": {
"type": "people",
"attributes": {
"first_name": "Mpdx",
"last_name": "Bergstrom",
"overwrite": true
}
}
}
| Name | Type | Description | Required |
|---|---|---|---|
| Attributes | |||
email_addresses_attributes[:key][_destroy] |
Number |
Destroy Email Address if set to 1, where :key is an integer | - |
email_addresses_attributes[:key][email] |
String |
Email Address Email, where :key is an integer | - |
email_addresses_attributes[:key][historic] |
Boolean |
Email Address Historic, where :key is an integer | - |
email_addresses_attributes[:key][id] |
String |
Email Address ID, omit to create a new record, where :key is an integer | - |
email_addresses_attributes[:key][primary] |
String |
Email Address Primary, where :key is an integer | - |
family_relationships_attributes[:key][_destroy] |
Number |
Destroy Family Relationship if set to 1, where :key is an integer | - |
family_relationships_attributes[:key][id] |
String |
Family Relationship ID, omit to create a new record, where :key is an integer | - |
family_relationships_attributes[:key][related_person_id] |
String |
Family Relationship Related Persion ID, where :key is an integer | - |
family_relationships_attributes[:key][relationship] |
String |
Family Relationship Relationship, where :key is an integer | - |
linkedin_accounts_attributes[:key][_destroy] |
Number |
Destroy LinkedIn Account if set to 1, where :key is an integer | - |
linkedin_accounts_attributes[:key][id] |
String |
LinkedIn Account ID, omit to create a new record, where :key is an integer | - |
linkedin_accounts_attributes[:key][url] |
String |
LinkedIn Account URL, where :key is an integer | - |
phone_numbers_attributes[:key][_destroy] |
Number |
Destroy Phone Number if set to 1, where :key is an integer | - |
phone_numbers_attributes[:key][historic] |
String |
Phone Number Historic, where :key is an integer | - |
phone_numbers_attributes[:key][id] |
String |
Phone Number ID, omit to create a new record, where :key is an integer | - |
phone_numbers_attributes[:key][location] |
String |
Phone Number Location, where :key is an integer | - |
phone_numbers_attributes[:key][number] |
String |
Phone Number, where :key is an integer | - |
phone_numbers_attributes[:key][primary] |
Boolean |
Phone Number Primary, where :key is an integer | - |
pictures_attributes[:key][_destroy] |
Number |
Destroy Picture if set to 1, where :key is an integer | - |
pictures_attributes[:key][id] |
String |
Picture ID, omit to create a new record, where :key is an integer | - |
pictures_attributes[:key][image_cache] |
String |
Picture Image Cache, where :key is an integer | - |
pictures_attributes[:key][image] |
String |
Picture Image, where :key is an integer | - |
pictures_attributes[:key][primary] |
Boolean |
Picture Primary, where :key is an integer | - |
twitter_accounts_attributes[:key][_destroy] |
Number |
Destroy Twitter Account if set to 1, where :key is an integer | - |
twitter_accounts_attributes[:key][id] |
String |
Twitter Account ID, omit to create a new record, where :key is an integer | - |
twitter_accounts_attributes[:key][screen_name] |
String |
Twitter Account Screen Name, where :key is an integer | - |
websites_attributes[:key][_destroy] |
Number |
Destroy Website if set to 1, where :key is an integer | - |
websites_attributes[:key][id] |
String |
Website ID, omit to create a new record, where :key is an integer | - |
websites_attributes[:key][primary] |
Boolean |
Website Primary, where :key is an integer | - |
websites_attributes[:key][url] |
String |
Website URL, where :key is an integer | - |
| Relationships | |||
family_relationships_attributes[:key][_destroy] |
Number |
Destroy Family Relationship if set to 1, where :key is an integer | - |
family_relationships_attributes[:key][id] |
String |
Family Relationship ID, omit to create a new record, where :key is an integer | - |
family_relationships_attributes[:key][related_person_id] |
String |
Family Relationship Related Persion ID, where :key is an integer | - |
family_relationships_attributes[:key][relationship] |
String |
Family Relationship Relationship, where :key is an integer | - |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "059bd55d-283d-445b-a86d-9d222aee7618",
"type": "people",
"attributes": {
"anniversary_day": null,
"anniversary_month": null,
"anniversary_year": null,
"avatar": "https://mpdx.org/images/avatar.png",
"birthday_day": null,
"birthday_month": null,
"birthday_year": null,
"created_at": "2018-10-12T19:15:20Z",
"deceased": false,
"employer": null,
"first_name": "Mpdx",
"gender": null,
"last_name": "Bergstrom",
"legal_first_name": null,
"marital_status": null,
"middle_name": null,
"occupation": null,
"optout_enewsletter": false,
"parent_contacts": [
"83258e07-e032-4c38-8b6a-8b6d942f7466"
],
"suffix": null,
"title": null,
"updated_at": "2018-10-12T19:15:20Z",
"updated_in_db_at": "2018-10-12T19:15:20Z"
},
"relationships": {
"email_addresses": {
"data": [
]
},
"facebook_accounts": {
"data": [
]
},
"family_relationships": {
"data": [
]
},
"linkedin_accounts": {
"data": [
]
},
"phone_numbers": {
"data": [
]
},
"twitter_accounts": {
"data": [
]
},
"websites": {
"data": [
]
}
}
}
}
Delete a person
Delete the Contact’s Person with the given ID and Contact ID
Request
Endpoint
DELETE /api/v2/contacts/e88ce3e8-3233-4e90-a33c-d19eecf8470a/people/66090778-dd98-4df8-bb91-0eb6f7ba6be2
Content-Type: application/vnd.api+json
DELETE /api/v2/contacts/:contact_id/people/:id
Parameters
None known.
Response
204 No Content
List people for a contact
List of People associated to the Contact
Request
Endpoint
GET /api/v2/contacts/6988c48d-17d9-4c4d-bd72-8f6a5d7313ec/people
Content-Type: application/vnd.api+json
GET /api/v2/contacts/:contact_id/people
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": [
{
"id": "e05cf8db-5fa2-49fc-a4f1-8166f83f4a9d",
"type": "people",
"attributes": {
"anniversary_day": null,
"anniversary_month": null,
"anniversary_year": null,
"avatar": "https://mpdx.org/images/avatar.png",
"birthday_day": null,
"birthday_month": null,
"birthday_year": null,
"created_at": "2018-10-12T19:15:20Z",
"deceased": false,
"employer": null,
"first_name": "Wilhelm",
"gender": null,
"last_name": "Homenick",
"legal_first_name": null,
"marital_status": null,
"middle_name": null,
"occupation": null,
"optout_enewsletter": false,
"parent_contacts": [
"6988c48d-17d9-4c4d-bd72-8f6a5d7313ec"
],
"suffix": null,
"title": null,
"updated_at": "2018-10-12T19:15:20Z",
"updated_in_db_at": "2018-10-12T19:15:20Z"
},
"relationships": {
"email_addresses": {
"data": [
]
},
"facebook_accounts": {
"data": [
]
},
"family_relationships": {
"data": [
]
},
"linkedin_accounts": {
"data": [
]
},
"phone_numbers": {
"data": [
]
},
"twitter_accounts": {
"data": [
]
},
"websites": {
"data": [
]
}
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 1,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}
People [BULK DELETE]
People [BULK DELETE]
Request
Endpoint
DELETE /api/v2/contacts/people/bulk
Content-Type: application/vnd.api+json
DELETE /api/v2/contacts/people/bulk
Parameters
{
"data": [
{
"data": {
"type": "people",
"id": "81e930cd-7f5b-4d94-8424-dc0f3d0954ee"
}
},
{
"data": {
"type": "people",
"id": "af6473f1-f790-48be-b6a4-1e4c156ae454"
}
}
]
}
| Name | Type | Description | Required |
|---|---|---|---|
data |
[object w/ type and id] |
An array of objects that have both a type and id for the People being deleted |
true |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
[
{
"data": {
"id": "81e930cd-7f5b-4d94-8424-dc0f3d0954ee",
"type": "people",
"attributes": {
"anniversary_day": null,
"anniversary_month": null,
"anniversary_year": null,
"avatar": "https://mpdx.org/images/avatar.png",
"birthday_day": null,
"birthday_month": null,
"birthday_year": null,
"created_at": "2018-10-12T19:15:12Z",
"deceased": false,
"employer": null,
"first_name": "Caesar",
"gender": null,
"last_name": "Shields",
"legal_first_name": null,
"marital_status": null,
"middle_name": null,
"occupation": null,
"optout_enewsletter": false,
"parent_contacts": [
"678ce02f-0f45-4c06-96ec-67626dc50300"
],
"suffix": null,
"title": null,
"updated_at": "2018-10-12T19:15:12Z",
"updated_in_db_at": "2018-10-12T19:15:12Z"
},
"relationships": {
"email_addresses": {
"data": [
]
},
"facebook_accounts": {
"data": [
]
},
"family_relationships": {
"data": [
]
},
"linkedin_accounts": {
"data": [
]
},
"phone_numbers": {
"data": [
]
},
"twitter_accounts": {
"data": [
]
},
"websites": {
"data": [
]
}
}
}
},
{
"data": {
"id": "af6473f1-f790-48be-b6a4-1e4c156ae454",
"type": "people",
"attributes": {
"anniversary_day": null,
"anniversary_month": null,
"anniversary_year": null,
"avatar": "https://mpdx.org/images/avatar.png",
"birthday_day": null,
"birthday_month": null,
"birthday_year": null,
"created_at": "2018-10-12T19:15:12Z",
"deceased": false,
"employer": null,
"first_name": "Carlos",
"gender": null,
"last_name": "Tremblay",
"legal_first_name": null,
"marital_status": null,
"middle_name": null,
"occupation": null,
"optout_enewsletter": false,
"parent_contacts": [
"678ce02f-0f45-4c06-96ec-67626dc50300"
],
"suffix": null,
"title": null,
"updated_at": "2018-10-12T19:15:12Z",
"updated_in_db_at": "2018-10-12T19:15:12Z"
},
"relationships": {
"email_addresses": {
"data": [
]
},
"facebook_accounts": {
"data": [
]
},
"family_relationships": {
"data": [
]
},
"linkedin_accounts": {
"data": [
]
},
"phone_numbers": {
"data": [
]
},
"twitter_accounts": {
"data": [
]
},
"websites": {
"data": [
]
}
}
}
}
]
Fields
| Name | Type | Description |
|---|---|---|
data |
[Person] |
An array of People that have just been deleted |
People [BULK POST]
an individual element of the
dataarray
{
"data": {
"type": "people",
"id": "1d6393dd-f3f4-49d3-9fd8-7e758b056b1f",
"attributes": {
"first_name": "Steve",
"last_name": "Rogers",
"more_attributes": "...etc"
}
}
}
For this bulk create endpoint, you are required to send an array of items within the data object.
You are also required to send in a related Person. A Person cannot be created without a Contact.
- Each member of the array must contain a client generated
idto be used for the Person being created. - Each member of the array must contain a
typethat has the value of'people'. - Each member of the array must have an
attributeshash of values to be used for the Person being created.
Request
Endpoint
POST /api/v2/contacts/people/bulk
Content-Type: application/vnd.api+json
POST /api/v2/contacts/people/bulk
Parameters
{
"data": [
{
"data": {
"type": "people",
"id": "af7246a4-3b4c-4bfa-9c82-206525d342a0",
"attributes": {
"first_name": "Burdette",
"last_name": "O'Hara",
"updated_in_db_at": "2018-10-12 21:15:12 +0200"
},
"relationships": {
"contacts": {
"data": [
{
"type": "contacts",
"id": "b5bd4ab0-3421-4fcd-a1d6-0a14f66878e2"
}
]
}
}
}
}
]
}
| Name | Type | Description | Required |
|---|---|---|---|
data |
[Person] |
An array of People to be created | true |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
[
{
"data": {
"id": "af7246a4-3b4c-4bfa-9c82-206525d342a0",
"type": "people",
"attributes": {
"anniversary_day": null,
"anniversary_month": null,
"anniversary_year": null,
"avatar": "https://mpdx.org/images/avatar.png",
"birthday_day": null,
"birthday_month": null,
"birthday_year": null,
"created_at": "2018-10-12T19:15:12Z",
"deceased": false,
"employer": null,
"first_name": "Burdette",
"gender": null,
"last_name": "O'Hara",
"legal_first_name": null,
"marital_status": null,
"middle_name": null,
"occupation": null,
"optout_enewsletter": false,
"parent_contacts": [
"b5bd4ab0-3421-4fcd-a1d6-0a14f66878e2"
],
"suffix": null,
"title": null,
"updated_at": "2018-10-12T19:15:12Z",
"updated_in_db_at": "2018-10-12T19:15:12Z"
},
"relationships": {
"email_addresses": {
"data": [
]
},
"facebook_accounts": {
"data": [
]
},
"family_relationships": {
"data": [
]
},
"linkedin_accounts": {
"data": [
]
},
"phone_numbers": {
"data": [
]
},
"twitter_accounts": {
"data": [
]
},
"websites": {
"data": [
]
}
}
}
}
]
Fields
| Name | Type | Description |
|---|---|---|
data |
[Person / error] |
Array of People objects that have been successfully created and of errors related to People objects that were not created successfully |
People [BULK PUT]
People [BULK PUT]
Request
Endpoint
PUT /api/v2/contacts/people/bulk
Content-Type: application/vnd.api+json
PUT /api/v2/contacts/people/bulk
Parameters
{
"data": [
{
"data": {
"type": "people",
"id": "b8ddadeb-e2e8-438e-ac6d-98b3571e9b27",
"attributes": {
"first_name": "Kyra",
"last_name": "Heller",
"updated_in_db_at": "2018-10-12 21:15:12 +0200"
}
}
}
]
}
| Name | Type | Description | Required |
|---|---|---|---|
data |
[Person] |
An array of People to be updated | true |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
[
{
"data": {
"id": "b8ddadeb-e2e8-438e-ac6d-98b3571e9b27",
"type": "people",
"attributes": {
"anniversary_day": null,
"anniversary_month": null,
"anniversary_year": null,
"avatar": "https://mpdx.org/images/avatar.png",
"birthday_day": null,
"birthday_month": null,
"birthday_year": null,
"created_at": "2018-10-12T19:15:12Z",
"deceased": false,
"employer": null,
"first_name": "Kyra",
"gender": null,
"last_name": "Heller",
"legal_first_name": null,
"marital_status": null,
"middle_name": null,
"occupation": null,
"optout_enewsletter": false,
"parent_contacts": [
"df31daa0-be63-4bb5-8fb6-f8165d258785"
],
"suffix": null,
"title": null,
"updated_at": "2018-10-12T19:15:12Z",
"updated_in_db_at": "2018-10-12T19:15:12Z"
},
"relationships": {
"email_addresses": {
"data": [
]
},
"facebook_accounts": {
"data": [
]
},
"family_relationships": {
"data": [
]
},
"linkedin_accounts": {
"data": [
]
},
"phone_numbers": {
"data": [
]
},
"twitter_accounts": {
"data": [
]
},
"websites": {
"data": [
]
}
}
}
}
]
Fields
| Name | Type | Description |
|---|---|---|
data |
[Person / error] |
Array of People objects that have been successfully created and of errors related to People objects that were not created successfully |
Tasks
Task [GET]
Task [GET]
Request
Endpoint
GET /api/v2/tasks/169a0bdf-e79c-4a72-b70f-678c2c86d85c
Content-Type: application/vnd.api+json
GET /api/v2/tasks/:id
Parameters
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "169a0bdf-e79c-4a72-b70f-678c2c86d85c",
"type": "tasks",
"attributes": {
"activity_type": "Call",
"comments_count": 0,
"completed": false,
"completed_at": null,
"created_at": "2018-10-12T19:15:28Z",
"location": "MyString",
"next_action": null,
"notification_time_before": null,
"notification_time_unit": null,
"notification_type": null,
"result": null,
"starred": false,
"start_at": "2012-03-08T12:59:46Z",
"subject": "Call Alayna Greenholt I",
"subject_hidden": false,
"tag_list": [
],
"updated_at": "2018-10-12T19:15:28Z",
"updated_in_db_at": "2018-10-12T19:15:28Z"
},
"relationships": {
"comments": {
"data": [
]
},
"contacts": {
"data": [
]
},
"people": {
"data": [
]
},
"email_addresses": {
"data": [
]
},
"phone_numbers": {
"data": [
]
},
"activity_contacts": {
"data": [
]
},
"account_list": {
"data": {
"id": "b052c046-0b97-4c38-83aa-02c6d9d5337b",
"type": "account_lists"
}
}
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Relationships | ||
relationships |
Array[Object] |
List of relationships related to that task object |
Task [LIST]
Task [LIST]
Request
Endpoint
GET /api/v2/tasks
Content-Type: application/vnd.api+json
GET /api/v2/tasks
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| Filters | |||
filter[filter] |
- |
Filter the list of returned tasks. Any filter can be reversed by adding reverse_FILTER_NAME_HERE = true | - |
filter[filter[account_list_id]] |
- |
Filter by Account List; Accepts Account List ID | - |
filter[filter[activity_type][]] |
- |
Filter by Action; Accepts multiple parameters, with values “Call”, “Appointment”, “Email”, | - |
filter[filter[account_list_id]] |
- |
Filter by Account List; Accepts Account List ID | - |
filter[filter[activity_type][]] |
- |
Filter by Action; Accepts multiple parameters, with values “Call”, “Appointment”, “Email”, “Text Message”, “Facebook Message”, “Letter”, “Newsletter”, “Pre Call Letter”, “Reminder Letter”, “Support Letter”, “Thank”, “To Do”, “Talk to In Person”, or “Prayer Request” | - |
filter[filter[completed]] |
- |
Filter by Completed; Accepts values “true”, or “false” | - |
filter[filter[contact_ids][]] |
- |
Filter by Contact IDs; Accepts multiple parameters, with Contact IDs | - |
filter[filter[date_range]] |
- |
Filter by Date Range; Accepts values “last_month”, “last_year”, “last_two_years”, “last_week”, “overdue”, “today”, “tomorrow”, “future”, and “upcoming” | - |
filter[filter[overdue]] |
- |
Filter by Overdue; Accepts values “true”, or “false” | - |
filter[filter[starred]] |
- |
Filter by Starred; Accepts values “true”, or “false” | - |
filter[filter[tags][]] |
- |
Filter by Tags; Accepts multiple parameters, with text values | - |
filter[filter[wildcard_search]] |
- |
Filter by keyword, searches through subject and tags | - |
filter[filter[any_filters]] |
- |
If set to true any result where at least one of the filters apply will be returned | - |
filter[filter[reverse_FILTER_NAME]] |
- |
If set to true, the filter defined as FILTER_NAME will return results that don’t apply | - |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": [
{
"id": "bf0c9c5d-1118-46cc-a91e-c6c4b1dd3267",
"type": "tasks",
"attributes": {
"activity_type": "Call",
"comments_count": 0,
"completed": false,
"completed_at": null,
"created_at": "2018-10-12T19:15:28Z",
"location": "MyString",
"next_action": null,
"notification_time_before": null,
"notification_time_unit": null,
"notification_type": null,
"result": null,
"starred": false,
"start_at": "2012-03-08T12:59:46Z",
"subject": "Call Lucinda Rutherford",
"subject_hidden": false,
"tag_list": [
],
"updated_at": "2018-10-12T19:15:28Z",
"updated_in_db_at": "2018-10-12T19:15:28Z"
},
"relationships": {
"comments": {
"data": [
]
},
"contacts": {
"data": [
]
},
"people": {
"data": [
]
},
"email_addresses": {
"data": [
]
},
"phone_numbers": {
"data": [
]
},
"activity_contacts": {
"data": [
]
},
"account_list": {
"data": {
"id": "724d1031-7e31-4141-ba54-085b1cb08c85",
"type": "account_lists"
}
}
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 1,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
data |
- |
list of task objects |
data |
Array[Object] |
list of task objects |
Task [POST]
Task [POST]
Request
Endpoint
POST /api/v2/tasks
Content-Type: application/vnd.api+json
POST /api/v2/tasks
Parameters
{
"data": {
"attributes": {
"subject": "POST /api/v2/tasks",
"activity_type": "Call",
"completed_at": null,
"location": "MyString",
"result": null,
"starred": false,
"start_at": "2012-03-08 14:59:46",
"subject": "Call Rita Quitzon DDS",
"updated_in_db_at": "2018-10-12 21:15:28 +0200"
},
"type": "tasks",
"relationships": {
"account_list": {
"data": {
"type": "account_lists",
"id": "0ade14e1-92aa-4005-bb12-ce4976d4c5f6"
}
}
}
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
{
"data": {
"id": "9841358d-75e3-491b-ab61-5ed30774a2c8",
"type": "tasks",
"attributes": {
"activity_type": "Call",
"comments_count": 0,
"completed": false,
"completed_at": null,
"created_at": "2018-10-12T19:15:28Z",
"location": "MyString",
"next_action": null,
"notification_time_before": null,
"notification_time_unit": null,
"notification_type": null,
"result": null,
"starred": false,
"start_at": "2012-03-08T01:59:46Z",
"subject": "Call Rita Quitzon DDS",
"subject_hidden": false,
"tag_list": [
],
"updated_at": "2018-10-12T19:15:28Z",
"updated_in_db_at": "2018-10-12T19:15:28Z"
},
"relationships": {
"comments": {
"data": [
]
},
"contacts": {
"data": [
]
},
"people": {
"data": [
]
},
"email_addresses": {
"data": [
]
},
"phone_numbers": {
"data": [
]
},
"activity_contacts": {
"data": [
]
},
"account_list": {
"data": {
"id": "0ade14e1-92aa-4005-bb12-ce4976d4c5f6",
"type": "account_lists"
}
}
}
}
}
Task [PUT]
Task [PUT]
Request
Endpoint
PUT /api/v2/tasks/2374230a-aef4-4977-9688-037d99db51c6
Content-Type: application/vnd.api+json
PUT /api/v2/tasks/:id
Parameters
{
"data": {
"type": "tasks",
"attributes": {
"activity_type": "Call",
"completed_at": null,
"location": "MyString",
"result": null,
"starred": false,
"start_at": "2012-03-08 14:59:46",
"subject": "Call Godfrey Reichel",
"updated_in_db_at": "2018-10-12 21:15:29 +0200"
},
"relationships": {
"account_list": {
"data": {
"type": "account_lists",
"id": "8caf241a-fc8d-4725-a96e-58e5914615dd"
}
}
}
}
}
| Name | Type | Description | Required |
|---|---|---|---|
| Attributes | |||
activity_type |
string |
The Task activity type | - |
comments_count |
integer |
The number of Task comments | - |
completed |
boolean |
Whether or not the Task has been completed | - |
completed_at |
string |
Task completion time | - |
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created | - |
end_at |
string |
End At | - |
location |
string |
The Task location | - |
next_action |
string |
The next Task action | - |
notification_time_before |
integer |
Notification time before | - |
notification_time_unit |
string |
Unit of time for Task notification | - |
notification_type |
string |
Type of notification set for Task | - |
overwrite |
boolean |
Only used for updating a record where you want to ignore the server’s ’ ’updated_in_db_at value and force overwrite the values for the record. ’ 'Must be true to work. |
- |
remote_id |
string |
The remote id for the Task | - |
result |
string |
The result of the Task | - |
source |
string |
Source of the Task | - |
starred |
boolean |
Whether or not the Task has been starred | - |
start_at |
string |
Start at time for the Task | - |
subject |
string |
The subject of the Task | - |
tag_list |
string |
A list of tags associated with the Task | - |
type |
string |
The type of Task | - |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated | - |
updated_in_db_at |
ISO8601 timestamp |
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. | true |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "2374230a-aef4-4977-9688-037d99db51c6",
"type": "tasks",
"attributes": {
"activity_type": "Call",
"comments_count": 0,
"completed": false,
"completed_at": null,
"created_at": "2018-10-12T19:15:29Z",
"location": "MyString",
"next_action": null,
"notification_time_before": null,
"notification_time_unit": null,
"notification_type": null,
"result": null,
"starred": false,
"start_at": "2012-03-08T01:59:46Z",
"subject": "Call Godfrey Reichel",
"subject_hidden": false,
"tag_list": [
],
"updated_at": "2018-10-12T19:15:29Z",
"updated_in_db_at": "2018-10-12T19:15:29Z"
},
"relationships": {
"comments": {
"data": [
]
},
"contacts": {
"data": [
]
},
"people": {
"data": [
]
},
"email_addresses": {
"data": [
]
},
"phone_numbers": {
"data": [
]
},
"activity_contacts": {
"data": [
]
},
"account_list": {
"data": {
"id": "8caf241a-fc8d-4725-a96e-58e5914615dd",
"type": "account_lists"
}
}
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
activity_type |
string |
The Task activity type |
comments_count |
integer |
The number of Task comments |
completed |
boolean |
Whether or not the Task has been completed |
completed_at |
string |
Task completion time |
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
end_at |
string |
End At |
location |
string |
The Task location |
next_action |
string |
The next Task action |
notification_time_before |
integer |
Notification time before |
notification_time_unit |
string |
Unit of time for Task notification |
notification_type |
string |
Type of notification set for Task |
remote_id |
string |
The remote id for the Task |
result |
string |
The result of the Task |
source |
string |
Source of the Task |
starred |
boolean |
Whether or not the Task has been starred |
start_at |
string |
Start at time for the Task |
subject |
string |
The subject of the Task |
tag_list |
string |
A list of tags associated with the Task |
type |
string |
The type of Task |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
| Relationships | ||
account_list.data.id |
id string |
The id of the Account List that the Task belongs to |
comments.data |
[Comment] |
A list of comments associated to the Task |
contacts.data |
[Contact] |
An array of Contact references for the Task |
email_addresses.data |
[Email Address] |
A list of email addresses associated to the Task |
people.data |
[Person] |
A list of people associated to the Task |
phone_numbers.data |
[Phone Number] |
A list of phone numbers associated to the Task |
Tasks [BULK DELETE]
Tasks [BULK DELETE]
Request
Endpoint
DELETE /api/v2/tasks/bulk
Content-Type: application/vnd.api+json
DELETE /api/v2/tasks/bulk
Parameters
{
"data": [
{
"data": {
"type": "tasks",
"id": "a6680373-0ffc-4eef-9435-0c964a801696"
}
},
{
"data": {
"type": "tasks",
"id": "c2fc872a-f6ae-436c-8cd7-09ce3c8f5cb4"
}
}
]
}
| Name | Type | Description | Required |
|---|---|---|---|
data |
[object w/ type and id] |
An array of objects that have both a type and id for the Tasks being deleted |
true |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
[
{
"data": {
"id": "c2fc872a-f6ae-436c-8cd7-09ce3c8f5cb4",
"type": "tasks",
"attributes": {
"activity_type": "Call",
"comments_count": 0,
"completed": false,
"completed_at": null,
"created_at": "2018-10-12T19:15:26Z",
"location": "MyString",
"next_action": null,
"notification_time_before": null,
"notification_time_unit": null,
"notification_type": null,
"result": null,
"starred": false,
"start_at": "2012-03-08T12:59:46Z",
"subject": "Call Gregorio Hahn",
"subject_hidden": false,
"tag_list": [
],
"updated_at": "2018-10-12T19:15:26Z",
"updated_in_db_at": "2018-10-12T19:15:26Z"
},
"relationships": {
"comments": {
"data": [
]
},
"contacts": {
"data": [
]
},
"people": {
"data": [
]
},
"email_addresses": {
"data": [
]
},
"phone_numbers": {
"data": [
]
},
"activity_contacts": {
"data": [
]
},
"account_list": {
"data": {
"id": "a6a2d251-2c7e-479b-8663-eb0f773a3e9e",
"type": "account_lists"
}
}
}
}
},
{
"data": {
"id": "a6680373-0ffc-4eef-9435-0c964a801696",
"type": "tasks",
"attributes": {
"activity_type": "Call",
"comments_count": 0,
"completed": false,
"completed_at": null,
"created_at": "2018-10-12T19:15:26Z",
"location": "MyString",
"next_action": null,
"notification_time_before": null,
"notification_time_unit": null,
"notification_type": null,
"result": null,
"starred": false,
"start_at": "2012-03-08T12:59:46Z",
"subject": "Call Lesly Dach Jr.",
"subject_hidden": false,
"tag_list": [
],
"updated_at": "2018-10-12T19:15:26Z",
"updated_in_db_at": "2018-10-12T19:15:26Z"
},
"relationships": {
"comments": {
"data": [
]
},
"contacts": {
"data": [
]
},
"people": {
"data": [
]
},
"email_addresses": {
"data": [
]
},
"phone_numbers": {
"data": [
]
},
"activity_contacts": {
"data": [
]
},
"account_list": {
"data": {
"id": "a6a2d251-2c7e-479b-8663-eb0f773a3e9e",
"type": "account_lists"
}
}
}
}
}
]
Fields
| Name | Type | Description |
|---|---|---|
data |
[Task] |
An array of Tasks that have just been deleted |
Tasks [BULK POST]
Tasks [BULK POST]
Request
Endpoint
POST /api/v2/tasks/bulk
Content-Type: application/vnd.api+json
POST /api/v2/tasks/bulk
Parameters
{
"data": [
{
"data": {
"type": "tasks",
"id": "38879c53-5054-4c00-86db-dd094bad73c2",
"attributes": {
"starred": false,
"location": "MyString",
"subject": "Call Margarett Reinger",
"start_at": "2012-03-08 14:59:46",
"activity_type": "Call",
"result": null,
"completed_at": null,
"updated_in_db_at": "2018-10-12 21:15:26 +0200"
},
"relationships": {
"account_list": {
"data": {
"id": "5bfc1c53-6e26-4aca-9e4c-458c841bc501",
"type": "account_lists"
}
}
}
}
}
]
}
| Name | Type | Description | Required |
|---|---|---|---|
data |
[Task] |
An array of Tasks to be created | true |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
[
{
"data": {
"id": "38879c53-5054-4c00-86db-dd094bad73c2",
"type": "tasks",
"attributes": {
"activity_type": "Call",
"comments_count": 0,
"completed": false,
"completed_at": null,
"created_at": "2018-10-12T19:15:26Z",
"location": "MyString",
"next_action": null,
"notification_time_before": null,
"notification_time_unit": null,
"notification_type": null,
"result": null,
"starred": false,
"start_at": "2012-03-08T12:59:46Z",
"subject": "Call Margarett Reinger",
"subject_hidden": false,
"tag_list": [
],
"updated_at": "2018-10-12T19:15:26Z",
"updated_in_db_at": "2018-10-12T19:15:26Z"
},
"relationships": {
"comments": {
"data": [
]
},
"contacts": {
"data": [
]
},
"people": {
"data": [
]
},
"email_addresses": {
"data": [
]
},
"phone_numbers": {
"data": [
]
},
"activity_contacts": {
"data": [
]
},
"account_list": {
"data": {
"id": "5bfc1c53-6e26-4aca-9e4c-458c841bc501",
"type": "account_lists"
}
}
}
}
}
]
Fields
| Name | Type | Description |
|---|---|---|
data |
[Task / error] |
List of Task objects that have been successfully updated and list of errors related to Task objects that were not updated successfully |
Tasks [BULK PUT]
Tasks [BULK PUT]
Request
Endpoint
PUT /api/v2/tasks/bulk
Content-Type: application/vnd.api+json
PUT /api/v2/tasks/bulk
Parameters
{
"data": [
{
"data": {
"type": "tasks",
"id": "9312ecfc-864a-43f2-a763-8fd6b88ff11c",
"attributes": {
"starred": false,
"location": "MyString",
"subject": "Call Hailey Mraz MD",
"start_at": "2012-03-08 14:59:46",
"activity_type": "Call",
"result": null,
"completed_at": null,
"updated_in_db_at": "2018-10-12 21:15:26 +0200"
}
}
}
]
}
| Name | Type | Description | Required |
|---|---|---|---|
data |
[Task] |
An array of Tasks to be updated | true |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
[
{
"data": {
"id": "9312ecfc-864a-43f2-a763-8fd6b88ff11c",
"type": "tasks",
"attributes": {
"activity_type": "Call",
"comments_count": 0,
"completed": false,
"completed_at": null,
"created_at": "2018-10-12T19:15:26Z",
"location": "MyString",
"next_action": null,
"notification_time_before": null,
"notification_time_unit": null,
"notification_type": null,
"result": null,
"starred": false,
"start_at": "2012-03-08T12:59:46Z",
"subject": "Call Hailey Mraz MD",
"subject_hidden": false,
"tag_list": [
],
"updated_at": "2018-10-12T19:15:26Z",
"updated_in_db_at": "2018-10-12T19:15:26Z"
},
"relationships": {
"comments": {
"data": [
]
},
"contacts": {
"data": [
]
},
"people": {
"data": [
]
},
"email_addresses": {
"data": [
]
},
"phone_numbers": {
"data": [
]
},
"activity_contacts": {
"data": [
]
},
"account_list": {
"data": {
"id": "0d6d116b-477e-483b-9eb3-da1e8d514020",
"type": "account_lists"
}
}
}
}
}
]
Fields
| Name | Type | Description |
|---|---|---|
data |
[Task / error] |
Array of both Task objects that have been successfully updated and of errors related to Contact objects that were not updated successfully |
User
Retrieve the current user
The current_user
Request
Endpoint
GET /api/v2/user
Content-Type: application/vnd.api+json
GET /api/v2/user
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "7f71ee49-c1cf-47ab-862d-67a2e7159932",
"type": "users",
"attributes": {
"anniversary_day": null,
"anniversary_month": null,
"anniversary_year": null,
"avatar": "https://mpdx.org/images/avatar.png",
"birthday_day": null,
"birthday_month": null,
"birthday_year": null,
"created_at": "2018-10-12T19:15:33Z",
"deceased": false,
"employer": null,
"first_name": "Marcelle",
"gender": null,
"last_name": null,
"legal_first_name": null,
"marital_status": null,
"middle_name": null,
"occupation": null,
"optout_enewsletter": false,
"parent_contacts": [
],
"preferences": {
"time_zone": "Auckland",
"locale": "en",
"default_account_list": null,
"setup": "no default_account_list"
},
"suffix": null,
"title": null,
"updated_at": "2018-10-12T19:15:33Z",
"updated_in_db_at": "2018-10-12T19:15:33Z"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "f35f7e56-ddef-407d-81f4-c3344654ef38",
"type": "email_addresses"
}
]
},
"facebook_accounts": {
"data": [
]
},
"family_relationships": {
"data": [
]
},
"linkedin_accounts": {
"data": [
]
},
"phone_numbers": {
"data": [
]
},
"twitter_accounts": {
"data": [
]
},
"websites": {
"data": [
]
},
"account_lists": {
"data": [
{
"id": "ff0e5fd1-b38f-4f1e-9fc1-bc6f8a16af16",
"type": "account_lists"
}
]
},
"master_person": {
"data": {
"id": "06642bbf-0a80-4960-b70e-18f569be0536",
"type": "master_person"
}
}
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
attributes |
Object |
User object |
| Relationships | ||
relationships |
Array[Object] |
list of relationships related to that User |
Update the current user
Update the current_user
Request
Endpoint
PUT /api/v2/user
Content-Type: application/vnd.api+json
PUT /api/v2/user
Parameters
{
"data": {
"type": "users",
"attributes": {
"first_name": "Frida",
"preferences": {
"time_zone": "Pretoria"
},
"updated_in_db_at": "2018-10-12 21:15:33 +0200"
}
}
}
| Name | Type | Description | Required |
|---|---|---|---|
| Filters | |||
filter[contacts_filter] |
String |
Contacts Filter | - |
filter[tasks_filter] |
String |
Tasks Filter | - |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "96cb9a28-3e67-40a4-bfd1-3d506040db92",
"type": "users",
"attributes": {
"anniversary_day": null,
"anniversary_month": null,
"anniversary_year": null,
"avatar": "https://mpdx.org/images/avatar.png",
"birthday_day": null,
"birthday_month": null,
"birthday_year": null,
"created_at": "2018-10-12T19:15:33Z",
"deceased": false,
"employer": null,
"first_name": "Frida",
"gender": null,
"last_name": null,
"legal_first_name": null,
"marital_status": null,
"middle_name": null,
"occupation": null,
"optout_enewsletter": false,
"parent_contacts": [
],
"preferences": {
"time_zone": "Pretoria",
"locale": "en",
"default_account_list": null,
"setup": "no default_account_list"
},
"suffix": null,
"title": null,
"updated_at": "2018-10-12T19:15:33Z",
"updated_in_db_at": "2018-10-12T19:15:33Z"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "bafffffd-1f7b-4242-b567-f046f651902a",
"type": "email_addresses"
}
]
},
"facebook_accounts": {
"data": [
]
},
"family_relationships": {
"data": [
]
},
"linkedin_accounts": {
"data": [
]
},
"phone_numbers": {
"data": [
]
},
"twitter_accounts": {
"data": [
]
},
"websites": {
"data": [
]
},
"account_lists": {
"data": [
{
"id": "d7b8e426-ac1c-459b-bc51-846fdb5b044d",
"type": "account_lists"
}
]
},
"master_person": {
"data": {
"id": "b97203c1-172f-495a-85b4-72261d9dbb02",
"type": "master_person"
}
}
}
}
}
Account Lists Api
Analytics
Analytics for a custom date range [GET]
List analytics related to the Account List with a start and end date
Request
Endpoint
GET /api/v2/account_lists/cffdf1e7-1388-486f-9644-fbd06dcec94b/analytics?filter[start_date]=2018-10-05T21%3A14%3A49%2B02%3A00&filter[end_date]=2018-10-12T21%3A14%3A49%2B02%3A00
Content-Type: application/vnd.api+json
GET /api/v2/account_lists/:account_list_id/analytics
Parameters
filter: {"start_date"=>"2018-10-05T21:14:49+02:00", "end_date"=>"2018-10-12T21:14:49+02:00"}
| Name | Type | Description | Required |
|---|---|---|---|
| Filters | |||
filter[filter[start_date]] |
- |
Starting Date for Analytics, in ISO8601 | - |
filter[filter[end_date]] |
- |
Ending Date for Analytics, in ISO8601 | - |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "",
"type": "account_list_analytics",
"attributes": {
"appointments": {
"completed": 0
},
"contacts": {
"active": 0,
"referrals": 0,
"referrals_on_hand": 0
},
"correspondence": {
"precall": 0,
"reminders": 0,
"support_letters": 0,
"thank_yous": 0
},
"created_at": "2018-10-12T19:14:49Z",
"electronic": {
"appointments": 0,
"received": 0,
"sent": 0
},
"email": {
"received": 0,
"sent": 0
},
"end_date": "2018-10-12T19:14:49Z",
"facebook": {
"received": 0,
"sent": 0
},
"phone": {
"appointments": 0,
"attempted": 0,
"completed": 0,
"received": 0,
"talktoinperson": 0
},
"start_date": "2018-09-12T19:14:49Z",
"text_message": {
"received": 0,
"sent": 0
},
"updated_at": null,
"updated_in_db_at": null
}
}
}
Fields
| Name | Type | Description |
|---|
Analytics for the past 30 days [GET]
List analytics related to the Account List for the past 30 days
Request
Endpoint
GET /api/v2/account_lists/de2dd4f8-080d-4ace-a381-eeaa78ce1631/analytics
Content-Type: application/vnd.api+json
GET /api/v2/account_lists/:account_list_id/analytics
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| Filters | |||
filter[filter[start_date]] |
- |
Starting Date for Analytics, in ISO8601 | - |
filter[filter[end_date]] |
- |
Ending Date for Analytics, in ISO8601 | - |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "",
"type": "account_list_analytics",
"attributes": {
"appointments": {
"completed": 0
},
"contacts": {
"active": 0,
"referrals": 0,
"referrals_on_hand": 0
},
"correspondence": {
"precall": 0,
"reminders": 0,
"support_letters": 0,
"thank_yous": 0
},
"created_at": "2018-10-12T19:14:49Z",
"electronic": {
"appointments": 0,
"received": 0,
"sent": 0
},
"email": {
"received": 0,
"sent": 0
},
"end_date": "2018-10-12T19:14:49Z",
"facebook": {
"received": 0,
"sent": 0
},
"phone": {
"appointments": 0,
"attempted": 0,
"completed": 0,
"received": 0,
"talktoinperson": 0
},
"start_date": "2018-09-12T19:14:49Z",
"text_message": {
"received": 0,
"sent": 0
},
"updated_at": null,
"updated_in_db_at": null
}
}
}
Fields
| Name | Type | Description |
|---|
Chalkline Mail
ChalkLine Mail [CREATE]
Enqueues a job that will send ChalkLine Mail for this Account List
Request
Endpoint
POST /api/v2/account_lists/d1ca6512-b23e-4628-907c-af5135b9ab0e/chalkline_mail
Content-Type: application/vnd.api+json
POST /api/v2/account_lists/:account_list_id/chalkline_mail
Parameters
{
"data": {
"type": "chalkline_mails"
}
}
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
{
"data": {
"id": "",
"type": "chalkline_mails",
"attributes": {
"created_at": "2018-10-12T19:14:49Z",
"updated_at": null,
"updated_in_db_at": null
}
}
}
Designation Accounts
Designation Account [LIST]
Designation Account [LIST]
Request
Endpoint
GET /api/v2/account_lists/1dca547c-92da-4ab1-9378-0ec51e391382/designation_accounts
Content-Type: application/vnd.api+json
GET /api/v2/account_lists/:account_list_id/designation_accounts
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| Filters | |||
filter[account_list_id] |
id string |
Filter by Account List; accepts an Account List id |
- |
filter[wildcard_search] |
string |
where name contains or designation_number starts with wildcard_search | - |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": [
{
"id": "d63718bc-4a31-4b39-ab6c-afd551a12c00",
"type": "designation_accounts",
"attributes": {
"active": true,
"balance": "9.99",
"balance_updated_at": null,
"converted_balance": 9.99,
"created_at": "-4713-12-31T22:08:00Z",
"currency": "USD",
"currency_symbol": "$",
"designation_number": "1",
"display_name": "Designation Name (1)",
"exchange_rate": 1.0,
"name": "Designation Name",
"organization_name": "Organization15",
"updated_at": "-4713-12-31T22:08:00Z",
"updated_in_db_at": "-4713-12-31T22:08:00Z"
},
"relationships": {
"organization": {
"data": {
"id": "67e6760a-60ed-4543-ae3a-a7eb41cf7e1d",
"type": "organizations"
}
},
"balances": {
"data": [
{
"id": "982c1b1b-88a4-40a6-acd5-50c77f04b7f4",
"type": "balances"
}
]
}
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 1,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
data |
[Designation Account] |
An array of Designation Account Objects |
Designation Account [PUT]
Designation Account [PUT]
Request
Endpoint
PUT /api/v2/account_lists/c2be0b55-8dad-4857-bcb4-7e0eef26aa6a/designation_accounts/e1894446-3d68-4240-badc-06bae8752b2e
Content-Type: application/vnd.api+json
PUT /api/v2/account_lists/:account_list_id/designation_accounts/:id
Parameters
{
"data": {
"type": "designation_accounts",
"attributes": {
"active": true,
"overwrite": true
}
}
}
| Name | Type | Description | Required |
|---|---|---|---|
| Attributes | |||
active |
boolean |
If this designation_account is active then the balance should be added into the profile total | - |
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created | - |
overwrite |
boolean |
Only used for updating a record where you want to ignore the server’s ’ ’updated_in_db_at value and force overwrite the values for the record. ’ ‘Must be true to work. |
- |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated | - |
updated_in_db_at |
ISO8601 timestamp |
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. | true |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "e1894446-3d68-4240-badc-06bae8752b2e",
"type": "designation_accounts",
"attributes": {
"active": true,
"balance": "9.99",
"balance_updated_at": null,
"converted_balance": 9.99,
"created_at": "-4713-12-31T22:08:00Z",
"currency": "USD",
"currency_symbol": "$",
"designation_number": "3",
"display_name": "Designation Name (3)",
"exchange_rate": 1.0,
"name": "Designation Name",
"organization_name": "Organization21",
"updated_at": "-4713-12-31T22:08:00Z",
"updated_in_db_at": "-4713-12-31T22:08:00Z"
},
"relationships": {
"organization": {
"data": {
"id": "71407555-6488-4766-a57b-bec5285cd4ed",
"type": "organizations"
}
},
"balances": {
"data": [
{
"id": "d14eed4b-e50c-4c2f-ba26-d11c9d147d65",
"type": "balances"
}
]
}
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
active |
boolean |
If this designation_account is active then the balance should be added into the profile total |
balance |
number |
The balance in its native currency |
balance_updated_at |
string |
The DateTime when the balance was updated |
converted_balance |
number |
The balance in the account_list default currency |
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
currency |
string |
The native currency of the designation_account |
currency_symbol |
string |
The native currency symbol of the designation_account |
designation_number |
string |
The remote system designation number |
display_name |
string |
The name to display |
exchange_rate |
number |
The exchange rate from the native currency to the account_list default currency |
name |
float |
The name of the designation |
organization_name |
string |
The name of the organization this designation belongs to |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
| Relationships | ||
organization.data |
Organization |
The Organization the designation account belongs to |
should eq 200
The Designation Account with the given ID
Request
Endpoint
GET /api/v2/account_lists/45c2399b-67f7-45ef-b3fe-8e94b75d2bdb/designation_accounts/23041709-9b1b-4957-9a5d-0f2964fb8970
Content-Type: application/vnd.api+json
GET /api/v2/account_lists/:account_list_id/designation_accounts/:id
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "23041709-9b1b-4957-9a5d-0f2964fb8970",
"type": "designation_accounts",
"attributes": {
"active": true,
"balance": "9.99",
"balance_updated_at": null,
"converted_balance": 9.99,
"created_at": "-4713-12-31T22:08:00Z",
"currency": "USD",
"currency_symbol": "$",
"designation_number": "2",
"display_name": "Designation Name (2)",
"exchange_rate": 1.0,
"name": "Designation Name",
"organization_name": "Organization18",
"updated_at": "-4713-12-31T22:08:00Z",
"updated_in_db_at": "-4713-12-31T22:08:00Z"
},
"relationships": {
"organization": {
"data": {
"id": "d2496bed-355b-43a5-b8ed-8ecf23288766",
"type": "organizations"
}
},
"balances": {
"data": [
{
"id": "844d02d8-6962-4d5e-91e2-72535430a2ce",
"type": "balances"
}
]
}
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
Donations
Donation [CREATE]
Creates a new Donation associated with the Account List
Request
Endpoint
POST /api/v2/account_lists/3c1e20f7-bf8d-4707-b201-b9d4acd42179/donations
Content-Type: application/vnd.api+json
POST /api/v2/account_lists/:account_list_id/donations
Parameters
{
"data": {
"type": "donations",
"attributes": {
"amount": 10.0,
"appeal_amount": "0.00",
"channel": "MyString",
"currency": "ZAR",
"donation_date": "2018-10-12",
"memo": "MyText",
"motivation": "MyString",
"payment_method": "MyString",
"payment_type": "MyString",
"tendered_amount": "9.99",
"tendered_currency": "ZAR",
"updated_in_db_at": "2018-10-12 21:14:51 +0200"
},
"relationships": {
"donor_account": {
"data": {
"type": "donor_accounts",
"id": "e2ccb5e3-891c-4e3c-8af1-2ef66ed9bd1f"
}
},
"designation_account": {
"data": {
"type": "designation_accounts",
"id": "08d6092b-c6e2-48a0-8d3f-91956fe5e8b1"
}
}
}
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
{
"data": {
"id": "2b1351ba-30f4-4694-9080-4d93d221b6e0",
"type": "donations",
"attributes": {
"amount": "10.0",
"appeal_amount": "0.0",
"channel": "MyString",
"converted_amount": 10.0,
"converted_appeal_amount": 10.0,
"converted_currency": "USD",
"created_at": "2018-10-12T19:14:51Z",
"currency": "ZAR",
"donation_date": "2018-10-12",
"memo": "MyText",
"motivation": "MyString",
"payment_method": "MyString",
"payment_type": "MyString",
"remote_id": null,
"tendered_amount": "9.99",
"tendered_currency": "ZAR",
"updated_at": "2018-10-12T19:14:51Z",
"updated_in_db_at": "2018-10-12T19:14:51Z"
},
"relationships": {
"appeal": {
"data": null
},
"contact": {
"data": {
"id": "3ee8bc01-8313-4614-95fd-0ba37d1fb9f9",
"type": "contacts"
}
},
"designation_account": {
"data": {
"id": "08d6092b-c6e2-48a0-8d3f-91956fe5e8b1",
"type": "designation_accounts"
}
},
"donor_account": {
"data": {
"id": "e2ccb5e3-891c-4e3c-8af1-2ef66ed9bd1f",
"type": "donor_accounts"
}
},
"pledge": {
"data": null
}
}
}
}
Donation [DELETE]
Deletes the Donation associated with the Account List
Request
Endpoint
DELETE /api/v2/account_lists/a3e54fa1-11d8-4a58-902e-813857191536/donations/a78cfeba-ea77-49a5-b2f4-0f1a4c8e2ded
Content-Type: application/vnd.api+json
DELETE /api/v2/account_lists/:account_list_id/donations/:id
Parameters
| Name | Type | Description | Required |
|---|
Response
204 No Content
Donation [GET]
The Account List Donation with the given ID
Request
Endpoint
GET /api/v2/account_lists/016442be-2f33-48be-b969-abae8fba2c06/donations/07334d63-afa4-4143-96ad-41e43eabc1f2
Content-Type: application/vnd.api+json
GET /api/v2/account_lists/:account_list_id/donations/:id
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "07334d63-afa4-4143-96ad-41e43eabc1f2",
"type": "donations",
"attributes": {
"amount": "10.0",
"appeal_amount": "0.0",
"channel": "MyString",
"converted_amount": 10.0,
"converted_appeal_amount": 10.0,
"converted_currency": "USD",
"created_at": "2018-10-12T19:14:51Z",
"currency": "ZAR",
"donation_date": "2018-10-12",
"memo": "MyText",
"motivation": "MyString",
"payment_method": "MyString",
"payment_type": "MyString",
"remote_id": "3",
"tendered_amount": "9.99",
"tendered_currency": "ZAR",
"updated_at": "2018-10-12T19:14:51Z",
"updated_in_db_at": "2018-10-12T19:14:51Z"
},
"relationships": {
"appeal": {
"data": null
},
"contact": {
"data": {
"id": "9f0f4051-2eed-4664-8538-8894832cd600",
"type": "contacts"
}
},
"designation_account": {
"data": {
"id": "0cf1ce78-3e58-4db7-9107-cb0dd95ec07a",
"type": "designation_accounts"
}
},
"donor_account": {
"data": {
"id": "2ee34350-8eb6-4e68-96cb-ac6df441b5e8",
"type": "donor_accounts"
}
},
"pledge": {
"data": null
}
}
}
}
Fields
| Name | Type | Description |
|---|
Donation [LIST]
List of Donations associated with the the Account List
Request
Endpoint
GET /api/v2/account_lists/0ffaf14f-c8bb-4fd5-ad80-3631e7c2defa/donations
Content-Type: application/vnd.api+json
GET /api/v2/account_lists/:account_list_id/donations
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| Filters | |||
filter[filter[donor_account_id]] |
- |
List of Donor Account Ids | - |
filter[filter[designation_account_id]] |
- |
List of Designation Account Ids | - |
filter[filter[donation_date]] |
- |
A donation date range with text value like “YYYY-MM-DD…YYYY-MM-DD” | - |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": [
{
"id": "7ca3e712-c91a-46f1-8859-83ecde6f6cc9",
"type": "donations",
"attributes": {
"amount": "10.0",
"appeal_amount": "0.0",
"channel": "MyString",
"converted_amount": 10.0,
"converted_appeal_amount": 10.0,
"converted_currency": "USD",
"created_at": "2018-10-12T19:14:51Z",
"currency": "ZAR",
"donation_date": "2018-10-12",
"memo": "MyText",
"motivation": "MyString",
"payment_method": "MyString",
"payment_type": "MyString",
"remote_id": "1",
"tendered_amount": "9.99",
"tendered_currency": "ZAR",
"updated_at": "2018-10-12T19:14:51Z",
"updated_in_db_at": "2018-10-12T19:14:51Z"
},
"relationships": {
"appeal": {
"data": null
},
"contact": {
"data": {
"id": "a31f49c9-af82-452d-b533-e5d199859021",
"type": "contacts"
}
},
"designation_account": {
"data": {
"id": "1731a1df-fd9c-4d61-9da1-431f4a8d3a57",
"type": "designation_accounts"
}
},
"donor_account": {
"data": {
"id": "aef822cf-c722-45df-83fc-74f8b90c5c11",
"type": "donor_accounts"
}
},
"pledge": {
"data": null
}
}
},
{
"id": "e8dbd526-ce9f-44af-8b67-34904581f198",
"type": "donations",
"attributes": {
"amount": "10.0",
"appeal_amount": "0.0",
"channel": "MyString",
"converted_amount": 10.0,
"converted_appeal_amount": 10.0,
"converted_currency": "USD",
"created_at": "2018-10-12T19:14:51Z",
"currency": "ZAR",
"donation_date": "2018-10-12",
"memo": "MyText",
"motivation": "MyString",
"payment_method": "MyString",
"payment_type": "MyString",
"remote_id": "2",
"tendered_amount": "9.99",
"tendered_currency": "ZAR",
"updated_at": "2018-10-12T19:14:51Z",
"updated_in_db_at": "2018-10-12T19:14:51Z"
},
"relationships": {
"appeal": {
"data": null
},
"contact": {
"data": {
"id": "a31f49c9-af82-452d-b533-e5d199859021",
"type": "contacts"
}
},
"designation_account": {
"data": {
"id": "1731a1df-fd9c-4d61-9da1-431f4a8d3a57",
"type": "designation_accounts"
}
},
"donor_account": {
"data": {
"id": "aef822cf-c722-45df-83fc-74f8b90c5c11",
"type": "donor_accounts"
}
},
"pledge": {
"data": null
}
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 2,
"total_pages": 1
},
"sort": null,
"filter": {
},
"totals": [
{
"amount": "20.0",
"converted": 20.0,
"currency": "ZAR"
}
]
}
}
Fields
| Name | Type | Description |
|---|---|---|
data |
- |
Data |
Donation [UPDATE]
Updates a Donation associated with the Account List
Request
Endpoint
PUT /api/v2/account_lists/394ddb82-c527-4c17-8e09-6872ab6a5885/donations/d09bb32b-db5a-4d9f-8bf3-05953361faa7
Content-Type: application/vnd.api+json
PUT /api/v2/account_lists/:account_list_id/donations/:id
Parameters
{
"data": {
"type": "donations",
"attributes": {
"amount": 10.0,
"appeal_amount": "0.00",
"channel": "MyString",
"currency": "ZAR",
"donation_date": "2018-10-12",
"memo": "MyText",
"motivation": "MyString",
"payment_method": "MyString",
"payment_type": "MyString",
"tendered_amount": "9.99",
"tendered_currency": "ZAR",
"updated_in_db_at": "2018-10-12 21:14:52 +0200"
}
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "d09bb32b-db5a-4d9f-8bf3-05953361faa7",
"type": "donations",
"attributes": {
"amount": "10.0",
"appeal_amount": "0.0",
"channel": "MyString",
"converted_amount": 10.0,
"converted_appeal_amount": 10.0,
"converted_currency": "USD",
"created_at": "2018-10-12T19:14:52Z",
"currency": "ZAR",
"donation_date": "2018-10-12",
"memo": "MyText",
"motivation": "MyString",
"payment_method": "MyString",
"payment_type": "MyString",
"remote_id": "8",
"tendered_amount": "9.99",
"tendered_currency": "ZAR",
"updated_at": "2018-10-12T19:14:52Z",
"updated_in_db_at": "2018-10-12T19:14:52Z"
},
"relationships": {
"appeal": {
"data": null
},
"contact": {
"data": {
"id": "6c1ebe88-dc2c-4ee6-bbe3-9fce50fea3fe",
"type": "contacts"
}
},
"designation_account": {
"data": {
"id": "ecaebe53-0afa-4aea-86aa-60acf665bd5c",
"type": "designation_accounts"
}
},
"donor_account": {
"data": {
"id": "78670818-6bb9-4c83-8ade-61d4f9c9fc5b",
"type": "donor_accounts"
}
},
"pledge": {
"data": null
}
}
}
}
Donor Accounts
Donor Account [GET]
The Account List Donor Account with the given ID
Request
Endpoint
GET /api/v2/account_lists/80c50509-31b7-4c11-8970-2d6949fba47b/donor_accounts/f38c9727-d807-46ab-90f9-cddbe3e40e10
Content-Type: application/vnd.api+json
GET /api/v2/account_lists/:account_list_id/donor_accounts/:id
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "f38c9727-d807-46ab-90f9-cddbe3e40e10",
"type": "donor_accounts",
"attributes": {
"account_number": "MyString",
"created_at": "2018-10-12T19:14:52Z",
"display_name": "Strosin, Waylon (MyString)",
"donor_type": "Type",
"first_donation_date": "2018-10-12",
"last_donation_date": "2018-10-12",
"total_donations": "3.0",
"updated_at": "2018-10-12T19:14:52Z",
"updated_in_db_at": "2018-10-12T19:14:52Z"
},
"relationships": {
"organization": {
"data": {
"id": "03d28894-fccb-483f-bf1d-b5504572d3fa",
"type": "organizations"
}
},
"contacts": {
"data": [
{
"id": "d45dc6ac-5ed8-4709-9267-a9f540b05f92",
"type": "contacts"
}
]
}
}
}
}
Fields
| Name | Type | Description |
|---|
Donor Account [LIST]
List of Donor Accounts associated with the Account List
Request
Endpoint
GET /api/v2/account_lists/1a86e818-0093-4090-b160-f997d8fd21a1/donor_accounts
Content-Type: application/vnd.api+json
GET /api/v2/account_lists/:account_list_id/donor_accounts
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| Filters | |||
filter[filter] |
- |
Filter the list of returned donor_accounts | - |
filter[filter[wildcard_search]] |
- |
where name contains or account_number starts with wildcard_search | - |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": [
{
"id": "f735eb7f-0726-46b8-993d-86a34bfc66b5",
"type": "donor_accounts",
"attributes": {
"account_number": "MyString",
"created_at": "2018-10-12T19:14:52Z",
"display_name": "Bogan, Landen (MyString)",
"donor_type": "Type",
"first_donation_date": "2018-10-12",
"last_donation_date": "2018-10-12",
"total_donations": "3.0",
"updated_at": "2018-10-12T19:14:52Z",
"updated_in_db_at": "2018-10-12T19:14:52Z"
},
"relationships": {
"organization": {
"data": {
"id": "a40d65ee-b88c-4850-a941-81645c772bf3",
"type": "organizations"
}
},
"contacts": {
"data": [
{
"id": "91ff0de8-feb0-45ef-8914-383f3c31b4bc",
"type": "contacts"
}
]
}
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 1,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
data |
Array[Object] |
Data |
Imports
Import [GET]
Creates a new Import associated with the Account List. This endpoint accepts a file to be uploaded using Content-Type “multipart/form-data”, this makes the endpoint unique in that it does not only accept JSON content. Unless otherwise specified, the Import will be created with “in_preview” set to false, which will cause the import to begin after being created (the import runs asynchronously as a background job).
Request
Endpoint
GET /api/v2/account_lists/10ea84d1-38d1-4fdf-92f1-39bc5c1591a7/imports/0fa4347b-3f01-4ffe-ae91-055a148ab7c1
Content-Type: application/vnd.api+json
GET /api/v2/account_lists/:account_list_id/imports/:id
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "0fa4347b-3f01-4ffe-ae91-055a148ab7c1",
"type": "imports",
"attributes": {
"account_list_id": "10ea84d1-38d1-4fdf-92f1-39bc5c1591a7",
"created_at": "2018-10-12T19:14:55Z",
"file_constants": {
},
"file_constants_mappings": {
},
"file_headers": {
},
"file_headers_mappings": {
},
"file_url": null,
"group_tags": null,
"groups": [
],
"import_by_group": false,
"in_preview": false,
"override": false,
"source": "twitter",
"tag_list": null,
"updated_at": "2018-10-12T19:14:55Z",
"updated_in_db_at": "2018-10-12T19:14:55Z"
},
"relationships": {
"user": {
"data": {
"id": "82488602-9ebc-4db0-a401-c2c00805c422",
"type": "users"
}
},
"sample_contacts": {
"data": [
]
}
}
}
}
Fields
| Name | Type | Description |
|---|
CSV Import [CREATE]
Creates a new CSV Import associated with the Account List. This endpoint expects a CSV file to be uploaded using Content-Type “multipart/form-data”, this makes the endpoint unique in that it does not expect only JSON content. Unless otherwise specified, the Import will be created with “in_preview” set to true.
A CSV Import is expected to take multiple steps to setup:
1. The first step is to create a new Import via a POST request, the client can upload the CSV file in the POST request using “multipart/form-data”. If the file upload is successful then the file_headers and file_constants will be returned to the client in the response.
2. In the second step the client is expected to update (via PUT) the file_headers_mappings according to the user’s desire (based on the file_headers). This step could take several attempts.
3. In the third step the client is expected to update (via PUT) the file_constants_mappings according to the user’s desire (based on the file_constants). This step could take several attempts.
4. The fourth step is to show a sample of the import to the user. The sample_contacts relationship should be used.
5. The fifth step is to start the import. The client is expected to update (via PUT) the “in_preview” attribute to “false”, which will trigger the import to begin (as a background job). If the mappings are incorrect or incomplete, or the record is otherwise invalid, then the import will not begin and an error object will be returned instead.
Request
Endpoint
POST /api/v2/account_lists/61290902-25ea-48ab-870d-a244bc19c4db/imports/csv
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
POST /api/v2/account_lists/:account_list_id/imports/csv
Parameters
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][city]"
city
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][pledge_amount]"
amount
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][pledge_frequency]"
frequency
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][contact_name]"
fname
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][country]"
country
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][email_1]"
email_address
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][envelope_greeting]"
envelope_greeting
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][first_name]"
fname
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][greeting]"
greeting
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][last_name]"
lname
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][newsletter]"
newsletter
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][notes]"
extra_notes
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][phone_1]"
phone
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][spouse_email]"
spouse_email_address
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][spouse_first_name]"
spouse_fname
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][spouse_last_name]"
spouse_lname
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][spouse_phone]"
spouse_phone_number
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][state]"
province
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][status]"
status
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][street]"
street
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][zip]"
zip_code
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_constants_mappings][status][][id]"
Partner - Financial
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_constants_mappings][status][][values][]"
Praying and giving
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_constants_mappings][pledge_frequency][][id]"
1.0
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_constants_mappings][pledge_frequency][][values][]"
Monthly
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_constants_mappings][newsletter][][id]"
Both
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_constants_mappings][newsletter][][values][]"
Both
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][created_at]"
2018-10-12 21:14:53 +0200
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][error]"
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file]"; filename="sample_csv_with_custom_headers.csv"
Content-Type: text/plain
Content-Length: 1004
[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][group_tags]"
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][import_by_group]"
false
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][import_completed_at]"
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][import_started_at]"
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][importing]"
false
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][override]"
false
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][queued_for_import_at]"
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][source]"
csv
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][tags]"
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][updated_at]"
2018-10-12 21:14:53 +0200
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][updated_in_db_at]"
2018-10-12 21:14:53 +0200
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[type]"
imports
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[relationships][account_list][data][type]"
account_lists
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[relationships][account_list][data][id]"
61290902-25ea-48ab-870d-a244bc19c4db
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[relationships][user][data][type]"
users
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[relationships][user][data][id]"
05fce741-4c76-4cdc-ac11-6e980ad137db
------------XnJLe9ZIbbGUYtzPQJ16u1--
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
{
"data": {
"id": "79e5e589-8fba-4de6-bfaf-d2d5ac9d5ce1",
"type": "imports",
"attributes": {
"account_list_id": "61290902-25ea-48ab-870d-a244bc19c4db",
"created_at": "2018-10-12T19:14:53Z",
"file_constants": {
"greeting": [
"Hi John and Jane",
"Hello!",
""
],
"status": [
"Praying",
"Praying and giving"
],
"amount": [
"50",
"10",
""
],
"frequency": [
"Monthly",
""
],
"currency": [
"CAD",
""
],
"newsletter": [
"Both"
],
"skip": [
"No",
"Yes",
""
],
"likely_giver": [
"Yes",
"No"
],
"appeals": [
"Yes",
"No"
]
},
"file_constants_mappings": {
"status": [
{
"id": "Partner - Financial",
"values": [
"Praying and giving"
]
}
],
"pledge_frequency": [
{
"id": "1.0",
"values": [
"Monthly"
]
}
],
"newsletter": [
{
"id": "Both",
"values": [
"Both"
]
}
]
},
"file_headers": {
"fullname": "fullname",
"fname": "fname",
"lname": "lname",
"spouse_fname": "Spouse-fname",
"spouse_lname": "Spouse-lname",
"greeting": "greeting",
"mailing_greeting": "mailing-greeting",
"church": "church",
"street": "street",
"city": "city",
"province": "province",
"zip_code": "zip-code",
"country": "country",
"status": "status",
"amount": "amount",
"frequency": "frequency",
"currency": "currency",
"newsletter": "newsletter",
"tags": "tags",
"email_address": "email-address",
"spouse_email_address": "Spouse-email-address",
"phone": "phone",
"spouse_phone_number": "Spouse-phone-number",
"extra_notes": "extra-notes",
"skip": "skip",
"likely_giver": "likely-giver",
"metro": "metro",
"region": "region",
"appeals": "appeals",
"website": "website",
"referred_by": "referred_by"
},
"file_headers_mappings": {
"city": "city",
"pledge_amount": "amount",
"pledge_frequency": "frequency",
"contact_name": "fname",
"country": "country",
"email_1": "email_address",
"envelope_greeting": "envelope_greeting",
"first_name": "fname",
"greeting": "greeting",
"last_name": "lname",
"newsletter": "newsletter",
"notes": "extra_notes",
"phone_1": "phone",
"spouse_email": "spouse_email_address",
"spouse_first_name": "spouse_fname",
"spouse_last_name": "spouse_lname",
"spouse_phone": "spouse_phone_number",
"state": "province",
"status": "status",
"street": "street",
"zip": "zip_code"
},
"file_url": "/uploads/import/file/79e5e589-8fba-4de6-bfaf-d2d5ac9d5ce1/sample_csv_with_custom_headers.csv",
"group_tags": null,
"groups": [
],
"import_by_group": false,
"in_preview": true,
"override": false,
"source": "csv",
"tag_list": null,
"updated_at": "2018-10-12T19:14:54Z",
"updated_in_db_at": "2018-10-12T19:14:54Z"
},
"relationships": {
"user": {
"data": {
"id": "05fce741-4c76-4cdc-ac11-6e980ad137db",
"type": "users"
}
},
"sample_contacts": {
"data": [
{
"id": "3f4126da-96db-461b-bc57-fda8f449b804",
"type": "contacts"
},
{
"id": "0185e208-9c0b-4a0e-a325-7b03983239a8",
"type": "contacts"
},
{
"id": "cf41469c-9bb5-4639-8c5f-b070baed429b",
"type": "contacts"
}
]
}
}
}
}
Fields
| Name | Type | Description |
|---|
CSV Import [GET]
The Import with the given ID
Request
Endpoint
GET /api/v2/account_lists/34545043-f197-40a5-b46c-6ec4c60cf516/imports/csv/ff9e17ec-b43d-414c-959a-6e96c455c4e6
Content-Type: multipart/form-data
GET /api/v2/account_lists/:account_list_id/imports/csv/:id
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "ff9e17ec-b43d-414c-959a-6e96c455c4e6",
"type": "imports",
"attributes": {
"account_list_id": "34545043-f197-40a5-b46c-6ec4c60cf516",
"created_at": "2018-10-12T19:14:53Z",
"file_constants": {
},
"file_constants_mappings": {
"status": [
{
"id": "Partner - Financial",
"values": [
"Praying and giving"
]
}
],
"pledge_frequency": [
{
"id": "1.0",
"values": [
"Monthly"
]
}
],
"newsletter": [
{
"id": "Both",
"values": [
"Both"
]
}
]
},
"file_headers": {
},
"file_headers_mappings": {
"city": "city",
"pledge_amount": "amount",
"pledge_frequency": "frequency",
"contact_name": "fname",
"country": "country",
"email_1": "email_address",
"envelope_greeting": "envelope_greeting",
"first_name": "fname",
"greeting": "greeting",
"last_name": "lname",
"newsletter": "newsletter",
"notes": "extra_notes",
"phone_1": "phone",
"spouse_email": "spouse_email_address",
"spouse_first_name": "spouse_fname",
"spouse_last_name": "spouse_lname",
"spouse_phone": "spouse_phone_number",
"state": "province",
"status": "status",
"street": "street",
"zip": "zip_code"
},
"file_url": "/uploads/import/file/ff9e17ec-b43d-414c-959a-6e96c455c4e6/sample_csv_to_import.csv",
"group_tags": null,
"groups": [
],
"import_by_group": false,
"in_preview": true,
"override": false,
"source": "csv",
"tag_list": null,
"updated_at": "2018-10-12T19:14:53Z",
"updated_in_db_at": "2018-10-12T19:14:53Z"
},
"relationships": {
"user": {
"data": {
"id": "c84977fc-fb58-460c-9911-580ada0408ad",
"type": "users"
}
},
"sample_contacts": {
"data": [
]
}
}
}
}
Fields
| Name | Type | Description |
|---|
CSV Import [LIST]
List of CSV Imports associated with the Account List
Request
Endpoint
GET /api/v2/account_lists/777bb4ce-635e-45de-ba38-58e42a6648c7/imports/csv
Content-Type: multipart/form-data
GET /api/v2/account_lists/:account_list_id/imports/csv
Parameters
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": [
{
"id": "d5b17290-54e1-4cb8-ac88-19840dcf14de",
"type": "imports",
"attributes": {
"account_list_id": "777bb4ce-635e-45de-ba38-58e42a6648c7",
"created_at": "2018-10-12T19:14:52Z",
"file_constants": {
},
"file_constants_mappings": {
"status": [
{
"id": "Partner - Financial",
"values": [
"Praying and giving"
]
}
],
"pledge_frequency": [
{
"id": "1.0",
"values": [
"Monthly"
]
}
],
"newsletter": [
{
"id": "Both",
"values": [
"Both"
]
}
]
},
"file_headers": {
},
"file_headers_mappings": {
"city": "city",
"pledge_amount": "amount",
"pledge_frequency": "frequency",
"contact_name": "fname",
"country": "country",
"email_1": "email_address",
"envelope_greeting": "envelope_greeting",
"first_name": "fname",
"greeting": "greeting",
"last_name": "lname",
"newsletter": "newsletter",
"notes": "extra_notes",
"phone_1": "phone",
"spouse_email": "spouse_email_address",
"spouse_first_name": "spouse_fname",
"spouse_last_name": "spouse_lname",
"spouse_phone": "spouse_phone_number",
"state": "province",
"status": "status",
"street": "street",
"zip": "zip_code"
},
"file_url": "/uploads/import/file/d5b17290-54e1-4cb8-ac88-19840dcf14de/sample_csv_to_import.csv",
"group_tags": null,
"groups": [
],
"import_by_group": false,
"in_preview": true,
"override": false,
"source": "csv",
"tag_list": null,
"updated_at": "2018-10-12T19:14:52Z",
"updated_in_db_at": "2018-10-12T19:14:52Z"
},
"relationships": {
"user": {
"data": {
"id": "bcedbc11-4ee5-4532-beb4-aa792b39e4e5",
"type": "users"
}
},
"sample_contacts": {
"data": [
]
}
}
},
{
"id": "00798913-b080-41b4-9104-0aced0502f28",
"type": "imports",
"attributes": {
"account_list_id": "777bb4ce-635e-45de-ba38-58e42a6648c7",
"created_at": "2018-10-12T19:14:52Z",
"file_constants": {
},
"file_constants_mappings": {
"status": [
{
"id": "Partner - Financial",
"values": [
"Praying and giving"
]
}
],
"pledge_frequency": [
{
"id": "1.0",
"values": [
"Monthly"
]
}
],
"newsletter": [
{
"id": "Both",
"values": [
"Both"
]
}
]
},
"file_headers": {
},
"file_headers_mappings": {
"city": "city",
"pledge_amount": "amount",
"pledge_frequency": "frequency",
"contact_name": "fname",
"country": "country",
"email_1": "email_address",
"envelope_greeting": "envelope_greeting",
"first_name": "fname",
"greeting": "greeting",
"last_name": "lname",
"newsletter": "newsletter",
"notes": "extra_notes",
"phone_1": "phone",
"spouse_email": "spouse_email_address",
"spouse_first_name": "spouse_fname",
"spouse_last_name": "spouse_lname",
"spouse_phone": "spouse_phone_number",
"state": "province",
"status": "status",
"street": "street",
"zip": "zip_code"
},
"file_url": "/uploads/import/file/00798913-b080-41b4-9104-0aced0502f28/sample_csv_to_import.csv",
"group_tags": null,
"groups": [
],
"import_by_group": false,
"in_preview": true,
"override": false,
"source": "csv",
"tag_list": null,
"updated_at": "2018-10-12T19:14:52Z",
"updated_in_db_at": "2018-10-12T19:14:52Z"
},
"relationships": {
"user": {
"data": {
"id": "bcedbc11-4ee5-4532-beb4-aa792b39e4e5",
"type": "users"
}
},
"sample_contacts": {
"data": [
]
}
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 2,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}
CSV Import [UPDATE]
Update a CSV Import associated with the Account List. For more details regarding the CSV Import see the description on the create request.
Request
Endpoint
PUT /api/v2/account_lists/a9864492-06b1-4c99-93f6-e0fe03545584/imports/csv/4badb21f-0b1d-4850-b66b-42f4155b7aaa
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
PUT /api/v2/account_lists/:account_list_id/imports/csv/:id
Parameters
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][city]"
city
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][pledge_amount]"
amount
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][pledge_frequency]"
frequency
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][contact_name]"
fname
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][country]"
country
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][email_1]"
email_address
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][envelope_greeting]"
envelope_greeting
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][first_name]"
fname
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][greeting]"
greeting
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][last_name]"
lname
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][newsletter]"
newsletter
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][notes]"
extra_notes
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][phone_1]"
phone
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][spouse_email]"
spouse_email_address
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][spouse_first_name]"
spouse_fname
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][spouse_last_name]"
spouse_lname
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][spouse_phone]"
spouse_phone_number
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][state]"
province
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][status]"
status
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][street]"
street
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_headers_mappings][zip]"
zip_code
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_constants_mappings][status][][id]"
Partner - Financial
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_constants_mappings][status][][values][]"
Praying and giving
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_constants_mappings][pledge_frequency][][id]"
1.0
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_constants_mappings][pledge_frequency][][values][]"
Monthly
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_constants_mappings][newsletter][][id]"
Both
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file_constants_mappings][newsletter][][values][]"
Both
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][created_at]"
2018-10-12 21:14:53 +0200
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][error]"
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file]"; filename="sample_csv_with_custom_headers.csv"
Content-Type: text/plain
Content-Length: 1004
[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][group_tags]"
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][import_by_group]"
false
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][import_completed_at]"
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][import_started_at]"
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][importing]"
false
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][override]"
false
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][queued_for_import_at]"
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][source]"
csv
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][tags]"
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][updated_at]"
2018-10-12 21:14:53 +0200
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][updated_in_db_at]"
2018-10-12 21:14:53 +0200
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[type]"
imports
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[relationships][account_list][data][type]"
account_lists
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[relationships][account_list][data][id]"
a9864492-06b1-4c99-93f6-e0fe03545584
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[relationships][user][data][type]"
users
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[relationships][user][data][id]"
8a26fd66-4d61-424a-8b6f-c684c4df697a
------------XnJLe9ZIbbGUYtzPQJ16u1--
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "4badb21f-0b1d-4850-b66b-42f4155b7aaa",
"type": "imports",
"attributes": {
"account_list_id": "a9864492-06b1-4c99-93f6-e0fe03545584",
"created_at": "2018-10-12T19:14:53Z",
"file_constants": {
"greeting": [
"Hi John and Jane",
"Hello!",
""
],
"status": [
"Praying",
"Praying and giving"
],
"amount": [
"50",
"10",
""
],
"frequency": [
"Monthly",
""
],
"currency": [
"CAD",
""
],
"newsletter": [
"Both"
],
"skip": [
"No",
"Yes",
""
],
"likely_giver": [
"Yes",
"No"
],
"appeals": [
"Yes",
"No"
]
},
"file_constants_mappings": {
"status": [
{
"id": "Partner - Financial",
"values": [
"Praying and giving"
]
}
],
"pledge_frequency": [
{
"id": "1.0",
"values": [
"Monthly"
]
}
],
"newsletter": [
{
"id": "Both",
"values": [
"Both"
]
}
]
},
"file_headers": {
"fullname": "fullname",
"fname": "fname",
"lname": "lname",
"spouse_fname": "Spouse-fname",
"spouse_lname": "Spouse-lname",
"greeting": "greeting",
"mailing_greeting": "mailing-greeting",
"church": "church",
"street": "street",
"city": "city",
"province": "province",
"zip_code": "zip-code",
"country": "country",
"status": "status",
"amount": "amount",
"frequency": "frequency",
"currency": "currency",
"newsletter": "newsletter",
"tags": "tags",
"email_address": "email-address",
"spouse_email_address": "Spouse-email-address",
"phone": "phone",
"spouse_phone_number": "Spouse-phone-number",
"extra_notes": "extra-notes",
"skip": "skip",
"likely_giver": "likely-giver",
"metro": "metro",
"region": "region",
"appeals": "appeals",
"website": "website",
"referred_by": "referred_by"
},
"file_headers_mappings": {
"city": "city",
"pledge_amount": "amount",
"pledge_frequency": "frequency",
"contact_name": "fname",
"country": "country",
"email_1": "email_address",
"envelope_greeting": "envelope_greeting",
"first_name": "fname",
"greeting": "greeting",
"last_name": "lname",
"newsletter": "newsletter",
"notes": "extra_notes",
"phone_1": "phone",
"spouse_email": "spouse_email_address",
"spouse_first_name": "spouse_fname",
"spouse_last_name": "spouse_lname",
"spouse_phone": "spouse_phone_number",
"state": "province",
"status": "status",
"street": "street",
"zip": "zip_code"
},
"file_url": "/uploads/import/file/4badb21f-0b1d-4850-b66b-42f4155b7aaa/sample_csv_with_custom_headers.csv",
"group_tags": null,
"groups": [
],
"import_by_group": false,
"in_preview": true,
"override": false,
"source": "csv",
"tag_list": null,
"updated_at": "2018-10-12T19:14:53Z",
"updated_in_db_at": "2018-10-12T19:14:53Z"
},
"relationships": {
"user": {
"data": {
"id": "8a26fd66-4d61-424a-8b6f-c684c4df697a",
"type": "users"
}
},
"sample_contacts": {
"data": [
{
"id": "c72b7849-7ed9-472c-be08-c84a43dc6a8f",
"type": "contacts"
},
{
"id": "723a78e2-8f8d-497b-9f78-6acabe1e3a81",
"type": "contacts"
},
{
"id": "b8722eb0-d48c-475d-a0c4-dbcc0638f871",
"type": "contacts"
}
]
}
}
}
}
Fields
| Name | Type | Description |
|---|
Google Import [CREATE]
Creates a new Google Import associated with the Account List. Unless otherwise specified, the Import will be created with “in_preview” set to false, which will cause the import to begin after being created (the import runs asynchronously as a background job).
Request
Endpoint
POST /api/v2/account_lists/5d6fbd2f-6c0e-40e1-9bba-ab44bafbd296/imports/google
Content-Type: application/vnd.api+json
POST /api/v2/account_lists/:account_list_id/imports/google
Parameters
{
"data": {
"type": "imports",
"attributes": {
"group_tags": {
"http://www.google.com/m8/feeds/groups/test%40gmail.com/base/6": "my-contacts",
"http://www.google.com/m8/feeds/groups/test%40gmail.com/base/d": "friends"
},
"groups": [
"http://www.google.com/m8/feeds/groups/test%40gmail.com/base/d",
"http://www.google.com/m8/feeds/groups/test%40gmail.com/base/f"
],
"import_by_group": "true",
"in_preview": false,
"override": "true",
"source": "google",
"tag_list": "test,poster"
},
"relationships": {
"source_account": {
"data": {
"type": "google_accounts",
"id": "68a714c4-1754-4a58-be49-cca46ff19aea"
}
}
}
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
{
"data": {
"id": "76f6ba37-246e-4241-b7c6-483d3ba98b19",
"type": "imports",
"attributes": {
"account_list_id": "5d6fbd2f-6c0e-40e1-9bba-ab44bafbd296",
"created_at": "2018-10-12T19:14:54Z",
"file_constants": {
},
"file_constants_mappings": {
},
"file_headers": {
},
"file_headers_mappings": {
},
"file_url": null,
"group_tags": {
"http://www.google.com/m8/feeds/groups/test%40gmail.com/base/6": "my-contacts",
"http://www.google.com/m8/feeds/groups/test%40gmail.com/base/d": "friends"
},
"groups": [
"http://www.google.com/m8/feeds/groups/test%40gmail.com/base/d",
"http://www.google.com/m8/feeds/groups/test%40gmail.com/base/f"
],
"import_by_group": true,
"in_preview": false,
"override": true,
"source": "google",
"tag_list": "test,poster",
"updated_at": "2018-10-12T19:14:54Z",
"updated_in_db_at": "2018-10-12T19:14:54Z"
},
"relationships": {
"user": {
"data": {
"id": "049a52a4-6c0e-460c-a24f-aac5af57a465",
"type": "users"
}
},
"sample_contacts": {
"data": [
]
}
}
}
}
Fields
| Name | Type | Description |
|---|
TNT Data Sync Import [CREATE]
Creates a new TNT Data Sync Import associated with the Account List. This endpoint expects a .tntmpd file to be uploaded using Content-Type “multipart/form-data”, this makes the endpoint unique in that it does not expect JSON content. Unless otherwise specified, the Import will be created with “in_preview” set to false, which will cause the import to begin after being created (the import runs asynchronously as a background job).
Request
Endpoint
POST /api/v2/account_lists/206dc64d-fc81-4be9-b461-9371791253c6/imports/tnt_data_sync
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
POST /api/v2/account_lists/:account_list_id/imports/tnt_data_sync
Parameters
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[type]"
imports
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file]"; filename="tnt_data_sync_no_org_lowercase_fields.tntmpd"
Content-Type: text/plain
Content-Length: 607
[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][importing]"
false
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][source]"
twitter
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[relationships][account_list][data][type]"
account_lists
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[relationships][account_list][data][id]"
206dc64d-fc81-4be9-b461-9371791253c6
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[relationships][user][data][type]"
users
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[relationships][user][data][id]"
e6fd60e9-3ea9-4b5a-8f3c-cce736285462
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[relationships][source_account][data][type]"
facebook_accounts
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[relationships][source_account][data][id]"
de4b6f68-d784-4bba-b96a-01c89bfc39b7
------------XnJLe9ZIbbGUYtzPQJ16u1--
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
{
"data": {
"id": "323a2f85-7262-45ad-b465-ade532c1901b",
"type": "imports",
"attributes": {
"account_list_id": "206dc64d-fc81-4be9-b461-9371791253c6",
"created_at": "2018-10-12T19:14:54Z",
"file_constants": {
},
"file_constants_mappings": {
},
"file_headers": {
},
"file_headers_mappings": {
},
"file_url": "/uploads/import/file/323a2f85-7262-45ad-b465-ade532c1901b/tnt_data_sync_no_org_lowercase_fields.tntmpd",
"group_tags": null,
"groups": [
],
"import_by_group": false,
"in_preview": false,
"override": false,
"source": "tnt_data_sync",
"tag_list": null,
"updated_at": "2018-10-12T19:14:54Z",
"updated_in_db_at": "2018-10-12T19:14:54Z"
},
"relationships": {
"user": {
"data": {
"id": "e6fd60e9-3ea9-4b5a-8f3c-cce736285462",
"type": "users"
}
},
"sample_contacts": {
"data": [
]
}
}
}
}
Fields
| Name | Type | Description |
|---|
TNT XML Import [CREATE]
Creates a new TNT XML Import associated with the Account List. This endpoint expects a TNT file to be uploaded using Content-Type “multipart/form-data”, this makes the endpoint unique in that it does not expect JSON content. Unless otherwise specified, the Import will be created with “in_preview” set to false, which will cause the import to begin after being created (the import runs asynchronously as a background job).
Request
Endpoint
POST /api/v2/account_lists/82d7161e-f3bf-4d6e-8b61-d5de3e16d437/imports/tnt
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
POST /api/v2/account_lists/:account_list_id/imports/tnt
Parameters
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[type]"
imports
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][file]"; filename="tnt_export.xml"
Content-Type: text/plain
Content-Length: 21325
[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][importing]"
false
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][source]"
twitter
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[relationships][account_list][data][type]"
account_lists
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[relationships][account_list][data][id]"
82d7161e-f3bf-4d6e-8b61-d5de3e16d437
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[relationships][user][data][type]"
users
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[relationships][user][data][id]"
78b5f35b-6027-428c-b431-801cb2054025
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[relationships][source_account][data][type]"
facebook_accounts
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[relationships][source_account][data][id]"
e2df45f5-6b11-4c64-8fcb-73881428dfa7
------------XnJLe9ZIbbGUYtzPQJ16u1--
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
{
"data": {
"id": "9097f4eb-d18f-41a3-9159-6e58071c1d17",
"type": "imports",
"attributes": {
"account_list_id": "82d7161e-f3bf-4d6e-8b61-d5de3e16d437",
"created_at": "2018-10-12T19:14:54Z",
"file_constants": {
},
"file_constants_mappings": {
},
"file_headers": {
},
"file_headers_mappings": {
},
"file_url": "/uploads/import/file/9097f4eb-d18f-41a3-9159-6e58071c1d17/tnt_export.xml",
"group_tags": null,
"groups": [
],
"import_by_group": false,
"in_preview": false,
"override": false,
"source": "tnt",
"tag_list": null,
"updated_at": "2018-10-12T19:14:54Z",
"updated_in_db_at": "2018-10-12T19:14:54Z"
},
"relationships": {
"user": {
"data": {
"id": "78b5f35b-6027-428c-b431-801cb2054025",
"type": "users"
}
},
"sample_contacts": {
"data": [
]
}
}
}
}
Fields
| Name | Type | Description |
|---|
Invites
Invite [ACCEPT]
Accepts the invite
Request
Endpoint
PUT /api/v2/account_lists/267bbcff-1de0-4068-9e10-0b8a4b854752/invites/74ee748a-9623-4c35-893b-8e709e858ff7/accept
Content-Type: application/vnd.api+json
PUT /api/v2/account_lists/:account_list_id/invites/:id/accept
Parameters
{
"data": {
"type": "account_list_invites",
"attributes": {
"code": "abc"
}
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "74ee748a-9623-4c35-893b-8e709e858ff7",
"type": "account_list_invites",
"attributes": {
"accepted_at": "2018-10-12T19:14:56Z",
"code": "abc",
"created_at": "2018-10-12T19:14:56Z",
"invite_user_as": "user",
"recipient_email": "joe@example.com",
"updated_at": "2018-10-12T19:14:56Z",
"updated_in_db_at": "2018-10-12T19:14:56Z"
},
"relationships": {
"accepted_by_user": {
"data": {
"id": "15e74ef6-a422-4a75-acf7-8c39b4cac4ea",
"type": "users"
}
},
"cancelled_by_user": {
"data": null
},
"invited_by_user": {
"data": {
"id": "5709fbe3-644e-406a-a40f-df42780865a8",
"type": "users"
}
}
}
}
}
Invite [CANCEL]
Cancels the invite
Request
Endpoint
DELETE /api/v2/account_lists/3f1471fb-0386-4237-908a-9c57b0ea2cf4/invites/162707cc-8efd-46c2-8dbb-475b4ea4ce97
Content-Type: application/vnd.api+json
DELETE /api/v2/account_lists/:account_list_id/invites/:id
Parameters
None known.
Response
204 No Content
Invite [CREATE]
Creates the invite associated to the given account_list
Request
Endpoint
POST /api/v2/account_lists/0a407ac2-834a-41ef-9ae5-606bf969ac6e/invites
Content-Type: application/vnd.api+json
POST /api/v2/account_lists/:account_list_id/invites
Parameters
{
"data": {
"attributes": {
"recipient_email": "joe@example.com",
"invite_user_as": "user",
"invite_user_as": "user",
"recipient_email": "joe@example.com"
},
"type": "account_list_invites"
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
{
"data": {
"id": "b24af102-6525-4ebe-820b-6275c77ba975",
"type": "account_list_invites",
"attributes": {
"accepted_at": null,
"code": "9a146850e96b81bb9cbfbc7d1330c02f25d06139f86de34e47e1fe39a2faaaa1",
"created_at": "2018-10-12T19:14:56Z",
"invite_user_as": "user",
"recipient_email": "joe@example.com",
"updated_at": "2018-10-12T19:14:56Z",
"updated_in_db_at": "2018-10-12T19:14:56Z"
},
"relationships": {
"accepted_by_user": {
"data": null
},
"cancelled_by_user": {
"data": null
},
"invited_by_user": {
"data": {
"id": "9f1577cb-0bb3-4c69-9c50-88831c1e470a",
"type": "users"
}
}
}
}
}
Invite [GET]
The Account List Invite with the given ID
Request
Endpoint
GET /api/v2/account_lists/d20b26ed-d709-40ad-9211-b821848ab542/invites/390b42c3-86b0-4a9a-a0c5-4178ebb35f2b
Content-Type: application/vnd.api+json
GET /api/v2/account_lists/:account_list_id/invites/:id
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "390b42c3-86b0-4a9a-a0c5-4178ebb35f2b",
"type": "account_list_invites",
"attributes": {
"accepted_at": "-4713-12-31T22:08:00Z",
"code": "abc",
"created_at": "2018-10-12T19:14:56Z",
"invite_user_as": "user",
"recipient_email": "joe@example.com",
"updated_at": "2018-10-12T19:14:56Z",
"updated_in_db_at": "2018-10-12T19:14:56Z"
},
"relationships": {
"accepted_by_user": {
"data": null
},
"cancelled_by_user": {
"data": null
},
"invited_by_user": {
"data": {
"id": "73107c38-a16d-41d8-9540-b5d0f4ac59f2",
"type": "users"
}
}
}
}
}
Fields
| Name | Type | Description |
|---|
Invite [LIST]
List of Invites associated with the Account List
Request
Endpoint
GET /api/v2/account_lists/ac4ef6c6-521e-4d0f-9046-00802b2cd2dc/invites
Content-Type: application/vnd.api+json
GET /api/v2/account_lists/:account_list_id/invites
Parameters
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": [
{
"id": "241efa0f-0cd7-4047-b0ad-64eb1b35fe3d",
"type": "account_list_invites",
"attributes": {
"accepted_at": "-4713-12-31T22:08:00Z",
"code": "abc",
"created_at": "2018-10-12T19:14:55Z",
"invite_user_as": "user",
"recipient_email": "joe@example.com",
"updated_at": "2018-10-12T19:14:55Z",
"updated_in_db_at": "2018-10-12T19:14:55Z"
},
"relationships": {
"accepted_by_user": {
"data": null
},
"cancelled_by_user": {
"data": null
},
"invited_by_user": {
"data": {
"id": "46ed1a34-4009-4bbc-8ac9-4d1cb2b5aa7d",
"type": "users"
}
}
}
},
{
"id": "669dfb74-b588-41c4-a64f-eb28b32d56f1",
"type": "account_list_invites",
"attributes": {
"accepted_at": "-4713-12-31T22:08:00Z",
"code": "abc",
"created_at": "2018-10-12T19:14:55Z",
"invite_user_as": "coach",
"recipient_email": "joe@example.com",
"updated_at": "2018-10-12T19:14:55Z",
"updated_in_db_at": "2018-10-12T19:14:55Z"
},
"relationships": {
"accepted_by_user": {
"data": null
},
"cancelled_by_user": {
"data": null
},
"invited_by_user": {
"data": {
"id": "37a1ec4d-2a99-480e-a63c-b5debb2985de",
"type": "users"
}
}
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 2,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
data |
Array[Object] |
Data |
Mailchimp Accounts
Mailchimp Account [DELETE]
Deletes the MailChimp Account associated with the Account List
Request
Endpoint
DELETE /api/v2/account_lists/84f61272-18d0-4654-bf7b-91b855947043/mail_chimp_account
Content-Type: application/vnd.api+json
DELETE /api/v2/account_lists/:account_list_id/mail_chimp_account
Parameters
| Name | Type | Description | Required |
|---|
Response
204 No Content
Mailchimp Account [GET]
The MailChimp Account associated with the Account List
Request
Endpoint
GET /api/v2/account_lists/66b5aa42-1393-42ee-a520-ba04d2df6cc3/mail_chimp_account
Content-Type: application/vnd.api+json
GET /api/v2/account_lists/:account_list_id/mail_chimp_account
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "f015c815-bca0-4a46-85e2-1938920c9755",
"type": "mail_chimp_accounts",
"attributes": {
"active": false,
"api_key": "fake-us4",
"auto_log_campaigns": false,
"created_at": "2018-10-12T19:14:57Z",
"lists_available_for_newsletters": [
],
"lists_link": "https://us4.admin.mailchimp.com/lists/",
"lists_present": false,
"primary_list_id": "1e72b58b72",
"primary_list_name": null,
"updated_at": "2018-10-12T19:14:57Z",
"updated_in_db_at": "2018-10-12T19:14:57Z",
"valid": false,
"validate_key": null,
"validation_error": null
}
}
}
Fields
| Name | Type | Description |
|---|
Mailchimp Account [POST]
Add the MailChimp Account associated with the Account List
Request
Endpoint
POST /api/v2/account_lists/cca77f43-d869-45e8-96f6-3156ba088eb0/mail_chimp_account
Content-Type: application/vnd.api+json
POST /api/v2/account_lists/:account_list_id/mail_chimp_account
Parameters
{
"data": {
"attributes": {
"primary_list_id": "1e72b58b72",
"api_key": "fake-us4",
"primary_list_id": "1e72b58b72"
},
"type": "mail_chimp_accounts"
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
{
"data": {
"id": "e7946646-2eef-4663-98ed-6c2effe81a6c",
"type": "mail_chimp_accounts",
"attributes": {
"active": false,
"api_key": "fake-us4",
"auto_log_campaigns": true,
"created_at": "2018-10-12T19:14:57Z",
"lists_available_for_newsletters": [
],
"lists_link": "https://us4.admin.mailchimp.com/lists/",
"lists_present": false,
"primary_list_id": "1e72b58b72",
"primary_list_name": null,
"updated_at": "2018-10-12T19:14:57Z",
"updated_in_db_at": "2018-10-12T19:14:57Z",
"valid": false,
"validate_key": null,
"validation_error": null
}
}
}
Mailchimp Account [SYNC]
Synchronizes the Account List’s contacts to the MailChimp server
Request
Endpoint
GET /api/v2/account_lists/36dbef53-3ee8-4f68-a76b-75a31e3ded42/mail_chimp_account/sync
Content-Type: application/vnd.api+json
GET /api/v2/account_lists/:account_list_id/mail_chimp_account/sync
Parameters
| Name | Type | Description | Required |
|---|
Response
Content-Type: text/html
200 OK
Merges
Notification Preferences
Notification Preference [CREATE]
Create Notification Preference
Request
Endpoint
POST /api/v2/account_lists/b21f262b-8005-442d-9f39-0b5288bc0300/notification_preferences
Content-Type: application/vnd.api+json
POST /api/v2/account_lists/:account_list_id/notification_preferences
Parameters
{
"data": {
"type": "notification_preferences",
"attributes": {
"email": true,
"task": true
},
"relationships": {
"notification_type": {
"data": {
"type": "notification_types",
"id": "be396d2e-9d79-49c5-960e-08e15ae54ba1"
}
}
}
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
{
"data": {
"id": "3ee68624-ff39-42cf-9cee-0922ca2e72d7",
"type": "notification_preferences",
"attributes": {
"created_at": "2018-10-12T19:14:58Z",
"email": true,
"task": true,
"updated_at": "2018-10-12T19:14:58Z",
"updated_in_db_at": "2018-10-12T19:14:58Z"
},
"relationships": {
"notification_type": {
"data": {
"id": "be396d2e-9d79-49c5-960e-08e15ae54ba1",
"type": "notification_type"
}
}
}
}
}
Notification Preference [DELETE]
Delete Notification Preference
Request
Endpoint
DELETE /api/v2/account_lists/4a6516f6-f8c9-42d5-8315-87d9100bf3b0/notification_preferences/17a88b83-8c28-4303-9d0a-0efad0bd302c
Content-Type: application/vnd.api+json
DELETE /api/v2/account_lists/:account_list_id/notification_preferences/:id
Parameters
| Name | Type | Description | Required |
|---|
Response
204 No Content
Notification Preference [GET]
The Notification Preference for the given ID
Request
Endpoint
GET /api/v2/account_lists/bda91324-d5a4-428d-aa64-73686ba2058e/notification_preferences/2e3ed427-57dd-4570-8785-e721c26c1a07
Content-Type: application/vnd.api+json
GET /api/v2/account_lists/:account_list_id/notification_preferences/:id
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "2e3ed427-57dd-4570-8785-e721c26c1a07",
"type": "notification_preferences",
"attributes": {
"created_at": "2018-10-12T19:14:58Z",
"email": true,
"task": true,
"updated_at": "2018-10-12T19:14:58Z",
"updated_in_db_at": "2018-10-12T19:14:58Z"
},
"relationships": {
"notification_type": {
"data": {
"id": "1a56739a-a9e0-4be3-81fd-3798299251bf",
"type": "notification_type"
}
}
}
}
}
Fields
| Name | Type | Description |
|---|
Notification Preference [LIST]
List of Notification Preferences
Request
Endpoint
GET /api/v2/account_lists/47bd55e6-1ccd-463a-885c-42ce7d724cee/notification_preferences
Content-Type: application/vnd.api+json
GET /api/v2/account_lists/:account_list_id/notification_preferences
Parameters
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": [
{
"id": "ad018afb-5bf7-4708-8d9e-fd0eba07ece5",
"type": "notification_preferences",
"attributes": {
"created_at": "2018-10-12T19:14:58Z",
"email": true,
"task": true,
"updated_at": "2018-10-12T19:14:58Z",
"updated_in_db_at": "2018-10-12T19:14:58Z"
},
"relationships": {
"notification_type": {
"data": {
"id": "90bf0d3a-6355-4ae3-a45a-28426b94fc09",
"type": "notification_type"
}
}
}
},
{
"id": "c5bedbdf-6fe6-4699-b57b-3f68af3a2fa9",
"type": "notification_preferences",
"attributes": {
"created_at": "2018-10-12T19:14:58Z",
"email": true,
"task": true,
"updated_at": "2018-10-12T19:14:58Z",
"updated_in_db_at": "2018-10-12T19:14:58Z"
},
"relationships": {
"notification_type": {
"data": {
"id": "d132e8d5-3f24-4f60-bcb1-cc8850cff3ae",
"type": "notification_type"
}
}
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 2,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
data |
Array[Object] |
List of Notification Preferences |
Notifications
Notification [CREATE]
Creates a new Notification associated with the Account List
Request
Endpoint
POST /api/v2/account_lists/8ec847a7-bd51-47bc-a1f6-497dbd1cb95e/notifications
Content-Type: application/vnd.api+json
POST /api/v2/account_lists/:account_list_id/notifications
Parameters
{
"data": {
"type": "notifications",
"attributes": {
"cleared": false,
"event_date": "2012-10-23 17:03:15",
"updated_in_db_at": "2018-10-12 21:14:59 +0200"
},
"relationships": {
"contact": {
"data": {
"type": "contacts",
"id": "142408d3-3c7c-44ff-a783-eb21056db1f6"
}
},
"donation": {
"data": {
"type": "donations",
"id": "4a5d335d-0926-4f76-9831-8ca963ab9f52"
}
},
"notification_type": {
"data": {
"type": "notification_types",
"id": "38595937-8c5d-419a-9fae-ad2863da5097"
}
}
}
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
{
"data": {
"id": "2a074f64-b8a4-4f31-9780-4f3920c038f9",
"type": "notifications",
"attributes": {
"cleared": false,
"created_at": "2018-10-12T19:14:59Z",
"event_date": "2012-10-23T04:03:15Z",
"updated_at": "2018-10-12T19:14:59Z",
"updated_in_db_at": "2018-10-12T19:14:59Z"
},
"relationships": {
"contact": {
"data": {
"id": "142408d3-3c7c-44ff-a783-eb21056db1f6",
"type": "contacts"
}
},
"notification_type": {
"data": {
"id": "38595937-8c5d-419a-9fae-ad2863da5097",
"type": "notification_type"
}
},
"donation": {
"data": {
"id": "4a5d335d-0926-4f76-9831-8ca963ab9f52",
"type": "donations"
}
}
}
}
}
Notification [DELETE]
Deletes the Account List Notification with the given ID
Request
Endpoint
DELETE /api/v2/account_lists/e4faa6b9-ba94-4796-b09b-a413ee797948/notifications/a9a35349-a486-452c-800b-86dce565d153
Content-Type: application/vnd.api+json
DELETE /api/v2/account_lists/:account_list_id/notifications/:id
Parameters
| Name | Type | Description | Required |
|---|
Response
204 No Content
Notification [GET]
The Account List Notification with the given ID
Request
Endpoint
GET /api/v2/account_lists/d246ab2b-9fef-480d-a409-6937da3a208a/notifications/7826f07f-9ef4-40cc-b08f-6749093b52f3
Content-Type: application/vnd.api+json
GET /api/v2/account_lists/:account_list_id/notifications/:id
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "7826f07f-9ef4-40cc-b08f-6749093b52f3",
"type": "notifications",
"attributes": {
"cleared": false,
"created_at": "2018-10-12T19:14:59Z",
"event_date": "2012-10-23T15:03:15Z",
"updated_at": "2018-10-12T19:14:59Z",
"updated_in_db_at": "2018-10-12T19:14:59Z"
},
"relationships": {
"contact": {
"data": {
"id": "41fe82f9-70b8-450b-acce-3f2ead3e3f9f",
"type": "contacts"
}
},
"notification_type": {
"data": {
"id": "3797d7be-bb82-4823-8361-a5749c39e7c2",
"type": "notification_type"
}
},
"donation": {
"data": {
"id": "da2bc74a-6f44-43b9-92da-71bcc64f80d8",
"type": "donations"
}
}
}
}
}
Fields
| Name | Type | Description |
|---|
Notification [LIST]
List of Notifications associated with the Account List
Request
Endpoint
GET /api/v2/account_lists/b12c3625-6910-44b4-b9e3-9055c49162e6/notifications
Content-Type: application/vnd.api+json
GET /api/v2/account_lists/:account_list_id/notifications
Parameters
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": [
{
"id": "acd92786-b810-4b72-ae59-81a1fe372885",
"type": "notifications",
"attributes": {
"cleared": false,
"created_at": "2018-10-12T19:14:58Z",
"event_date": "2012-10-23T15:03:15Z",
"updated_at": "2018-10-12T19:14:58Z",
"updated_in_db_at": "2018-10-12T19:14:58Z"
},
"relationships": {
"contact": {
"data": {
"id": "8a2eeead-8947-45bd-bf78-b3dcf6dd2e3d",
"type": "contacts"
}
},
"notification_type": {
"data": {
"id": "0a2497bc-e7bf-41e2-b7a6-9a74eeed310d",
"type": "notification_type"
}
},
"donation": {
"data": {
"id": "d587dfa1-9021-4a39-ad3a-f16b2bdde7c7",
"type": "donations"
}
}
}
},
{
"id": "7b0359a7-fd93-4d04-95d0-1a754396a917",
"type": "notifications",
"attributes": {
"cleared": false,
"created_at": "2018-10-12T19:14:58Z",
"event_date": "2012-10-23T15:03:15Z",
"updated_at": "2018-10-12T19:14:58Z",
"updated_in_db_at": "2018-10-12T19:14:58Z"
},
"relationships": {
"contact": {
"data": {
"id": "8a2eeead-8947-45bd-bf78-b3dcf6dd2e3d",
"type": "contacts"
}
},
"notification_type": {
"data": {
"id": "bcf1d5da-9d10-49ca-bb1d-ef75a9320301",
"type": "notification_type"
}
},
"donation": {
"data": {
"id": "401aeadb-5e47-4564-99f9-14ac39df206e",
"type": "donations"
}
}
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 2,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
data |
Array[Object] |
Data |
Notification [UPDATE]
Updates the Account List Notification with the given ID
Request
Endpoint
PUT /api/v2/account_lists/75d4c6b9-4c68-4b1f-af0a-6cd7272723c2/notifications/da719258-216f-4401-8246-fec9cb69eb8e
Content-Type: application/vnd.api+json
PUT /api/v2/account_lists/:account_list_id/notifications/:id
Parameters
{
"data": {
"type": "notifications",
"attributes": {
"cleared": false,
"event_date": "2012-10-23 17:03:15",
"updated_in_db_at": "2018-10-12 21:14:59 +0200"
},
"relationships": {
"contact": {
"data": {
"type": "contacts",
"id": "9ba832f1-173c-48d3-ae83-3fefde485854"
}
},
"donation": {
"data": {
"type": "donations",
"id": "0ebdd435-96e5-45dc-99d9-2e85f4218cc7"
}
},
"notification_type": {
"data": {
"type": "notification_types",
"id": "2a9b43ec-d2f1-46df-934d-c2ad562eac82"
}
}
}
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "da719258-216f-4401-8246-fec9cb69eb8e",
"type": "notifications",
"attributes": {
"cleared": false,
"created_at": "2018-10-12T19:14:59Z",
"event_date": "2012-10-23T04:03:15Z",
"updated_at": "2018-10-12T19:14:59Z",
"updated_in_db_at": "2018-10-12T19:14:59Z"
},
"relationships": {
"contact": {
"data": {
"id": "9ba832f1-173c-48d3-ae83-3fefde485854",
"type": "contacts"
}
},
"notification_type": {
"data": {
"id": "2a9b43ec-d2f1-46df-934d-c2ad562eac82",
"type": "notification_type"
}
},
"donation": {
"data": {
"id": "0ebdd435-96e5-45dc-99d9-2e85f4218cc7",
"type": "donations"
}
}
}
}
}
Prayer Letters Accounts
Prayer Letters Account [CREATE]
Create a Prayer Letters Account associated with the Account List
Request
Endpoint
POST /api/v2/account_lists/b3c615ce-27e4-4e9a-b6b9-b9c5c25fe013/prayer_letters_account
Content-Type: application/vnd.api+json
POST /api/v2/account_lists/:account_list_id/prayer_letters_account
Parameters
{
"data": {
"type": "prayer_letters_accounts",
"attributes": {
"oauth2_token": "token"
}
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
{
"data": {
"id": "8ad01ca5-dde9-489b-8e59-77b0db6d773a",
"type": "prayer_letters_accounts",
"attributes": {
"created_at": "2018-10-12T19:15:01Z",
"token": null,
"updated_at": "2018-10-12T19:15:01Z",
"updated_in_db_at": "2018-10-12T19:15:01Z"
}
}
}
Prayer Letters Account [DELETE]
Deletes the Prayer Letters Account associated with the Account List
Request
Endpoint
DELETE /api/v2/account_lists/345f7f72-0808-43bf-93cf-49dca54be53e/prayer_letters_account
Content-Type: application/vnd.api+json
DELETE /api/v2/account_lists/:account_list_id/prayer_letters_account
Parameters
| Name | Type | Description | Required |
|---|
Response
204 No Content
Prayer Letters Account [GET]
The Prayer Letters Account associated with the Account List
Request
Endpoint
GET /api/v2/account_lists/a3fed6db-2f48-47c7-938f-677c359f2298/prayer_letters_account
Content-Type: application/vnd.api+json
GET /api/v2/account_lists/:account_list_id/prayer_letters_account
Parameters
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "90f70952-329f-407f-a52f-78c076286902",
"type": "prayer_letters_accounts",
"attributes": {
"created_at": "2018-10-12T19:15:00Z",
"token": "MyString",
"updated_at": "2018-10-12T19:15:00Z",
"updated_in_db_at": "2018-10-12T19:15:00Z"
}
}
}
Fields
| Name | Type | Description |
|---|
Prayer Letters Account [SYNC]
Synchronizes The Prayer Letters Account’s subscribers with https://www.prayerletters.com
Request
Endpoint
GET /api/v2/account_lists/eee9f5c5-fb18-4f71-aa4e-6d5bb5cf242b/prayer_letters_account/sync
Content-Type: application/vnd.api+json
GET /api/v2/account_lists/:account_list_id/prayer_letters_account/sync
Parameters
| Name | Type | Description | Required |
|---|
Response
Content-Type: text/html
200 OK
Users
User [DELETE]
Destroy the Account List User with the given ID
Request
Endpoint
DELETE /api/v2/account_lists/e50ec847-772b-492a-9360-fa19f607695a/users/3ddc8231-45a9-4fc6-b6d4-b071cba9f18b
Content-Type: application/vnd.api+json
DELETE /api/v2/account_lists/:account_list_id/users/:id
Parameters
None known.
Response
204 No Content
User [GET]
The Account List User with the given ID
Request
Endpoint
GET /api/v2/account_lists/f982ecaf-7582-4f82-981e-bd02b561d7af/users/d18a0d12-3fec-4623-ab4c-5fb01b6cf3d1
Content-Type: application/vnd.api+json
GET /api/v2/account_lists/:account_list_id/users/:id
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "d18a0d12-3fec-4623-ab4c-5fb01b6cf3d1",
"type": "users",
"attributes": {
"created_at": "2018-10-12T19:15:01Z",
"first_name": "Sammy",
"last_name": null,
"updated_at": "2018-10-12T19:15:01Z",
"updated_in_db_at": "2018-10-12T19:15:01Z"
}
}
}
Fields
| Name | Type | Description |
|---|
User [LIST]
List of Users associated to the Account List
Request
Endpoint
GET /api/v2/account_lists/db55798a-479b-4a78-b244-a8688f355ca9/users
Content-Type: application/vnd.api+json
GET /api/v2/account_lists/:account_list_id/users
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": [
{
"id": "7be975ad-7c8f-4278-b791-42d6d34fe607",
"type": "users",
"attributes": {
"created_at": "2018-10-12T19:15:01Z",
"first_name": "Fatima",
"last_name": null,
"updated_at": "2018-10-12T19:15:01Z",
"updated_in_db_at": "2018-10-12T19:15:01Z"
}
},
{
"id": "cd2c2636-9020-4ecd-902d-6b9cd6e61ba4",
"type": "users",
"attributes": {
"created_at": "2018-10-12T19:15:01Z",
"first_name": "Joel",
"last_name": null,
"updated_at": "2018-10-12T19:15:01Z",
"updated_in_db_at": "2018-10-12T19:15:01Z"
}
},
{
"id": "c34ed4ef-3009-4211-bd7a-86a6184b8cd6",
"type": "users",
"attributes": {
"created_at": "2018-10-12T19:15:01Z",
"first_name": "Myrtle",
"last_name": null,
"updated_at": "2018-10-12T19:15:01Z",
"updated_in_db_at": "2018-10-12T19:15:01Z"
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 3,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}
Appeals Api
Contacts
Contacts Api
Addresses
Address [DELETE]
Address [DELETE]
Request
Endpoint
DELETE /api/v2/contacts/a5c5e945-063b-49fa-80db-37afa02011d8/addresses/c4b48b07-08b8-49ca-a3ae-8c99159821f8
Content-Type: application/vnd.api+json
DELETE /api/v2/contacts/:contact_id/addresses/:id
Parameters
None known.
Response
204 No Content
Address [GET]
Address [GET]
Request
Endpoint
GET /api/v2/contacts/24d3ba84-3e4f-4270-ba4a-536c3c4af80f/addresses/02a2bdd7-5090-447e-a511-ef0d70c18908
Content-Type: application/vnd.api+json
GET /api/v2/contacts/:contact_id/addresses/:id
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "02a2bdd7-5090-447e-a511-ef0d70c18908",
"type": "addresses",
"attributes": {
"city": "Fremont",
"country": "United States",
"created_at": "2018-10-12T19:15:07Z",
"end_date": "2012-02-19",
"geo": "0,0",
"historic": false,
"location": "Home",
"metro_area": null,
"postal_code": "94539",
"primary_mailing_address": false,
"region": null,
"remote_id": null,
"seasonal": false,
"source": "MPDX",
"start_date": "2012-02-19",
"state": "CA",
"street": "123 Somewhere St",
"updated_at": "2018-10-12T19:15:07Z",
"updated_in_db_at": "2018-10-12T19:15:07Z",
"valid_values": true
},
"relationships": {
"source_donor_account": {
"data": null
}
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
city |
string |
The city of the Address |
country |
string |
The country of the Address |
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
end_date |
string |
The end date of this Address |
geo |
string |
DESCRIPTION GOES HERE |
historic |
boolean |
DESCRIPTION GOES HERE |
location |
string |
The location of the Address |
postal_code |
string |
The postal code for the Address |
primary_mailing_address |
string |
The primary address for the Address |
start_date |
string |
DESCRIPTION GOES HERE |
state |
string |
The state for the Address |
street |
string |
The street for the Address |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
Address [LIST]
Address [LIST]
Request
Endpoint
GET /api/v2/contacts/3e4708f9-3b61-43ee-88ec-5a4e56d300d7/addresses
Content-Type: application/vnd.api+json
GET /api/v2/contacts/:contact_id/addresses
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": [
{
"id": "5608abd1-e48f-4746-a08d-affbe46d0afc",
"type": "addresses",
"attributes": {
"city": "Fremont",
"country": "United States",
"created_at": "2018-10-12T19:15:07Z",
"end_date": "2012-02-19",
"geo": "0,0",
"historic": false,
"location": "Home",
"metro_area": null,
"postal_code": "94539",
"primary_mailing_address": false,
"region": null,
"remote_id": null,
"seasonal": false,
"source": "MPDX",
"start_date": "2012-02-19",
"state": "CA",
"street": "123 Somewhere St",
"updated_at": "2018-10-12T19:15:07Z",
"updated_in_db_at": "2018-10-12T19:15:07Z",
"valid_values": true
},
"relationships": {
"source_donor_account": {
"data": null
}
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 1,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
data |
[Address] |
An array of Address Objects |
Address [POST]
Address [POST]
Request
Endpoint
POST /api/v2/contacts/37d616c1-6c96-4e70-8014-21c59c04f0e5/addresses
Content-Type: application/vnd.api+json
POST /api/v2/contacts/:contact_id/addresses
Parameters
{
"data": {
"type": "addresses",
"attributes": {
"city": "Fremont",
"country": "United States",
"end_date": "2012-02-19",
"location": "Home",
"postal_code": "94539",
"primary_mailing_address": false,
"start_date": "2012-02-19",
"state": "CA",
"street": "123 Somewhere St",
"updated_in_db_at": "2018-10-12 21:15:07 +0200",
"valid_values": false
}
}
}
| Name | Type | Description | Required |
|---|---|---|---|
| Attributes | |||
city |
string |
The city of the Address | true |
country |
string |
The country of the Address | true |
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created | - |
end_date |
string |
The end date of this Address | true |
geo |
string |
DESCRIPTION GOES HERE | true |
historic |
boolean |
DESCRIPTION GOES HERE | true |
location |
string |
The location of the Address | true |
postal_code |
string |
The postal code for the Address | true |
primary_mailing_address |
string |
The primary address for the Address | true |
start_date |
string |
DESCRIPTION GOES HERE | true |
state |
string |
The state for the Address | true |
street |
string |
The street for the Address | true |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated | - |
updated_in_db_at |
ISO8601 timestamp |
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. | - |
Response
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
{
"data": {
"id": "d3d7c963-66e3-4cef-8e03-4853ed4716ef",
"type": "addresses",
"attributes": {
"city": "Fremont",
"country": "United States",
"created_at": "2018-10-12T19:15:07Z",
"end_date": "2012-02-19",
"geo": "0,0",
"historic": false,
"location": "Home",
"metro_area": null,
"postal_code": "94539",
"primary_mailing_address": false,
"region": null,
"remote_id": null,
"seasonal": false,
"source": "MPDX",
"start_date": "2012-02-19",
"state": "CA",
"street": "123 Somewhere St",
"updated_at": "2018-10-12T19:15:07Z",
"updated_in_db_at": "2018-10-12T19:15:07Z",
"valid_values": true
},
"relationships": {
"source_donor_account": {
"data": null
}
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
city |
string |
The city of the Address |
country |
string |
The country of the Address |
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
end_date |
string |
The end date of this Address |
geo |
string |
DESCRIPTION GOES HERE |
historic |
boolean |
DESCRIPTION GOES HERE |
location |
string |
The location of the Address |
postal_code |
string |
The postal code for the Address |
primary_mailing_address |
string |
The primary address for the Address |
start_date |
string |
DESCRIPTION GOES HERE |
state |
string |
The state for the Address |
street |
string |
The street for the Address |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
Address [PUT]
Address [PUT]
Request
Endpoint
PUT /api/v2/contacts/e9586481-0cd6-4114-8293-1cf5176c70f8/addresses/0fbc88a1-02e9-4f8f-98aa-7c32528c88ae
Content-Type: application/vnd.api+json
PUT /api/v2/contacts/:contact_id/addresses/:id
Parameters
{
"data": {
"type": "addresses",
"attributes": {
"city": "Fremont",
"country": "United States",
"end_date": "2012-02-19",
"location": "Home",
"postal_code": "94539",
"primary_mailing_address": false,
"start_date": "2012-02-19",
"state": "CA",
"street": "123 Somewhere St",
"updated_in_db_at": "2018-10-12 21:15:07 +0200",
"valid_values": false
}
}
}
| Name | Type | Description | Required |
|---|---|---|---|
| Attributes | |||
city |
string |
The city of the Address | - |
country |
string |
The country of the Address | - |
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created | - |
end_date |
string |
The end date of this Address | - |
geo |
string |
DESCRIPTION GOES HERE | - |
historic |
boolean |
DESCRIPTION GOES HERE | - |
location |
string |
The location of the Address | - |
overwrite |
boolean |
Only used for updating a record where you want to ignore the server’s ’ ’updated_in_db_at value and force overwrite the values for the record. ’ ‘Must be true to work. |
- |
postal_code |
string |
The postal code for the Address | - |
primary_mailing_address |
string |
The primary address for the Address | - |
start_date |
string |
DESCRIPTION GOES HERE | - |
state |
string |
The state for the Address | - |
street |
string |
The street for the Address | - |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated | - |
updated_in_db_at |
ISO8601 timestamp |
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. | true |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "0fbc88a1-02e9-4f8f-98aa-7c32528c88ae",
"type": "addresses",
"attributes": {
"city": "Fremont",
"country": "United States",
"created_at": "2018-10-12T19:15:07Z",
"end_date": "2012-02-19",
"geo": "0,0",
"historic": false,
"location": "Home",
"metro_area": null,
"postal_code": "94539",
"primary_mailing_address": false,
"region": null,
"remote_id": null,
"seasonal": false,
"source": "MPDX",
"start_date": "2012-02-19",
"state": "CA",
"street": "123 Somewhere St",
"updated_at": "2018-10-12T19:15:07Z",
"updated_in_db_at": "2018-10-12T19:15:07Z",
"valid_values": false
},
"relationships": {
"source_donor_account": {
"data": null
}
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
city |
string |
The city of the Address |
country |
string |
The country of the Address |
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
end_date |
string |
The end date of this Address |
geo |
string |
DESCRIPTION GOES HERE |
historic |
boolean |
DESCRIPTION GOES HERE |
location |
string |
The location of the Address |
postal_code |
string |
The postal code for the Address |
primary_mailing_address |
string |
The primary address for the Address |
start_date |
string |
DESCRIPTION GOES HERE |
state |
string |
The state for the Address |
street |
string |
The street for the Address |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
Analytics
Analytic [GET]
Analytic [GET]
Request
Endpoint
GET /api/v2/contacts/analytics
Content-Type: application/vnd.api+json
GET /api/v2/contacts/analytics
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "",
"type": "contact_analytics",
"attributes": {
"created_at": "2018-10-12T19:15:08Z",
"first_gift_not_received_count": 3,
"partners_30_days_late_count": 0,
"partners_60_days_late_count": 0,
"partners_90_days_late_count": 0,
"updated_at": null,
"updated_in_db_at": null
},
"relationships": {
"birthdays_this_week": {
"data": [
{
"id": "220cd498-52e9-4ef0-9a2d-a0b5e13fdaad",
"type": "people"
},
{
"id": "a658424b-efeb-4e12-a852-c39263229dc8",
"type": "people"
}
]
},
"anniversaries_this_week": {
"data": [
{
"id": "194ce4c5-c4f2-432c-bf06-c0b14fcd12c0",
"type": "contacts"
}
]
}
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
first_gift_not_received_count |
number |
First gift not received count |
partners_30_days_late_count |
number |
Partners 31 to 60 Days Late Count |
partners_60_days_late_count |
number |
Partners 61 to 90 Days Late Count |
partners_90_days_late_count |
number |
Partners 91 Days Late Count |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
Analytic [GET]
Analytic [GET]
Request
Endpoint
GET /api/v2/contacts/analytics?filter[account_list_id]=c3f43001-1369-4e5d-8f27-7b97e876101b
Content-Type: application/vnd.api+json
GET /api/v2/contacts/analytics
Parameters
filter: {"account_list_id"=>"c3f43001-1369-4e5d-8f27-7b97e876101b"}
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "",
"type": "contact_analytics",
"attributes": {
"created_at": "2018-10-12T19:15:08Z",
"first_gift_not_received_count": 1,
"partners_30_days_late_count": 0,
"partners_60_days_late_count": 0,
"partners_90_days_late_count": 0,
"updated_at": null,
"updated_in_db_at": null
},
"relationships": {
"birthdays_this_week": {
"data": [
{
"id": "ae95bffb-b0ab-4ab3-b577-2fbb7188c26a",
"type": "people"
}
]
},
"anniversaries_this_week": {
"data": [
]
}
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
first_gift_not_received_count |
number |
First gift not received count |
partners_30_days_late_count |
number |
Partners 31 to 60 Days Late Count |
partners_60_days_late_count |
number |
Partners 61 to 90 Days Late Count |
partners_90_days_late_count |
number |
Partners 91 Days Late Count |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
Duplicates
Duplicate [GET]
Duplicate [GET]
Request
Endpoint
GET /api/v2/contacts/duplicates/5d4a96a5-8cb4-4ce3-b0f4-b377f0e7c7e9
Content-Type: application/vnd.api+json
GET /api/v2/contacts/duplicates/:id
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "5d4a96a5-8cb4-4ce3-b0f4-b377f0e7c7e9",
"type": "duplicate_record_pairs",
"attributes": {
"created_at": "2018-10-12T19:15:10Z",
"ignore": false,
"reason": "Just testing",
"updated_at": "2018-10-12T19:15:10Z",
"updated_in_db_at": "2018-10-12T19:15:10Z"
},
"relationships": {
"account_list": {
"data": {
"id": "a8b8a176-4f63-46fe-900e-dd7b08206559",
"type": "account_lists"
}
},
"records": {
"data": [
{
"id": "ba13b83f-6802-4ec5-a710-6eff90b0d5cd",
"type": "contacts"
},
{
"id": "48e645ec-a57c-40b0-87ad-cd2c9aaba3b6",
"type": "contacts"
}
]
}
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
amount |
string |
attributes.amount |
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
ignore |
boolean |
Whether or not this duplicate pair should be ignored |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
| Relationships | ||
account_list.data.id |
id string |
The id of the Account List |
records.data |
[Contact] |
An array of two Contact references |
Duplicate [LIST]
Duplicate [LIST]
Request
Endpoint
GET /api/v2/contacts/duplicates
Content-Type: application/vnd.api+json
GET /api/v2/contacts/duplicates
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| Filters | |||
filter[account_list_id] |
id string |
Filter by Account List; accepts an Account List id |
- |
filter[ignore] |
Boolean |
Filter by ignored duplicate pairs | - |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": [
{
"id": "5f48baba-0d91-4d19-87e0-a0342985590a",
"type": "duplicate_record_pairs",
"attributes": {
"created_at": "2018-10-12T19:15:09Z",
"ignore": false,
"reason": "Just testing",
"updated_at": "2018-10-12T19:15:09Z",
"updated_in_db_at": "2018-10-12T19:15:09Z"
},
"relationships": {
"account_list": {
"data": {
"id": "9f387de0-63c4-4c5f-931e-6facdb2cfbe1",
"type": "account_lists"
}
},
"records": {
"data": [
{
"id": "7eb5ad30-9982-4a44-bfe8-0c33f1f13892",
"type": "contacts"
},
{
"id": "ad5216fa-0c6f-4b35-9a56-4a5031db32eb",
"type": "contacts"
}
]
}
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 1,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
data |
[Duplicate Record Pair] |
An array of Duplicate Record Pair Objects |
Duplicate [PUT]
Duplicate [PUT]
Request
Endpoint
PUT /api/v2/contacts/duplicates/47534ac4-c2ba-4fcb-ba60-dddf733a51d5
Content-Type: application/vnd.api+json
PUT /api/v2/contacts/duplicates/:id
Parameters
{
"data": {
"type": "duplicate_record_pairs",
"attributes": {
"ignore": true,
"updated_in_db_at": "2018-10-12 21:15:10 +0200"
},
"relationships": {
"account_list": {
"data": {
"type": "account_lists",
"id": "ead6f77a-5f22-4cf4-a056-153c72767ecc"
}
}
}
}
}
| Name | Type | Description | Required |
|---|---|---|---|
| Attributes | |||
amount |
string |
attributes.amount | - |
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created | - |
overwrite |
boolean |
Only used for updating a record where you want to ignore the server’s ’ ’updated_in_db_at value and force overwrite the values for the record. ’ 'Must be true to work. |
- |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated | - |
updated_in_db_at |
ISO8601 timestamp |
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. | true |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "47534ac4-c2ba-4fcb-ba60-dddf733a51d5",
"type": "duplicate_record_pairs",
"attributes": {
"created_at": "2018-10-12T19:15:10Z",
"ignore": true,
"reason": "Just testing",
"updated_at": "2018-10-12T19:15:10Z",
"updated_in_db_at": "2018-10-12T19:15:10Z"
},
"relationships": {
"account_list": {
"data": {
"id": "ead6f77a-5f22-4cf4-a056-153c72767ecc",
"type": "account_lists"
}
},
"records": {
"data": [
{
"id": "8688bed9-daf2-4dc2-9e3d-d542d3327945",
"type": "contacts"
},
{
"id": "7c01a943-271a-451d-9d8d-a391501c9b96",
"type": "contacts"
}
]
}
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
amount |
string |
attributes.amount |
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
ignore |
boolean |
Whether or not this duplicate pair should be ignored |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
| Relationships | ||
account_list.data.id |
id string |
The id of the Account List |
records.data |
[Contact] |
An array of two Contact references |
Exports
Export to Mail Chimp [POST]
Export Contacts with the given ID to the Mail Chimp server
Request
Endpoint
POST /api/v2/contacts/export_to_mail_chimp
Content-Type: application/vnd.api+json
POST /api/v2/contacts/export_to_mail_chimp
Parameters
{
"filter": {
"account_list_id": "eafe1b94-7495-40b6-920c-7f4eb456017d"
},
"mail_chimp_list_id": "1e72b58b44"
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: text/html
200 OK
Export [GET]
This endpoint when .csv or .xlsx is appended to the URI Path will produce a file with the contacts selected by the params attribute of the export_log
Request
Endpoint
GET /api/v2/contacts/exports/e339bb73-ba1f-4ce4-a01f-7e7b5864bb5a
Content-Type: application/vnd.api+json
GET /api/v2/contacts/exports/:id
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "e339bb73-ba1f-4ce4-a01f-7e7b5864bb5a",
"type": "export_logs",
"attributes": {
"created_at": "2018-10-12T19:15:11Z",
"export_at": "2017-07-28T13:19:32Z",
"params": {
"filter": {
"status": "active"
}
},
"type": "Contacts Export",
"updated_at": "2018-10-12T19:15:11Z",
"updated_in_db_at": "2018-10-12T19:15:11Z"
},
"relationships": {
"user": {
"data": {
"id": "3c46989c-128f-458a-897a-fa8763d14285",
"type": "users"
}
}
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
params |
string |
A contact filter object that will select the contacts to export |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
| Relationships | ||
user.data |
Person |
The user that created the export |
Export [POST]
Export [POST]
Request
Endpoint
POST /api/v2/contacts/exports
Content-Type: application/vnd.api+json
POST /api/v2/contacts/exports
Parameters
{
"data": {
"type": "export_logs",
"attributes": {
"params": {
"filter": {
"status": "active"
}
}
}
}
}
| Name | Type | Description | Required |
|---|---|---|---|
| Attributes | |||
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created | - |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated | - |
updated_in_db_at |
ISO8601 timestamp |
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. | - |
Response
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
{
"data": {
"id": "9bf5009b-9b6a-4950-b3b5-b86f76a92659",
"type": "export_logs",
"attributes": {
"created_at": "2018-10-12T19:15:11Z",
"export_at": "2018-10-12T19:15:11Z",
"params": {
"filter": {
"status": "active"
}
},
"type": "Contacts",
"updated_at": "2018-10-12T19:15:11Z",
"updated_in_db_at": "2018-10-12T19:15:11Z"
},
"relationships": {
"user": {
"data": {
"id": "089b4a1b-3ef7-4c89-9067-e56707aed54a",
"type": "users"
}
}
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
params |
string |
A contact filter object that will select the contacts to export |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
| Relationships | ||
user.data |
Person |
The user that created the export |
Filter
Merges
Merge [CREATE]
Create Merge
Request
Endpoint
POST /api/v2/contacts/merges
Content-Type: application/vnd.api+json
POST /api/v2/contacts/merges
Parameters
{
"data": {
"type": "merges",
"attributes": {
},
"relationships": {
"loser": {
"data": {
"type": "contacts",
"id": "635e2759-bfbc-4940-9d25-8268f949875d"
}
},
"winner": {
"data": {
"type": "contacts",
"id": "5e0b3be7-a4bf-4392-88b0-0a836e9a7830"
}
}
}
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "5e0b3be7-a4bf-4392-88b0-0a836e9a7830",
"type": "contacts",
"attributes": {
"avatar": "https://mpdx.org/images/avatar.png",
"church_name": null,
"created_at": "2018-10-12T19:15:11Z",
"deceased": false,
"direct_deposit": false,
"envelope_greeting": "John Doe",
"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": "2018-10-07",
"likely_to_give": null,
"locale": "en",
"magazine": false,
"name": "Doe, John",
"next_ask": null,
"no_appeals": null,
"no_gift_aid": null,
"notes": "Test Note.\nTest Note.",
"notes_saved_at": "2018-10-12T19:15:12Z",
"pledge_amount": "100.0",
"pledge_currency": "USD",
"pledge_currency_symbol": "$",
"pledge_frequency": "1",
"pledge_received": false,
"pledge_start_date": "2018-09-07",
"send_newsletter": null,
"square_avatar": "https://mpdx.org/images/avatar.png",
"status": "Partner - Financial",
"status_valid": null,
"suggested_changes": {
},
"tag_list": [
],
"timezone": null,
"uncompleted_tasks_count": 0,
"updated_at": "2018-10-12T19:15:12Z",
"updated_in_db_at": "2018-10-12T19:15:12Z",
"website": "http://durgan.co/antone.fay"
},
"relationships": {
"account_list": {
"data": {
"id": "bad7d133-d2b5-4504-a9a0-17b05dc39081",
"type": "account_lists"
}
},
"addresses": {
"data": [
]
},
"appeals": {
"data": [
]
},
"contact_referrals_by_me": {
"data": [
]
},
"contact_referrals_to_me": {
"data": [
]
},
"contacts_referred_by_me": {
"data": [
]
},
"contacts_that_referred_me": {
"data": [
]
},
"donation_amount_recommendations": {
"data": [
]
},
"donor_accounts": {
"data": [
]
},
"last_six_donations": {
"data": [
]
},
"people": {
"data": [
]
},
"tasks": {
"data": [
]
},
"primary_person": {
"data": null
},
"primary_or_first_person": {
"data": {
"id": "",
"type": "people"
}
},
"spouse": {
"data": null
}
}
}
}
Merge Contacts [BULK POST]
Bulk merge Contacts with the given IDs
Request
Endpoint
POST /api/v2/contacts/merges/bulk
Content-Type: application/vnd.api+json
POST /api/v2/contacts/merges/bulk
Parameters
{
"data": [
{
"data": {
"attributes": {
"winner_id": "79f35bd4-ec5b-430d-9ddb-073a11886de2",
"loser_id": "5c218f8c-7d5f-45c6-8d55-6497f2293768"
}
}
}
]
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
[
{
"data": {
"id": "79f35bd4-ec5b-430d-9ddb-073a11886de2",
"type": "contacts",
"attributes": {
"avatar": "https://mpdx.org/images/avatar.png",
"church_name": null,
"created_at": "2018-10-12T19:15:11Z",
"deceased": false,
"direct_deposit": false,
"envelope_greeting": "Peggie Collier",
"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": "2018-10-07",
"likely_to_give": null,
"locale": "en",
"magazine": false,
"name": "Collier, Peggie",
"next_ask": null,
"no_appeals": null,
"no_gift_aid": null,
"notes": "Test Note.\nTest Note.",
"notes_saved_at": "2018-10-12T19:15:11Z",
"pledge_amount": "100.0",
"pledge_currency": "USD",
"pledge_currency_symbol": "$",
"pledge_frequency": "1",
"pledge_received": false,
"pledge_start_date": "2018-09-07",
"send_newsletter": null,
"square_avatar": "https://mpdx.org/images/avatar.png",
"status": "Partner - Financial",
"status_valid": null,
"suggested_changes": {
},
"tag_list": [
],
"timezone": null,
"uncompleted_tasks_count": 0,
"updated_at": "2018-10-12T19:15:11Z",
"updated_in_db_at": "2018-10-12T19:15:11Z",
"website": "http://hane.org/sterling_hammes"
},
"relationships": {
"account_list": {
"data": {
"id": "0860db4f-d793-47fe-8055-c0fe62595eef",
"type": "account_lists"
}
},
"addresses": {
"data": [
]
},
"appeals": {
"data": [
]
},
"contact_referrals_by_me": {
"data": [
]
},
"contact_referrals_to_me": {
"data": [
]
},
"contacts_referred_by_me": {
"data": [
]
},
"contacts_that_referred_me": {
"data": [
]
},
"donation_amount_recommendations": {
"data": [
]
},
"donor_accounts": {
"data": [
]
},
"last_six_donations": {
"data": [
]
},
"people": {
"data": [
]
},
"tasks": {
"data": [
]
},
"primary_person": {
"data": null
},
"primary_or_first_person": {
"data": {
"id": "",
"type": "people"
}
},
"spouse": {
"data": null
}
}
}
}
]
Tags
Tag [CREATE]
Create a Tag associated with the Contact
Request
Endpoint
POST /api/v2/contacts/c2cacf8d-01f1-4d46-8ceb-30c065407d41/tags
Content-Type: application/vnd.api+json
POST /api/v2/contacts/:contact_id/tags
Parameters
{
"data": {
"type": "tags",
"attributes": {
"name": "new_tag"
}
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
{
"data": {
"id": "c2cacf8d-01f1-4d46-8ceb-30c065407d41",
"type": "contacts",
"attributes": {
"avatar": "https://mpdx.org/images/avatar.png",
"church_name": null,
"created_at": "2018-10-12T19:15:22Z",
"deceased": false,
"direct_deposit": false,
"envelope_greeting": "Mikayla Weber",
"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": "2018-10-07",
"likely_to_give": null,
"locale": "en",
"magazine": false,
"name": "Weber, Mikayla",
"next_ask": null,
"no_appeals": null,
"no_gift_aid": null,
"notes": "Test Note.",
"notes_saved_at": "2018-10-12T19:15:22Z",
"pledge_amount": "100.0",
"pledge_currency": "USD",
"pledge_currency_symbol": "$",
"pledge_frequency": "1",
"pledge_received": false,
"pledge_start_date": "2018-09-07",
"send_newsletter": null,
"square_avatar": "https://mpdx.org/images/avatar.png",
"status": "Partner - Financial",
"status_valid": null,
"suggested_changes": {
},
"tag_list": [
"new_tag"
],
"timezone": null,
"uncompleted_tasks_count": 0,
"updated_at": "2018-10-12T19:15:22Z",
"updated_in_db_at": "2018-10-12T19:15:22Z",
"website": "http://hageneshansen.co/junior"
},
"relationships": {
"account_list": {
"data": {
"id": "50bf295d-58d3-4771-a14c-acd5ba7e8375",
"type": "account_lists"
}
},
"addresses": {
"data": [
]
},
"appeals": {
"data": [
]
},
"contact_referrals_by_me": {
"data": [
]
},
"contact_referrals_to_me": {
"data": [
]
},
"contacts_referred_by_me": {
"data": [
]
},
"contacts_that_referred_me": {
"data": [
]
},
"donation_amount_recommendations": {
"data": [
]
},
"donor_accounts": {
"data": [
]
},
"last_six_donations": {
"data": [
]
},
"people": {
"data": [
]
},
"tasks": {
"data": [
]
},
"primary_person": {
"data": null
},
"primary_or_first_person": {
"data": {
"id": "",
"type": "people"
}
},
"spouse": {
"data": null
}
}
}
}
Tag [DELETE]
Delete the Contact’s Tag with the given name
Request
Endpoint
DELETE /api/v2/contacts/5f8bff69-e35f-4f95-8d0f-92ec46be5040/tags/new_tag
Content-Type: application/vnd.api+json
DELETE /api/v2/contacts/:contact_id/tags/:tag_name
Parameters
| Name | Type | Description | Required |
|---|
Response
204 No Content
Tag [LIST]
List Contact Tags
Request
Endpoint
GET /api/v2/contacts/tags
Content-Type: application/vnd.api+json
GET /api/v2/contacts/tags
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": [
{
"id": "eb145e2f-8fd0-4f98-9645-2436dc00a838",
"type": "tags",
"attributes": {
"name": "new_tag"
}
}
]
}
Tags [BULK DELETE]
Tags [BULK DELETE]
Request
Endpoint
DELETE /api/v2/contacts/tags/bulk
Content-Type: application/vnd.api+json
DELETE /api/v2/contacts/tags/bulk
Parameters
{
"data": [
{
"data": {
"type": "tags",
"attributes": {
"name": "tag_one"
}
}
},
{
"data": {
"type": "tags",
"attributes": {
"name": "tag_two"
}
}
}
],
"filter": {
"contact_ids": "bd09dc8a-f4fe-4b6a-b2b6-ab12e3a4edf5,d604690b-0ac6-4f90-a184-c5f45e0f4f64"
}
}
| Name | Type | Description | Required |
|---|---|---|---|
| Filters | |||
filter[account_list_id] |
ID string |
The ID of an Account List to scope the tasks to |
- |
filter[contact_ids] |
string (comma delimited IDs) |
A comma delimited list of Contact IDs to remove the Tag from. If ommited the Tag will be removed from all Contacts. | - |
| Attributes | |||
name |
string |
The name of the Tag to be deleted | true |
Response
204 No Content
Tags [BULK POST]
Tags [BULK POST]
Request
Endpoint
POST /api/v2/contacts/tags/bulk
Content-Type: application/vnd.api+json
POST /api/v2/contacts/tags/bulk
Parameters
{
"data": [
{
"data": {
"type": "tags",
"attributes": {
"name": "tag_one"
}
}
},
{
"data": {
"type": "tags",
"attributes": {
"name": "tag_two"
}
}
}
],
"filter": {
"contact_ids": "d5f4fc76-090d-4465-a53b-ce8bc4d68f62,40c3eabf-e47f-46e4-9cb9-c9f76b9d225b"
}
}
| Name | Type | Description | Required |
|---|---|---|---|
| Filters | |||
filter[account_list_id] |
ID string |
The ID of an Account List to scope the tasks to |
- |
filter[contact_ids] |
string (comma delimited IDs) |
A comma delimited list of Contact IDs to add the Tag to. If ommited the Tag will be added to all Contacts. | - |
| Attributes | |||
name |
string |
The name of the Tag to be added | true |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
[
{
"data": {
"id": "d5f4fc76-090d-4465-a53b-ce8bc4d68f62",
"type": "contacts",
"attributes": {
"avatar": "https://mpdx.org/images/avatar.png",
"church_name": null,
"created_at": "2018-10-12T19:15:22Z",
"deceased": false,
"direct_deposit": false,
"envelope_greeting": "Amely Bartoletti",
"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": "2018-10-07",
"likely_to_give": null,
"locale": "en",
"magazine": false,
"name": "Bartoletti, Amely",
"next_ask": null,
"no_appeals": null,
"no_gift_aid": null,
"notes": "Test Note.",
"notes_saved_at": "2018-10-12T19:15:22Z",
"pledge_amount": "100.0",
"pledge_currency": "USD",
"pledge_currency_symbol": "$",
"pledge_frequency": "1",
"pledge_received": false,
"pledge_start_date": "2018-09-07",
"send_newsletter": null,
"square_avatar": "https://mpdx.org/images/avatar.png",
"status": "Partner - Financial",
"status_valid": null,
"suggested_changes": {
},
"tag_list": [
"tag_two",
"tag_one"
],
"timezone": null,
"uncompleted_tasks_count": 0,
"updated_at": "2018-10-12T19:15:22Z",
"updated_in_db_at": "2018-10-12T19:15:22Z",
"website": "http://hansen.org/hyman"
},
"relationships": {
"account_list": {
"data": {
"id": "d5d33c20-0e6f-41b6-8d57-f26338888602",
"type": "account_lists"
}
},
"addresses": {
"data": [
]
},
"appeals": {
"data": [
]
},
"contact_referrals_by_me": {
"data": [
]
},
"contact_referrals_to_me": {
"data": [
]
},
"contacts_referred_by_me": {
"data": [
]
},
"contacts_that_referred_me": {
"data": [
]
},
"donation_amount_recommendations": {
"data": [
]
},
"donor_accounts": {
"data": [
]
},
"last_six_donations": {
"data": [
]
},
"people": {
"data": [
]
},
"tasks": {
"data": [
]
},
"primary_person": {
"data": null
},
"primary_or_first_person": {
"data": {
"id": "",
"type": "people"
}
},
"spouse": {
"data": null
}
}
}
},
{
"data": {
"id": "40c3eabf-e47f-46e4-9cb9-c9f76b9d225b",
"type": "contacts",
"attributes": {
"avatar": "https://mpdx.org/images/avatar.png",
"church_name": null,
"created_at": "2018-10-12T19:15:22Z",
"deceased": false,
"direct_deposit": false,
"envelope_greeting": "Cathrine Kautzer",
"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": "2018-10-07",
"likely_to_give": null,
"locale": "en",
"magazine": false,
"name": "Kautzer, Cathrine",
"next_ask": null,
"no_appeals": null,
"no_gift_aid": null,
"notes": "Test Note.",
"notes_saved_at": "2018-10-12T19:15:22Z",
"pledge_amount": "100.0",
"pledge_currency": "USD",
"pledge_currency_symbol": "$",
"pledge_frequency": "1",
"pledge_received": false,
"pledge_start_date": "2018-09-07",
"send_newsletter": null,
"square_avatar": "https://mpdx.org/images/avatar.png",
"status": "Partner - Financial",
"status_valid": null,
"suggested_changes": {
},
"tag_list": [
"tag_two",
"tag_three",
"tag_one"
],
"timezone": null,
"uncompleted_tasks_count": 0,
"updated_at": "2018-10-12T19:15:22Z",
"updated_in_db_at": "2018-10-12T19:15:22Z",
"website": "http://kuphalboyle.com/alia.beier"
},
"relationships": {
"account_list": {
"data": {
"id": "d5d33c20-0e6f-41b6-8d57-f26338888602",
"type": "account_lists"
}
},
"addresses": {
"data": [
]
},
"appeals": {
"data": [
]
},
"contact_referrals_by_me": {
"data": [
]
},
"contact_referrals_to_me": {
"data": [
]
},
"contacts_referred_by_me": {
"data": [
]
},
"contacts_that_referred_me": {
"data": [
]
},
"donation_amount_recommendations": {
"data": [
]
},
"donor_accounts": {
"data": [
]
},
"last_six_donations": {
"data": [
]
},
"people": {
"data": [
]
},
"tasks": {
"data": [
]
},
"primary_person": {
"data": null
},
"primary_or_first_person": {
"data": {
"id": "",
"type": "people"
}
},
"spouse": {
"data": null
}
}
}
}
]
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
People Api
Duplicates
Duplicate [GET]
Duplicate [GET]
Request
Endpoint
GET /api/v2/contacts/people/duplicates/7d49fb34-65f9-4640-860d-a4985ad53881
Content-Type: application/vnd.api+json
GET /api/v2/contacts/people/duplicates/:id
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "7d49fb34-65f9-4640-860d-a4985ad53881",
"type": "duplicate_record_pairs",
"attributes": {
"created_at": "2018-10-12T19:15:13Z",
"ignore": false,
"reason": "Just testing",
"updated_at": "2018-10-12T19:15:13Z",
"updated_in_db_at": "2018-10-12T19:15:13Z"
},
"relationships": {
"account_list": {
"data": {
"id": "db4e2c2d-7f15-4d3d-8f8f-e3a0c404de24",
"type": "account_lists"
}
},
"records": {
"data": [
{
"id": "3dee5e02-b35b-44a7-9b91-bd954cefd724",
"type": "people"
},
{
"id": "fad8dfaa-6ac7-4738-a49e-2f7c0598286e",
"type": "people"
}
]
}
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
amount |
string |
attributes.amount |
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
ignore |
boolean |
Whether or not this duplicate pair should be ignored |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
| Relationships | ||
account_list.data.id |
id string |
The id of the Account List |
records.data |
[Person] |
An array of two Person references |
Duplicate [LIST]
Duplicate [LIST]
Request
Endpoint
GET /api/v2/contacts/people/duplicates
Content-Type: application/vnd.api+json
GET /api/v2/contacts/people/duplicates
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| Filters | |||
filter[account_list_id] |
id string |
Filter by Account List; accepts an Account List id |
- |
filter[ignore] |
Boolean |
Filter by ignored duplicate pairs | - |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": [
{
"id": "ee45f2a4-1a16-4ea0-9028-f682c3474cdb",
"type": "duplicate_record_pairs",
"attributes": {
"created_at": "2018-10-12T19:15:12Z",
"ignore": false,
"reason": "Just testing",
"updated_at": "2018-10-12T19:15:12Z",
"updated_in_db_at": "2018-10-12T19:15:12Z"
},
"relationships": {
"account_list": {
"data": {
"id": "e88c9746-f69f-44be-ac58-154d5fc4d66c",
"type": "account_lists"
}
},
"records": {
"data": [
{
"id": "02b958ca-fbcf-4010-8e01-4b07190652ad",
"type": "people"
},
{
"id": "65f88d07-9443-4778-a0eb-20f7398b8b23",
"type": "people"
}
]
}
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 1,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
data |
[Duplicate Record Pair] |
An array of Duplicate Record Pair Objects |
Duplicate [PUT]
Duplicate [PUT]
Request
Endpoint
PUT /api/v2/contacts/people/duplicates/b1a9395e-0eef-4082-a173-7701428ae99a
Content-Type: application/vnd.api+json
PUT /api/v2/contacts/people/duplicates/:id
Parameters
{
"data": {
"type": "duplicate_record_pairs",
"attributes": {
"ignore": true,
"updated_in_db_at": "2018-10-12 21:15:13 +0200"
},
"relationships": {
"account_list": {
"data": {
"type": "account_lists",
"id": "c67786dd-939e-4eb6-9424-306373a4e9b2"
}
}
}
}
}
| Name | Type | Description | Required |
|---|---|---|---|
| Attributes | |||
amount |
string |
attributes.amount | - |
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created | - |
overwrite |
boolean |
Only used for updating a record where you want to ignore the server’s ’ ’updated_in_db_at value and force overwrite the values for the record. ’ ‘Must be true to work. |
- |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated | - |
updated_in_db_at |
ISO8601 timestamp |
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. | true |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "b1a9395e-0eef-4082-a173-7701428ae99a",
"type": "duplicate_record_pairs",
"attributes": {
"created_at": "2018-10-12T19:15:13Z",
"ignore": true,
"reason": "Just testing",
"updated_at": "2018-10-12T19:15:13Z",
"updated_in_db_at": "2018-10-12T19:15:13Z"
},
"relationships": {
"account_list": {
"data": {
"id": "c67786dd-939e-4eb6-9424-306373a4e9b2",
"type": "account_lists"
}
},
"records": {
"data": [
{
"id": "36608062-2892-4435-b8c0-e5bf80e739f8",
"type": "people"
},
{
"id": "de114bda-229a-40fb-871f-c334b957d7a0",
"type": "people"
}
]
}
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
amount |
string |
attributes.amount |
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
ignore |
boolean |
Whether or not this duplicate pair should be ignored |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
| Relationships | ||
account_list.data.id |
id string |
The id of the Account List |
records.data |
[Person] |
An array of two Person references |
Email Addresses
Email Address [DELETE]
Email Address [DELETE]
Request
Endpoint
DELETE /api/v2/contacts/e2d0357c-866a-42bf-93a7-96cca9b1831f/people/bfe3320c-8832-4bcd-acf7-b43bc029a563/email_addresses/770a6493-84ee-4611-8aff-95af6c2080e7
Content-Type: application/vnd.api+json
DELETE /api/v2/contacts/:contact_id/people/:person_id/email_addresses/:id
Parameters
None known.
Response
204 No Content
Email Address [GET]
Email Address [GET]
Request
Endpoint
GET /api/v2/contacts/6d1d9382-456a-4ed9-9b0c-f43bd8c1f0ef/people/36b97564-5c11-41ed-a52b-8fa6ec29499d/email_addresses/b4fc60c5-d309-4f47-aff7-2149d8748dda
Content-Type: application/vnd.api+json
GET /api/v2/contacts/:contact_id/people/:person_id/email_addresses/:id
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "b4fc60c5-d309-4f47-aff7-2149d8748dda",
"type": "email_addresses",
"attributes": {
"created_at": "2018-10-12T19:15:13Z",
"email": "foo-11@example.com",
"historic": false,
"location": "home",
"primary": true,
"source": "MPDX",
"updated_at": "2018-10-12T19:15:13Z",
"updated_in_db_at": "2018-10-12T19:15:13Z",
"valid_values": true
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
email |
string |
The actual email address that this Email Address resource represents |
historic |
boolean |
This should be true when an Email Address should no longer be used |
location |
string |
Essentially a label for the Email Address, such as 'home’, 'mobile’, 'office’ |
primary |
boolean |
Whether or not the email is the owner’s primary email address. Ultimately there should only be one of these. |
source |
string |
The source of the email address |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
valid_values |
boolean |
This boolean indicates whether the email address is accurate or not |
Email Address [LIST]
Email Address [LIST]
Request
Endpoint
GET /api/v2/contacts/06e4dfbe-b1ce-4b12-9257-76f862f14087/people/8fc148a4-6e47-472d-a11a-5b472db994f6/email_addresses
Content-Type: application/vnd.api+json
GET /api/v2/contacts/:contact_id/people/:person_id/email_addresses
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": [
{
"id": "c6d6584f-cb8c-4284-98ee-7f554fddc1a5",
"type": "email_addresses",
"attributes": {
"created_at": "2018-10-12T19:15:13Z",
"email": "foo-10@example.com",
"historic": false,
"location": "home",
"primary": true,
"source": "MPDX",
"updated_at": "2018-10-12T19:15:13Z",
"updated_in_db_at": "2018-10-12T19:15:13Z",
"valid_values": true
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 1,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
data |
[Email Address] |
An array of Email Address Objects |
Email Address [POST]
Email Address [POST]
Request
Endpoint
POST /api/v2/contacts/e28a9706-50e2-4f6b-bd05-cc008972259a/people/ddadfccf-dd83-44d1-aad7-a32bcd6ed827/email_addresses
Content-Type: application/vnd.api+json
POST /api/v2/contacts/:contact_id/people/:person_id/email_addresses
Parameters
{
"data": {
"type": "email_addresses",
"attributes": {
"email": "foo-13@example.com",
"historic": false,
"location": "home",
"primary": false,
"updated_in_db_at": "2018-10-12 21:15:13 +0200"
}
}
}
| Name | Type | Description | Required |
|---|---|---|---|
| Attributes | |||
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created | - |
email |
string |
The actual email address that this Email Address resource represents | true |
historic |
boolean |
This should be true when an Email Address should no longer be used |
- |
location |
string |
Essentially a label for the Email Address, such as 'home’, 'mobile’, 'office’ | - |
primary |
boolean |
Whether or not the email is the owner’s primary email address. Ultimately there should only be one of these. |
- |
source |
string |
The source of the email address | - |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated | - |
updated_in_db_at |
ISO8601 timestamp |
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. | - |
valid_values |
boolean |
This boolean indicates whether the email address is accurate or not | - |
Response
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
{
"data": {
"id": "e4d49bd4-abc2-4c1c-a140-813603e0c24d",
"type": "email_addresses",
"attributes": {
"created_at": "2018-10-12T19:15:13Z",
"email": "foo-13@example.com",
"historic": false,
"location": "home",
"primary": false,
"source": "MPDX",
"updated_at": "2018-10-12T19:15:13Z",
"updated_in_db_at": "2018-10-12T19:15:13Z",
"valid_values": true
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
email |
string |
The actual email address that this Email Address resource represents |
historic |
boolean |
This should be true when an Email Address should no longer be used |
location |
string |
Essentially a label for the Email Address, such as 'home’, 'mobile’, 'office’ |
primary |
boolean |
Whether or not the email is the owner’s primary email address. Ultimately there should only be one of these. |
source |
string |
The source of the email address |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
valid_values |
boolean |
This boolean indicates whether the email address is accurate or not |
Email Address [PUT]
Email Address [PUT]
Request
Endpoint
PUT /api/v2/contacts/4fa0ab72-cede-47fd-8727-33813141e617/people/dcb72954-c45f-42d9-acac-06455f2c303b/email_addresses/d3ad75f4-1f65-4041-8906-944a91858a4d
Content-Type: application/vnd.api+json
PUT /api/v2/contacts/:contact_id/people/:person_id/email_addresses/:id
Parameters
{
"data": {
"type": "email_addresses",
"attributes": {
"checked_for_google_plus_account": false,
"created_at": "2018-10-12 21:15:13 +0200",
"deleted": false,
"email": "new-email@example.com",
"historic": false,
"location": "home",
"primary": false,
"source": "MPDX",
"updated_at": "2018-10-12 21:15:13 +0200",
"updated_in_db_at": "2018-10-12 21:15:13 +0200",
"valid_values": true
}
}
}
| Name | Type | Description | Required |
|---|---|---|---|
| Attributes | |||
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created | - |
email |
string |
The actual email address that this Email Address resource represents | - |
historic |
boolean |
This should be true when an Email Address should no longer be used |
- |
location |
string |
Essentially a label for the Email Address, such as 'home’, 'mobile’, 'office’ | - |
overwrite |
boolean |
Only used for updating a record where you want to ignore the server’s ’ ’updated_in_db_at value and force overwrite the values for the record. ’ 'Must be true to work. |
- |
primary |
boolean |
Whether or not the email is the owner’s primary email address. Ultimately there should only be one of these. |
- |
source |
string |
The source of the email address | - |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated | - |
updated_in_db_at |
ISO8601 timestamp |
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. | true |
valid_values |
boolean |
This boolean indicates whether the email address is accurate or not | - |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "d3ad75f4-1f65-4041-8906-944a91858a4d",
"type": "email_addresses",
"attributes": {
"created_at": "2018-10-12T19:15:13Z",
"email": "new-email@example.com",
"historic": false,
"location": "home",
"primary": false,
"source": "MPDX",
"updated_at": "2018-10-12T19:15:13Z",
"updated_in_db_at": "2018-10-12T19:15:13Z",
"valid_values": true
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
email |
string |
The actual email address that this Email Address resource represents |
historic |
boolean |
This should be true when an Email Address should no longer be used |
location |
string |
Essentially a label for the Email Address, such as 'home’, 'mobile’, 'office’ |
primary |
boolean |
Whether or not the email is the owner’s primary email address. Ultimately there should only be one of these. |
source |
string |
The source of the email address |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
valid_values |
boolean |
This boolean indicates whether the email address is accurate or not |
Facebook Accounts
Facebook Account [CREATE]
Create a Facebook Account associated with the Person
Request
Endpoint
POST /api/v2/contacts/4ea14ac6-1bba-4901-91b1-e0c803df1cf7/people/9c31b7f5-5675-4529-bb7d-263e5deb87dd/facebook_accounts
Content-Type: application/vnd.api+json
POST /api/v2/contacts/:contact_id/people/:person_id/facebook_accounts
Parameters
{
"data": {
"type": "facebook_accounts",
"attributes": {
"first_name": "Nash",
"last_name": "Kuhic",
"token": "TokenString",
"token_expires_at": "2018-10-13 21:15:14 +0200",
"updated_in_db_at": "2018-10-12 21:15:14 +0200",
"username": "kuhic_nash"
}
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
{
"data": {
"id": "2761a5be-91eb-4886-b00f-0b9ae20c9ab2",
"type": "facebook_accounts",
"attributes": {
"created_at": "2018-10-12T19:15:14Z",
"first_name": "Nash",
"last_name": "Kuhic",
"remote_id": null,
"updated_at": "2018-10-12T19:15:14Z",
"updated_in_db_at": "2018-10-12T19:15:14Z",
"username": "kuhic_nash"
}
}
}
Facebook Account [DELETE]
Delete the Person’s Facebook Account with the given ID
Request
Endpoint
DELETE /api/v2/contacts/7bca0640-b85d-4797-85e3-72c92de52d28/people/42192060-456c-4f62-83ec-dddfcbfc1d67/facebook_accounts/2aba954e-d48a-4780-9ce4-fa194a42cd1a
Content-Type: application/vnd.api+json
DELETE /api/v2/contacts/:contact_id/people/:person_id/facebook_accounts/:id
Parameters
| Name | Type | Description | Required |
|---|
Response
204 No Content
Facebook Account [GET]
The Person’s Facebook Account with the given ID
Request
Endpoint
GET /api/v2/contacts/6f3162ab-1379-4cbd-bf44-efb4f9b2b077/people/5d6a11eb-917b-4d4d-a468-114f3f540ad6/facebook_accounts/a9b8ff23-1431-46e4-a91b-cf97657dd710
Content-Type: application/vnd.api+json
GET /api/v2/contacts/:contact_id/people/:person_id/facebook_accounts/:id
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "a9b8ff23-1431-46e4-a91b-cf97657dd710",
"type": "facebook_accounts",
"attributes": {
"created_at": "2018-10-12T19:15:14Z",
"first_name": "Jeanne",
"last_name": "Bogan",
"remote_id": 6,
"updated_at": "2018-10-12T19:15:14Z",
"updated_in_db_at": "2018-10-12T19:15:14Z",
"username": "jeanne_bogan"
}
}
}
Fields
| Name | Type | Description |
|---|
Facebook Account [LIST]
List of Facebook Accounts associated to the Person
Request
Endpoint
GET /api/v2/contacts/b2ab4194-af3b-4117-9208-53b3606df278/people/eec3353d-8ca4-4ea4-a2b4-116c9188f9f0/facebook_accounts
Content-Type: application/vnd.api+json
GET /api/v2/contacts/:contact_id/people/:person_id/facebook_accounts
Parameters
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": [
{
"id": "064569c4-4439-43ed-95ea-3feea52a83ab",
"type": "facebook_accounts",
"attributes": {
"created_at": "2018-10-12T19:15:14Z",
"first_name": "Rasheed",
"last_name": "Leuschke",
"remote_id": 4,
"updated_at": "2018-10-12T19:15:14Z",
"updated_in_db_at": "2018-10-12T19:15:14Z",
"username": "rasheed.leuschke"
}
},
{
"id": "34ac5719-71a2-474e-b0f6-172c99726030",
"type": "facebook_accounts",
"attributes": {
"created_at": "2018-10-12T19:15:14Z",
"first_name": "Aiyana",
"last_name": "Little",
"remote_id": 5,
"updated_at": "2018-10-12T19:15:14Z",
"updated_in_db_at": "2018-10-12T19:15:14Z",
"username": "aiyana_little"
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 2,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
data |
Array[Object] |
Data |
Facebook Account [UPDATE]
Update the Person’s Facebook Account with the given ID
Request
Endpoint
PUT /api/v2/contacts/37791ba7-9653-43da-9f6b-a5eb2e02a01f/people/c415b42c-0c78-41bc-8949-ccee7effa905/facebook_accounts/abc9cdfd-11f8-46a8-9ea0-0458eb4ce851
Content-Type: application/vnd.api+json
PUT /api/v2/contacts/:contact_id/people/:person_id/facebook_accounts/:id
Parameters
{
"data": {
"type": "facebook_accounts",
"attributes": {
"first_name": "Merritt",
"last_name": "Barrows",
"token": "TokenString",
"token_expires_at": "2018-10-13 21:15:14 +0200",
"updated_in_db_at": "2018-10-12 21:15:14 +0200",
"username": "merritt.barrows"
}
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "abc9cdfd-11f8-46a8-9ea0-0458eb4ce851",
"type": "facebook_accounts",
"attributes": {
"created_at": "2018-10-12T19:15:14Z",
"first_name": "Merritt",
"last_name": "Barrows",
"remote_id": 11,
"updated_at": "2018-10-12T19:15:14Z",
"updated_in_db_at": "2018-10-12T19:15:14Z",
"username": "merritt.barrows"
}
}
}
Linkedin Accounts
Linkedin Account [DELETE]
Linkedin Account [DELETE]
Request
Endpoint
DELETE /api/v2/contacts/f93041fb-f926-4b5c-8127-be6edc56dc3f/people/75112b06-accd-4364-94ef-d8c5a16bfe11/linkedin_accounts/c8e216db-f4c0-4254-837b-b3b7a90b2597
Content-Type: application/vnd.api+json
DELETE /api/v2/contacts/:contact_id/people/:person_id/linkedin_accounts/:id
Parameters
None known.
Response
204 No Content
Linkedin Account [GET]
Linkedin Account [GET]
Request
Endpoint
GET /api/v2/contacts/cd280a24-c5f6-49b4-a2ab-721bdb17d573/people/fabeaefd-a946-49be-a1bb-34b5f91d69b1/linkedin_accounts/5a76ef36-9823-4214-abd7-a820445e31c0
Content-Type: application/vnd.api+json
GET /api/v2/contacts/:contact_id/people/:person_id/linkedin_accounts/:id
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "5a76ef36-9823-4214-abd7-a820445e31c0",
"type": "linkedin_accounts",
"attributes": {
"created_at": "2018-10-12T19:15:15Z",
"public_url": "http://example.com/username1",
"updated_at": "2018-10-12T19:15:15Z",
"updated_in_db_at": "2018-10-12T19:15:15Z"
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
public_url |
string |
The URL of the Person’s LinkedIn Account |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
Linkedin Account [LIST]
A list of the LinkedIn Accounts associated with the Person
Request
Endpoint
GET /api/v2/contacts/6564064a-1b06-4a77-a9df-3b75f2f9ae83/people/1eb494bd-20f1-4452-9438-6f69e3983dc4/linkedin_accounts
Content-Type: application/vnd.api+json
GET /api/v2/contacts/:contact_id/people/:person_id/linkedin_accounts
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": [
{
"id": "8c82ba83-bf73-4e44-b52d-12d7e1ae5c35",
"type": "linkedin_accounts",
"attributes": {
"created_at": "2018-10-12T19:15:14Z",
"public_url": "http://example.com/username1",
"updated_at": "2018-10-12T19:15:14Z",
"updated_in_db_at": "2018-10-12T19:15:14Z"
}
},
{
"id": "10ff4407-4c75-4723-bac8-b7513bd23c9d",
"type": "linkedin_accounts",
"attributes": {
"created_at": "2018-10-12T19:15:14Z",
"public_url": "http://example.com/username1",
"updated_at": "2018-10-12T19:15:14Z",
"updated_in_db_at": "2018-10-12T19:15:14Z"
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 2,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
data |
[LinkedIn Account] |
An array of LinkedIn Account objects |
Linkedin Account [POST]
Linkedin Account [POST]
Request
Endpoint
POST /api/v2/contacts/99a3f740-eadb-4911-825b-b0cab01b0031/people/a027fec0-fa28-431c-941b-54cc33667d40/linkedin_accounts
Content-Type: application/vnd.api+json
POST /api/v2/contacts/:contact_id/people/:person_id/linkedin_accounts
Parameters
{
"data": {
"type": "linkedin_accounts",
"attributes": {
"public_url": "http://example.com/username1",
"updated_in_db_at": "2018-10-12 21:15:15 +0200"
}
}
}
| Name | Type | Description | Required |
|---|---|---|---|
| Attributes | |||
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created | - |
public_url |
string |
The URL of the Person’s LinkedIn Account | true |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated | - |
updated_in_db_at |
ISO8601 timestamp |
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. | - |
Response
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
{
"data": {
"id": "e8b79284-7d50-47cc-bee5-b62ec08fd6fe",
"type": "linkedin_accounts",
"attributes": {
"created_at": "2018-10-12T19:15:15Z",
"public_url": "http://example.com/username1",
"updated_at": "2018-10-12T19:15:15Z",
"updated_in_db_at": "2018-10-12T19:15:15Z"
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
public_url |
string |
The URL of the Person’s LinkedIn Account |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
Linkedin Account [PUT]
Linkedin Account [PUT]
Request
Endpoint
PUT /api/v2/contacts/81307f08-fedc-4d8c-a685-cb5c5dcecc3f/people/1384c3dd-b170-4f52-97f7-71405e3d5b9c/linkedin_accounts/e80bdde5-f5d5-4616-88d9-10a7b46e22d1
Content-Type: application/vnd.api+json
PUT /api/v2/contacts/:contact_id/people/:person_id/linkedin_accounts/:id
Parameters
{
"data": {
"type": "linkedin_accounts",
"attributes": {
"public_url": "http://example.com/username1",
"updated_in_db_at": "2018-10-12 21:15:15 +0200"
}
}
}
| Name | Type | Description | Required |
|---|---|---|---|
| Attributes | |||
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created | - |
overwrite |
boolean |
Only used for updating a record where you want to ignore the server’s ’ ’updated_in_db_at value and force overwrite the values for the record. ’ 'Must be true to work. |
- |
public_url |
string |
The URL of the Person’s LinkedIn Account | - |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated | - |
updated_in_db_at |
ISO8601 timestamp |
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. | true |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "e80bdde5-f5d5-4616-88d9-10a7b46e22d1",
"type": "linkedin_accounts",
"attributes": {
"created_at": "2018-10-12T19:15:15Z",
"public_url": "http://example.com/username1",
"updated_at": "2018-10-12T19:15:15Z",
"updated_in_db_at": "2018-10-12T19:15:15Z"
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
public_url |
string |
The URL of the Person’s LinkedIn Account |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
Merges
Merge People [BULK POST]
Bulk merge People with the given IDs
Request
Endpoint
POST /api/v2/contacts/people/merges/bulk
Content-Type: application/vnd.api+json
POST /api/v2/contacts/people/merges/bulk
Parameters
{
"data": [
{
"data": {
"attributes": {
"winner_id": "7de75561-f5d9-4dc1-a817-edbc3e7bc9c1",
"loser_id": "f5c716d2-1509-4d26-8b00-255c8df749b4"
}
}
}
]
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
[
{
"data": {
"id": "7de75561-f5d9-4dc1-a817-edbc3e7bc9c1",
"type": "people",
"attributes": {
"anniversary_day": null,
"anniversary_month": null,
"anniversary_year": null,
"avatar": "https://mpdx.org/images/avatar.png",
"birthday_day": null,
"birthday_month": null,
"birthday_year": null,
"created_at": "2018-10-12T19:15:15Z",
"deceased": false,
"employer": null,
"first_name": "Mina",
"gender": null,
"last_name": "Mertz",
"legal_first_name": null,
"marital_status": null,
"middle_name": null,
"occupation": null,
"optout_enewsletter": false,
"parent_contacts": [
"5c7ec91d-83d5-4583-97a6-6c54e58e98dc"
],
"suffix": null,
"title": null,
"updated_at": "2018-10-12T19:15:15Z",
"updated_in_db_at": "2018-10-12T19:15:15Z"
},
"relationships": {
"email_addresses": {
"data": [
]
},
"facebook_accounts": {
"data": [
]
},
"family_relationships": {
"data": [
]
},
"linkedin_accounts": {
"data": [
]
},
"phone_numbers": {
"data": [
]
},
"twitter_accounts": {
"data": [
]
},
"websites": {
"data": [
]
}
}
}
}
]
Phones
Phone [CREATE]
Create a Phone Number associated with the Person
Request
Endpoint
POST /api/v2/contacts/8ecc9477-d0bd-4661-9849-27172e9b67ed/people/b0049432-fb4b-4852-b802-6495cd95b66d/phones
Content-Type: application/vnd.api+json
POST /api/v2/contacts/:contact_id/people/:person_id/phones
Parameters
{
"data": {
"type": "phone_numbers",
"attributes": {
"country_code": "MyString",
"location": "mobile",
"number": "3561987123",
"primary": false,
"updated_in_db_at": "2018-10-12 21:15:16 +0200",
"valid_values": true
}
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
{
"data": {
"id": "4a4e86ba-ac06-41b6-a05d-5c5fa353831d",
"type": "phone_numbers",
"attributes": {
"country_code": "1",
"created_at": "2018-10-12T19:15:16Z",
"historic": false,
"location": "mobile",
"number": "3561987123",
"primary": false,
"source": "MPDX",
"updated_at": "2018-10-12T19:15:16Z",
"updated_in_db_at": "2018-10-12T19:15:16Z",
"valid_values": true
}
}
}
Phone [DELETE]
Delete Person’s Phone Number with the given ID
Request
Endpoint
DELETE /api/v2/contacts/02ff9e70-d2aa-4c25-8437-1b5f0a0a4f10/people/3b059168-0a54-437e-8136-c772dbc67407/phones/0fe7d405-8a76-417f-a2a0-45edadbce928
Content-Type: application/vnd.api+json
DELETE /api/v2/contacts/:contact_id/people/:person_id/phones/:id
Parameters
None known.
Response
204 No Content
Phone [GET]
The Person’s Phone Number with the given ID
Request
Endpoint
GET /api/v2/contacts/757c8906-2202-4bba-a619-fe86bb02af00/people/384d0e2b-a3cf-4287-95c2-dfd56145e224/phones/820347f2-486d-4d19-99d7-c10b66441974
Content-Type: application/vnd.api+json
GET /api/v2/contacts/:contact_id/people/:person_id/phones/:id
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "820347f2-486d-4d19-99d7-c10b66441974",
"type": "phone_numbers",
"attributes": {
"country_code": "1",
"created_at": "2018-10-12T19:15:16Z",
"historic": false,
"location": "mobile",
"number": "(213) 456-7890",
"primary": true,
"source": "MPDX",
"updated_at": "2018-10-12T19:15:16Z",
"updated_in_db_at": "2018-10-12T19:15:16Z",
"valid_values": true
}
}
}
Fields
| Name | Type | Description |
|---|
Phone [LIST]
List of Phone Numbers associated to the Person
Request
Endpoint
GET /api/v2/contacts/bceb88a1-ec6e-4be3-a8f9-e9fdeac12f1e/people/8fe4c55f-128f-4cb9-91c6-ba0bcfc11537/phones
Content-Type: application/vnd.api+json
GET /api/v2/contacts/:contact_id/people/:person_id/phones
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": [
{
"id": "820d0be8-3b9e-4d12-b514-2c4d86ff36bb",
"type": "phone_numbers",
"attributes": {
"country_code": "1",
"created_at": "2018-10-12T19:15:16Z",
"historic": false,
"location": "mobile",
"number": "(213) 456-7890",
"primary": true,
"source": "MPDX",
"updated_at": "2018-10-12T19:15:16Z",
"updated_in_db_at": "2018-10-12T19:15:16Z",
"valid_values": true
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 1,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}
Phone [UPDATE]
Update Person’s Phone Number with the given ID
Request
Endpoint
PUT /api/v2/contacts/827a2d0f-a2dd-4bc1-8064-119b52fd2840/people/503fb0f1-30a9-4736-9f5a-cd7063670220/phones/fbb0a4ae-c4e7-4e25-851f-0bb5514c32d1
Content-Type: application/vnd.api+json
PUT /api/v2/contacts/:contact_id/people/:person_id/phones/:id
Parameters
{
"data": {
"type": "phone_numbers",
"attributes": {
"country_code": "MyString",
"location": "mobile",
"number": "3561987123",
"primary": false,
"updated_in_db_at": "2018-10-12 21:15:16 +0200",
"valid_values": true
}
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "fbb0a4ae-c4e7-4e25-851f-0bb5514c32d1",
"type": "phone_numbers",
"attributes": {
"country_code": "1",
"created_at": "2018-10-12T19:15:16Z",
"historic": false,
"location": "mobile",
"number": "3561987123",
"primary": false,
"source": "MPDX",
"updated_at": "2018-10-12T19:15:16Z",
"updated_in_db_at": "2018-10-12T19:15:16Z",
"valid_values": true
}
}
}
Relationships
Relationship [CREATE]
Create a Relationship associated with the Person
Request
Endpoint
POST /api/v2/contacts/bf1fc432-1abe-4c58-9859-edb799968bff/people/6afef7a9-58d4-4578-8145-9b36441f7c05/relationships
Content-Type: application/vnd.api+json
POST /api/v2/contacts/:contact_id/people/:person_id/relationships
Parameters
{
"data": {
"type": "family_relationships",
"attributes": {
"overwrite": true,
"relationship": "MyString"
},
"relationships": {
"person": {
"data": {
"type": "people",
"id": "6afef7a9-58d4-4578-8145-9b36441f7c05"
}
},
"related_person": {
"data": {
"type": "people",
"id": "30b7ceba-e698-4899-807f-1f05e6e5929b"
}
}
}
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
{
"data": {
"id": "292421d1-b9e7-47df-ae0c-5189f6b7a57d",
"type": "family_relationships",
"attributes": {
"created_at": "2018-10-12T19:15:17Z",
"relationship": "MyString",
"updated_at": "2018-10-12T19:15:17Z",
"updated_in_db_at": "2018-10-12T19:15:17Z"
},
"relationships": {
"related_person": {
"data": {
"id": "30b7ceba-e698-4899-807f-1f05e6e5929b",
"type": "people"
}
}
}
}
}
Relationship [DELETE]
Delete the Person’s Relationship with the given ID
Request
Endpoint
DELETE /api/v2/contacts/9e2f526b-dbd9-4261-acb0-1b2055b6852b/people/99a50654-dc56-4383-9002-2aa14a51a555/relationships/e18669fc-ada6-46da-bfdc-0ea445fe846f
Content-Type: application/vnd.api+json
DELETE /api/v2/contacts/:contact_id/people/:person_id/relationships/:id
Parameters
None known.
Response
204 No Content
Relationship [GET]
The Person’s Relationship with the given ID
Request
Endpoint
GET /api/v2/contacts/1f91cbf5-e28b-4642-a814-b2537e102ef3/people/3bcb5fbf-5c74-4407-a2d8-0d635559141f/relationships/0ef7eadf-c32c-4019-88c9-e734c00b7791
Content-Type: application/vnd.api+json
GET /api/v2/contacts/:contact_id/people/:person_id/relationships/:id
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "0ef7eadf-c32c-4019-88c9-e734c00b7791",
"type": "family_relationships",
"attributes": {
"created_at": "2018-10-12T19:15:17Z",
"relationship": "MyString",
"updated_at": "2018-10-12T19:15:17Z",
"updated_in_db_at": "2018-10-12T19:15:17Z"
},
"relationships": {
"related_person": {
"data": {
"id": "df104e78-1e77-4dfd-80f4-d2323fec7389",
"type": "people"
}
}
}
}
}
Fields
| Name | Type | Description |
|---|
Relationship [LIST]
List of Relationships associated to the Person
Request
Endpoint
GET /api/v2/contacts/e66a5a4e-5433-4110-961e-bbaed00253ea/people/480054ed-8e57-41aa-b127-76ebcd821e40/relationships
Content-Type: application/vnd.api+json
GET /api/v2/contacts/:contact_id/people/:person_id/relationships
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": [
{
"id": "bf566ddb-193c-44cb-9371-00ce2f91fb5f",
"type": "family_relationships",
"attributes": {
"created_at": "2018-10-12T19:15:17Z",
"relationship": "MyString",
"updated_at": "2018-10-12T19:15:17Z",
"updated_in_db_at": "2018-10-12T19:15:17Z"
},
"relationships": {
"related_person": {
"data": {
"id": "a8f79ac8-0418-47e3-93c9-a78a74a7cb85",
"type": "people"
}
}
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 1,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}
Relationship [UPDATE]
Update the Person’s Relationship with the given ID
Request
Endpoint
PUT /api/v2/contacts/33eaf6b2-1fb0-4927-b949-f91716957ebb/people/5267ae55-195e-41ef-a822-901400ae2aa7/relationships/47d6a664-1109-47bd-b4f6-5999632329e3
Content-Type: application/vnd.api+json
PUT /api/v2/contacts/:contact_id/people/:person_id/relationships/:id
Parameters
{
"data": {
"type": "family_relationships",
"attributes": {
"overwrite": true,
"relationship": "MyString"
},
"relationships": {
"person": {
"data": {
"type": "people",
"id": "5267ae55-195e-41ef-a822-901400ae2aa7"
}
},
"related_person": {
"data": {
"type": "people",
"id": "b9b50435-f63d-4ea3-93e8-7c6a8f5a72e2"
}
}
}
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "47d6a664-1109-47bd-b4f6-5999632329e3",
"type": "family_relationships",
"attributes": {
"created_at": "2018-10-12T19:15:17Z",
"relationship": "MyString",
"updated_at": "2018-10-12T19:15:17Z",
"updated_in_db_at": "2018-10-12T19:15:17Z"
},
"relationships": {
"related_person": {
"data": {
"id": "b9b50435-f63d-4ea3-93e8-7c6a8f5a72e2",
"type": "people"
}
}
}
}
}
Twitter Accounts
Twitter Account [DELETE]
Twitter Account [DELETE]
Request
Endpoint
DELETE /api/v2/contacts/7011b346-b962-4306-9a08-5dc1ec3c7e2c/people/1df7bf3b-4023-4fb2-9388-2683b90a1585/twitter_accounts/c031c440-13cf-4c08-8bbe-d97e19c6c133
Content-Type: application/vnd.api+json
DELETE /api/v2/contacts/:contact_id/people/:person_id/twitter_accounts/:id
Parameters
None known.
Response
204 No Content
Twitter Account [GET]
Twitter Account [GET]
Request
Endpoint
GET /api/v2/contacts/0dd067c5-5b28-4248-abcb-c5ab42756469/people/183abf46-5e58-44cf-a4c2-dcf851e52ccf/twitter_accounts/3a5dcc62-5bfd-4fbb-9e8d-dcba3b50f942
Content-Type: application/vnd.api+json
GET /api/v2/contacts/:contact_id/people/:person_id/twitter_accounts/:id
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "3a5dcc62-5bfd-4fbb-9e8d-dcba3b50f942",
"type": "twitter_accounts",
"attributes": {
"created_at": "2018-10-12T19:15:18Z",
"primary": false,
"remote_id": 3,
"screen_name": "rhoda_gerhold",
"updated_at": "2018-10-12T19:15:18Z",
"updated_in_db_at": "2018-10-12T19:15:18Z"
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
primary |
boolean |
Whether or not this Twitter Account is the Person’s primary account |
remote_id |
integer |
The id for this Twitter Account from Twitter.com (this will likely be null) |
screen_name |
string |
The screen name for the Person’s Twitter Account |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
Twitter Account [LIST]
Twitter Account [LIST]
Request
Endpoint
GET /api/v2/contacts/b57939cd-d1a6-4fb7-b693-30296f245a87/people/756727c0-203b-46ae-a59f-f4c98f5e4e44/twitter_accounts
Content-Type: application/vnd.api+json
GET /api/v2/contacts/:contact_id/people/:person_id/twitter_accounts
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": [
{
"id": "0ae5c608-9999-4c20-ad91-5b0b4175fdf6",
"type": "twitter_accounts",
"attributes": {
"created_at": "2018-10-12T19:15:17Z",
"primary": false,
"remote_id": 1,
"screen_name": "cory",
"updated_at": "2018-10-12T19:15:17Z",
"updated_in_db_at": "2018-10-12T19:15:17Z"
}
},
{
"id": "81ad2b45-b07d-4289-9e7d-7e8a8e890f88",
"type": "twitter_accounts",
"attributes": {
"created_at": "2018-10-12T19:15:18Z",
"primary": false,
"remote_id": 2,
"screen_name": "raheem",
"updated_at": "2018-10-12T19:15:18Z",
"updated_in_db_at": "2018-10-12T19:15:18Z"
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 2,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
data |
[Twitter Account] |
An array of Twitter Account Objects |
Twitter Account [POST]
Twitter Account [POST]
Request
Endpoint
POST /api/v2/contacts/e6f2c5da-685e-455f-94ee-ff47540f1c62/people/48566997-1015-4b9e-b06b-b6ef105ff32b/twitter_accounts
Content-Type: application/vnd.api+json
POST /api/v2/contacts/:contact_id/people/:person_id/twitter_accounts
Parameters
{
"data": {
"type": "twitter_accounts",
"attributes": {
"screen_name": "suzanne_nolan",
"updated_in_db_at": "2018-10-12 21:15:18 +0200"
}
}
}
| Name | Type | Description | Required |
|---|---|---|---|
| Attributes | |||
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created | - |
primary |
boolean |
Whether or not this Twitter Account is the Person’s primary account | - |
remote_id |
integer |
The id for this Twitter Account from Twitter.com (this will likely be null) |
- |
screen_name |
string |
The screen name for the Person’s Twitter Account | true |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated | - |
updated_in_db_at |
ISO8601 timestamp |
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. | - |
Response
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
{
"data": {
"id": "90973fa9-c0ab-4420-a8f1-ad24355f2a10",
"type": "twitter_accounts",
"attributes": {
"created_at": "2018-10-12T19:15:18Z",
"primary": false,
"remote_id": null,
"screen_name": "suzanne_nolan",
"updated_at": "2018-10-12T19:15:18Z",
"updated_in_db_at": "2018-10-12T19:15:18Z"
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
primary |
boolean |
Whether or not this Twitter Account is the Person’s primary account |
remote_id |
integer |
The id for this Twitter Account from Twitter.com (this will likely be null) |
screen_name |
string |
The screen name for the Person’s Twitter Account |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
Twitter Account [PUT]
Twitter Account [PUT]
Request
Endpoint
PUT /api/v2/contacts/47d607f4-96ff-4a6c-9d7f-2c5dc6d5a5f4/people/0edcda23-ea71-4a40-8449-f6220f7ae2a1/twitter_accounts/e7be81f6-4bbc-4562-b24f-9d96d1b647cc
Content-Type: application/vnd.api+json
PUT /api/v2/contacts/:contact_id/people/:person_id/twitter_accounts/:id
Parameters
{
"data": {
"type": "twitter_accounts",
"attributes": {
"screen_name": "hosea_breitenberg",
"updated_in_db_at": "2018-10-12 21:15:18 +0200"
}
}
}
| Name | Type | Description | Required |
|---|---|---|---|
| Attributes | |||
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created | - |
overwrite |
boolean |
Only used for updating a record where you want to ignore the server’s ’ ’updated_in_db_at value and force overwrite the values for the record. ’ 'Must be true to work. |
- |
primary |
boolean |
Whether or not this Twitter Account is the Person’s primary account | - |
remote_id |
integer |
The id for this Twitter Account from Twitter.com (this will likely be null) |
- |
screen_name |
string |
The screen name for the Person’s Twitter Account | - |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated | - |
updated_in_db_at |
ISO8601 timestamp |
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. | true |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "e7be81f6-4bbc-4562-b24f-9d96d1b647cc",
"type": "twitter_accounts",
"attributes": {
"created_at": "2018-10-12T19:15:18Z",
"primary": false,
"remote_id": 8,
"screen_name": "hosea_breitenberg",
"updated_at": "2018-10-12T19:15:18Z",
"updated_in_db_at": "2018-10-12T19:15:18Z"
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
primary |
boolean |
Whether or not this Twitter Account is the Person’s primary account |
remote_id |
integer |
The id for this Twitter Account from Twitter.com (this will likely be null) |
screen_name |
string |
The screen name for the Person’s Twitter Account |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
Websites
Website [CREATE]
Create a Website associated with the Person
Request
Endpoint
POST /api/v2/contacts/ca6bdb91-6cfb-4d4d-bd66-a5745970861a/people/74cf6372-eeb0-4c67-bf27-6060f41f85a0/websites
Content-Type: application/vnd.api+json
POST /api/v2/contacts/:contact_id/people/:person_id/websites
Parameters
{
"data": {
"type": "websites",
"attributes": {
"primary": true,
"updated_in_db_at": "2018-10-12 21:15:19 +0200",
"url": "http://wiza.net/edythe_spinka"
}
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
{
"data": {
"id": "a10f276a-4ef4-483d-98e5-9cee7ff981bd",
"type": "websites",
"attributes": {
"created_at": "2018-10-12T19:15:19Z",
"primary": false,
"updated_at": "2018-10-12T19:15:19Z",
"updated_in_db_at": "2018-10-12T19:15:19Z",
"url": "http://wiza.net/edythe_spinka"
}
}
}
Website [DELETE]
Delete the Person’s Website with the given ID
Request
Endpoint
DELETE /api/v2/contacts/ede3d3cc-d84e-43c0-8c5e-6c7de619e02b/people/31f46252-f6c6-42b8-8632-2ea115284242/websites/92fae1d8-2e60-48d7-8519-7fa86689ddec
Content-Type: application/vnd.api+json
DELETE /api/v2/contacts/:contact_id/people/:person_id/websites/:id
Parameters
| Name | Type | Description | Required |
|---|
Response
204 No Content
Website [GET]
The Person’s Website with the given ID
Request
Endpoint
GET /api/v2/contacts/1770a298-01c6-413f-a165-99341fef5651/people/80ed0850-3703-47a1-84cb-e10983d4670f/websites/a9516e2d-002f-4751-8d42-55d92dc4f844
Content-Type: application/vnd.api+json
GET /api/v2/contacts/:contact_id/people/:person_id/websites/:id
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "a9516e2d-002f-4751-8d42-55d92dc4f844",
"type": "websites",
"attributes": {
"created_at": "2018-10-12T19:15:18Z",
"primary": true,
"updated_at": "2018-10-12T19:15:18Z",
"updated_in_db_at": "2018-10-12T19:15:18Z",
"url": "http://langosh.com/florencio_bauch"
}
}
}
Fields
| Name | Type | Description |
|---|
Website [LIST]
List of Websites associated to the Person
Request
Endpoint
GET /api/v2/contacts/c295e31c-a6bb-4460-b020-dde03a11c48e/people/87263e91-b329-4bc7-9bef-11b1b72719c6/websites
Content-Type: application/vnd.api+json
GET /api/v2/contacts/:contact_id/people/:person_id/websites
Parameters
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": [
{
"id": "c93e8973-82f5-4300-a52b-c3f5c653cf39",
"type": "websites",
"attributes": {
"created_at": "2018-10-12T19:15:18Z",
"primary": true,
"updated_at": "2018-10-12T19:15:18Z",
"updated_in_db_at": "2018-10-12T19:15:18Z",
"url": "http://ortiz.org/elias"
}
},
{
"id": "04d13357-70e1-467b-8cc1-3f400ce24775",
"type": "websites",
"attributes": {
"created_at": "2018-10-12T19:15:18Z",
"primary": true,
"updated_at": "2018-10-12T19:15:18Z",
"updated_in_db_at": "2018-10-12T19:15:18Z",
"url": "http://beier.io/john"
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 2,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
data |
Array[Object] |
Data |
Website [UPDATE]
Update the Person’s Website with the given ID
Request
Endpoint
PUT /api/v2/contacts/5e09ccdb-524c-4091-bc97-1744df4d7ad8/people/c0af9390-0fb4-4426-906b-9858f87c4775/websites/a4df4a2d-743d-4d38-94c2-450c02441ccc
Content-Type: application/vnd.api+json
PUT /api/v2/contacts/:contact_id/people/:person_id/websites/:id
Parameters
{
"data": {
"type": "websites",
"attributes": {
"primary": true,
"updated_in_db_at": "2018-10-12 21:15:19 +0200",
"url": "http://larkin.net/monserrate.barrows"
}
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "a4df4a2d-743d-4d38-94c2-450c02441ccc",
"type": "websites",
"attributes": {
"created_at": "2018-10-12T19:15:19Z",
"primary": true,
"updated_at": "2018-10-12T19:15:19Z",
"updated_in_db_at": "2018-10-12T19:15:19Z",
"url": "http://larkin.net/monserrate.barrows"
}
}
}
Reports Api
Appointment Results
Appointment Result [LIST]
Appointment Result [LIST]
Request
Endpoint
GET /api/v2/reports/appointment_results/
Content-Type: application/vnd.api+json
GET /api/v2/reports/appointment_results/
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| Filters | |||
filter[account_list_id] |
string |
The account list to run the report on. | - |
filter[end_date] |
string |
The date in which you would like the report to end on. |
This will be shifted to the end of the final period.
Default: today
| - |
| filter[period] | string | A string defining the number of periods and how long they should be with an indictor:
(d)ay, (w)eek, (m)onth, (y)ear.
Examples: 30d, 2w, 12m, 1y.
Default: 4m
| - |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": [
{
"id": "2018-10-08",
"type": "reports_appointment_results_periods",
"attributes": {
"created_at": "2018-10-12T19:15:24Z",
"end_date": "2018-10-14T21:59:59Z",
"group_appointments": 0,
"individual_appointments": 0,
"monthly_decrease": 0,
"monthly_increase": 0,
"new_monthly_partners": 0,
"new_special_pledges": 0,
"pledge_increase": "0.0",
"start_date": "2018-10-07T22:00:00Z",
"updated_at": null,
"updated_in_db_at": null,
"weekly_individual_appointment_goal": 10
},
"relationships": {
"pledge_increase_contacts": {
"data": [
]
},
"new_pledges": {
"data": [
]
}
}
},
{
"id": "2018-10-01",
"type": "reports_appointment_results_periods",
"attributes": {
"created_at": "2018-10-12T19:15:24Z",
"end_date": "2018-10-07T21:59:59Z",
"group_appointments": 0,
"individual_appointments": 0,
"monthly_decrease": 0,
"monthly_increase": 0,
"new_monthly_partners": 0,
"new_special_pledges": 0,
"pledge_increase": "0.0",
"start_date": "2018-09-30T22:00:00Z",
"updated_at": null,
"updated_in_db_at": null,
"weekly_individual_appointment_goal": 10
},
"relationships": {
"pledge_increase_contacts": {
"data": [
]
},
"new_pledges": {
"data": [
]
}
}
},
{
"id": "2018-09-24",
"type": "reports_appointment_results_periods",
"attributes": {
"created_at": "2018-10-12T19:15:24Z",
"end_date": "2018-09-30T21:59:59Z",
"group_appointments": 0,
"individual_appointments": 0,
"monthly_decrease": 0,
"monthly_increase": 0,
"new_monthly_partners": 0,
"new_special_pledges": 0,
"pledge_increase": "0.0",
"start_date": "2018-09-23T22:00:00Z",
"updated_at": null,
"updated_in_db_at": null,
"weekly_individual_appointment_goal": 10
},
"relationships": {
"pledge_increase_contacts": {
"data": [
]
},
"new_pledges": {
"data": [
]
}
}
},
{
"id": "2018-09-17",
"type": "reports_appointment_results_periods",
"attributes": {
"created_at": "2018-10-12T19:15:24Z",
"end_date": "2018-09-23T21:59:59Z",
"group_appointments": 0,
"individual_appointments": 0,
"monthly_decrease": 0,
"monthly_increase": 0,
"new_monthly_partners": 0,
"new_special_pledges": 0,
"pledge_increase": "0.0",
"start_date": "2018-09-16T22:00:00Z",
"updated_at": null,
"updated_in_db_at": null,
"weekly_individual_appointment_goal": 10
},
"relationships": {
"pledge_increase_contacts": {
"data": [
]
},
"new_pledges": {
"data": [
]
}
}
}
],
"meta": {
"sort": null,
"filter": {
},
"averages": {
"average_individual_appointments": 0,
"average_group_appointments": 0,
"average_new_monthly_partners": 0,
"average_new_special_pledges": 0,
"average_monthly_increase": 0,
"average_pledge_increase": 0
}
}
}
Donation Summaries
Donation Summary [LIST]
Lists donors who donated in the past 12 months, separated by into currency groups
Request
Endpoint
GET /api/v2/reports/donation_monthly_totals?filter[account_list_id]=a5cc6d0e-1299-4c34-910f-5556408dc039&filter[month_range]=2018-06-12+21%3A15%3A24+%2B0200..2018-08-12+21%3A15%3A24+%2B0200
Content-Type: application/vnd.api+json
GET /api/v2/reports/donation_monthly_totals
Parameters
filter: {"account_list_id"=>"a5cc6d0e-1299-4c34-910f-5556408dc039", "month_range"=>"2018-06-12 21:15:24 +0200..2018-08-12 21:15:24 +0200"}
| Name | Type | Description | Required |
|---|---|---|---|
| Filters | |||
filter[filter[account_list_id]] |
- |
Account List ID | true |
filter[filter[month_range]] |
- |
Month Range | true |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "",
"type": "reports_donation_monthly_totals",
"attributes": {
"created_at": "2018-10-12T19:15:24Z",
"donation_totals_by_month": [
{
"month": "2018-06-01",
"totals_by_currency": [
]
}
],
"updated_at": null,
"updated_in_db_at": null
}
}
}
Fields
| Name | Type | Description |
|---|
Donation Summary [LIST]
Lists donors who donated in the past 12 months, separated by into currency groups
Request
Endpoint
GET /api/v2/reports/donor_currency_donations?filter[account_list_id]=09021f6f-c780-4258-8f81-59b8c0d06f94
Content-Type: application/vnd.api+json
GET /api/v2/reports/donor_currency_donations
Parameters
filter: {"account_list_id"=>"09021f6f-c780-4258-8f81-59b8c0d06f94"}
| Name | Type | Description | Required |
|---|---|---|---|
| Filters | |||
filter[filter[account_list_id]] |
- |
Account List ID | true |
filter[filter[donor_account_id]] |
- |
List of Donor Account Ids | - |
filter[filter[designation_account_id]] |
- |
List of Designation Account Ids | - |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "",
"type": "reports_donor_currency_donations",
"attributes": {
"created_at": "2018-10-12T19:15:24Z",
"currency_groups": {
},
"donor_infos": [
],
"months": [
"2017-10-01",
"2017-11-01",
"2017-12-01",
"2018-01-01",
"2018-02-01",
"2018-03-01",
"2018-04-01",
"2018-05-01",
"2018-06-01",
"2018-07-01",
"2018-08-01",
"2018-09-01",
"2018-10-01"
],
"salary_currency": "USD",
"updated_at": null,
"updated_in_db_at": null
},
"relationships": {
"account_list": {
"data": {
"id": "09021f6f-c780-4258-8f81-59b8c0d06f94",
"type": "account_lists"
}
}
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
data |
Object |
Data object |
Donation Summary [LIST]
Lists donors who donated in the past 12 months, in the account list’s salary currency
Request
Endpoint
GET /api/v2/reports/salary_currency_donations?filter[account_list_id]=95778759-6afe-485b-9791-c446c0bbdfae
Content-Type: application/vnd.api+json
GET /api/v2/reports/salary_currency_donations
Parameters
filter: {"account_list_id"=>"95778759-6afe-485b-9791-c446c0bbdfae"}
| Name | Type | Description | Required |
|---|---|---|---|
| Filters | |||
filter[filter[account_list_id]] |
- |
Account List ID | true |
filter[filter[donor_account_id]] |
- |
List of Donor Account Ids | - |
filter[filter[designation_account_id]] |
- |
List of Designation Account Ids | - |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "",
"type": "reports_salary_currency_donations",
"attributes": {
"created_at": "2018-10-12T19:15:25Z",
"currency_groups": {
},
"donor_infos": [
],
"months": [
"2017-10-01",
"2017-11-01",
"2017-12-01",
"2018-01-01",
"2018-02-01",
"2018-03-01",
"2018-04-01",
"2018-05-01",
"2018-06-01",
"2018-07-01",
"2018-08-01",
"2018-09-01",
"2018-10-01"
],
"salary_currency": "USD",
"updated_at": null,
"updated_in_db_at": null
},
"relationships": {
"account_list": {
"data": {
"id": "95778759-6afe-485b-9791-c446c0bbdfae",
"type": "account_lists"
}
}
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
data |
Object |
Data object |
Donation Summary [LIST]
Lists donors who donated in the past 12 months, along with their donation totals (related to the given Account List)
Request
Endpoint
GET /api/v2/reports/year_donations?filter[account_list_id]=1519ce0a-7d62-4464-a8d8-24a854dc25d4
Content-Type: application/vnd.api+json
GET /api/v2/reports/year_donations
Parameters
filter: {"account_list_id"=>"1519ce0a-7d62-4464-a8d8-24a854dc25d4"}
| Name | Type | Description | Required |
|---|---|---|---|
| Filters | |||
filter[filter[account_list_id]] |
- |
Account List ID | true |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "",
"type": "reports_year_donations",
"attributes": {
"created_at": "2018-10-12T19:15:25Z",
"donation_infos": [
],
"donor_infos": [
],
"updated_at": null,
"updated_in_db_at": null
},
"relationships": {
"account_list": {
"data": {
"id": "1519ce0a-7d62-4464-a8d8-24a854dc25d4",
"type": "account_lists"
}
}
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
data |
Object |
Data object |
Goal Progress
Goal Progress [LIST]
Lists information related to the progress towards the current Account List monthly goal
Request
Endpoint
GET /api/v2/reports/goal_progress?filter[account_list_id]=a25c05a2-5f6d-4982-9097-529e71039c4c
Content-Type: application/vnd.api+json
GET /api/v2/reports/goal_progress
Parameters
filter: {"account_list_id"=>"a25c05a2-5f6d-4982-9097-529e71039c4c"}
| Name | Type | Description | Required |
|---|---|---|---|
| Filters | |||
filter[filter[account_list_id]] |
- |
Account List ID | true |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "",
"type": "reports_goal_progresses",
"attributes": {
"created_at": "2018-10-12T19:15:24Z",
"in_hand_percent": null,
"monthly_goal": null,
"pledged_percent": null,
"received_pledges": 0,
"salary_balance": 0,
"salary_currency_or_default": "USD",
"salary_organization_id": "ccf0f6f0-3264-4b03-a1db-4d49b69f8368",
"total_pledges": 0,
"updated_at": null,
"updated_in_db_at": null
},
"relationships": {
"account_list": {
"data": {
"id": "a25c05a2-5f6d-4982-9097-529e71039c4c",
"type": "account_lists"
}
}
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
data |
Object |
Data object |
Monthly Giving
Monthly Giving Graph [LIST]
Lists information related to the Monthly Giving Graph
Request
Endpoint
GET /api/v2/reports/monthly_giving_graph?filter[account_list_id]=66a8658f-ee12-488a-863b-fc1b0069382c
Content-Type: application/vnd.api+json
GET /api/v2/reports/monthly_giving_graph
Parameters
filter: {"account_list_id"=>"66a8658f-ee12-488a-863b-fc1b0069382c"}
| Name | Type | Description | Required |
|---|---|---|---|
| Filters | |||
filter[filter[account_list_id]] |
- |
Account List ID | true |
filter[filter[donor_account_id]] |
- |
List of Donor Account Ids | - |
filter[filter[designation_account_id]] |
- |
List of Designation Account Ids | - |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "",
"type": "reports_monthly_giving_graphs",
"attributes": {
"created_at": "2018-10-12T19:15:24Z",
"display_currency": "USD",
"monthly_average": 0,
"monthly_goal": null,
"months_to_dates": [
"2017-11-01",
"2017-12-01",
"2018-01-01",
"2018-02-01",
"2018-03-01",
"2018-04-01",
"2018-05-01",
"2018-06-01",
"2018-07-01",
"2018-08-01",
"2018-09-01",
"2018-10-01"
],
"multi_currency": false,
"pledges": 0,
"salary_currency": "USD",
"salary_currency_symbol": "$",
"totals": [
],
"updated_at": null,
"updated_in_db_at": null
},
"relationships": {
"account_list": {
"data": {
"id": "66a8658f-ee12-488a-863b-fc1b0069382c",
"type": "account_lists"
}
}
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
data |
Object |
Data object |
Monthly Totals
Expected Monthly Total [LIST]
Lists received and possible donations for the current month
Request
Endpoint
GET /api/v2/reports/expected_monthly_totals?filter[account_list_id]=3746ef0f-00bb-4b97-acaf-5c82a5473808
Content-Type: application/vnd.api+json
GET /api/v2/reports/expected_monthly_totals
Parameters
filter: {"account_list_id"=>"3746ef0f-00bb-4b97-acaf-5c82a5473808"}
| Name | Type | Description | Required |
|---|---|---|---|
| Filters | |||
filter[filter[account_list_id]] |
- |
Account List ID | true |
filter[filter[donor_account_id]] |
- |
List of Donor Account Ids | - |
filter[filter[designation_account_id]] |
- |
List of Designation Account Ids | - |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "",
"type": "reports_expected_monthly_totals",
"attributes": {
"created_at": "2018-10-12T19:15:24Z",
"expected_donations": [
],
"total_currency": "USD",
"total_currency_symbol": "$",
"updated_at": null,
"updated_in_db_at": null
},
"relationships": {
"account_list": {
"data": {
"id": "3746ef0f-00bb-4b97-acaf-5c82a5473808",
"type": "account_lists"
}
}
}
}
}
Fields
| Name | Type | Description |
|---|---|---|
data |
Object |
Data object |
Tasks Api
Analytics
Analytics [GET]
Viewing Analytical information for the User’s Tasks for all Account Lists
Request
Endpoint
GET /api/v2/tasks/analytics
Content-Type: application/vnd.api+json
GET /api/v2/tasks/analytics
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "",
"type": "task_analytics",
"attributes": {
"created_at": "2018-10-12T19:15:25Z",
"last_electronic_newsletter_completed_at": "2018-10-11T19:15:25Z",
"last_physical_newsletter_completed_at": "2018-10-11T19:15:25Z",
"tasks_overdue_or_due_today_counts": [
{
"label": "Call",
"count": 1
},
{
"label": "Appointment",
"count": 1
},
{
"label": "Email",
"count": 1
},
{
"label": "Text Message",
"count": 1
},
{
"label": "Facebook Message",
"count": 1
},
{
"label": "Letter",
"count": 1
},
{
"label": "Newsletter - Physical",
"count": 1
},
{
"label": "Newsletter - Email",
"count": 1
},
{
"label": "Pre Call Letter",
"count": 1
},
{
"label": "Reminder Letter",
"count": 1
},
{
"label": "Support Letter",
"count": 1
},
{
"label": "Thank",
"count": 1
},
{
"label": "To Do",
"count": 1
},
{
"label": "Talk to In Person",
"count": 1
},
{
"label": "Prayer Request",
"count": 1
},
{
"label": null,
"count": 0
}
],
"total_tasks_due_count": 15,
"updated_at": null,
"updated_in_db_at": null
}
}
}
Fields
| Name | Type | Description |
|---|
Analytics [GET]
Viewing Analytical information for a specific Account Lists’ Tasks
Request
Endpoint
GET /api/v2/tasks/analytics?filter[account_list_id]=9864761f-e3d7-43a7-95ab-04ba4e0c387d
Content-Type: application/vnd.api+json
GET /api/v2/tasks/analytics
Parameters
filter: {"account_list_id"=>"9864761f-e3d7-43a7-95ab-04ba4e0c387d"}
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "",
"type": "task_analytics",
"attributes": {
"created_at": "2018-10-12T19:15:26Z",
"last_electronic_newsletter_completed_at": "2018-10-10T19:15:26Z",
"last_physical_newsletter_completed_at": null,
"tasks_overdue_or_due_today_counts": [
{
"label": "Call",
"count": 0
},
{
"label": "Appointment",
"count": 0
},
{
"label": "Email",
"count": 0
},
{
"label": "Text Message",
"count": 0
},
{
"label": "Facebook Message",
"count": 0
},
{
"label": "Letter",
"count": 0
},
{
"label": "Newsletter - Physical",
"count": 0
},
{
"label": "Newsletter - Email",
"count": 0
},
{
"label": "Pre Call Letter",
"count": 0
},
{
"label": "Reminder Letter",
"count": 0
},
{
"label": "Support Letter",
"count": 0
},
{
"label": "Thank",
"count": 0
},
{
"label": "To Do",
"count": 0
},
{
"label": "Talk to In Person",
"count": 0
},
{
"label": "Prayer Request",
"count": 0
},
{
"label": null,
"count": 0
}
],
"total_tasks_due_count": 0,
"updated_at": null,
"updated_in_db_at": null
}
}
}
Fields
| Name | Type | Description |
|---|
Comments
Comment [CREATE]
Create a Comment associated with the Task
Request
Endpoint
POST /api/v2/tasks/e91f86fb-3e89-44f5-9c6c-c08fa4b4e434/comments
Content-Type: application/vnd.api+json
POST /api/v2/tasks/:task_id/comments
Parameters
{
"data": {
"relationships": {
"person": "Schinner Cloyd",
"person": {
"data": {
"type": "people",
"id": "021b28a1-5616-4d52-b80b-a51e3b30310b"
}
}
},
"type": "comments",
"attributes": {
"body": "MyText",
"updated_in_db_at": "2018-10-12 21:15:26 +0200"
}
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
{
"data": {
"id": "d3db475d-e0d3-48d3-867d-16b3cc22388c",
"type": "comments",
"attributes": {
"body": "MyText",
"created_at": "2018-10-12T19:15:26Z",
"updated_at": "2018-10-12T19:15:26Z",
"updated_in_db_at": "2018-10-12T19:15:26Z"
},
"relationships": {
"person": {
"data": {
"id": "021b28a1-5616-4d52-b80b-a51e3b30310b",
"type": "people"
}
}
}
}
}
Comment [DELETE]
Delete the Task’s Comment with the given ID
Request
Endpoint
DELETE /api/v2/tasks/dfca56e5-496d-4063-a056-67bbf99363b0/comments/3a54c7a2-cbe4-45b5-b6b7-7a28915b7978
Content-Type: application/vnd.api+json
DELETE /api/v2/tasks/:task_id/comments/:id
Parameters
None known.
Response
204 No Content
Comment [GET]
The Task’s Comment with the given ID
Request
Endpoint
GET /api/v2/tasks/28ee1337-7b50-4c8e-8961-aa4829277915/comments/80157aff-051e-48e9-971b-06088ffc35b2
Content-Type: application/vnd.api+json
GET /api/v2/tasks/:task_id/comments/:id
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "80157aff-051e-48e9-971b-06088ffc35b2",
"type": "comments",
"attributes": {
"body": "MyText",
"created_at": "2018-10-12T19:15:26Z",
"updated_at": "2018-10-12T19:15:26Z",
"updated_in_db_at": "2018-10-12T19:15:26Z"
},
"relationships": {
"person": {
"data": null
}
}
}
}
Fields
| Name | Type | Description |
|---|
Comment [LIST]
List of Comments associated to the Task
Request
Endpoint
GET /api/v2/tasks/6c93abbe-b0fa-47df-b54c-638f61d16ca8/comments
Content-Type: application/vnd.api+json
GET /api/v2/tasks/:task_id/comments
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": [
{
"id": "7a978923-7974-4d8c-9b06-194f2b9a0e24",
"type": "comments",
"attributes": {
"body": "MyText",
"created_at": "2018-10-12T19:15:26Z",
"updated_at": "2018-10-12T19:15:26Z",
"updated_in_db_at": "2018-10-12T19:15:26Z"
},
"relationships": {
"person": {
"data": null
}
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 1,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}
Comment [UPDATE]
Update the Task’s Comment with the given ID
Request
Endpoint
PUT /api/v2/tasks/5420d772-46cf-41dd-8a99-e92f8cd9d81a/comments/d2add826-8e63-451a-8c71-62a5af45da14
Content-Type: application/vnd.api+json
PUT /api/v2/tasks/:task_id/comments/:id
Parameters
{
"data": {
"relationships": {
"person": "Effertz Niko",
"person": {
"data": {
"type": "people",
"id": "7c019514-23b4-41ab-8400-0b975155fc8f"
}
}
},
"type": "comments",
"attributes": {
"body": "MyText",
"updated_in_db_at": "2018-10-12 21:15:27 +0200"
}
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "d2add826-8e63-451a-8c71-62a5af45da14",
"type": "comments",
"attributes": {
"body": "MyText",
"created_at": "2018-10-12T19:15:27Z",
"updated_at": "2018-10-12T19:15:27Z",
"updated_in_db_at": "2018-10-12T19:15:27Z"
},
"relationships": {
"person": {
"data": {
"id": "7c019514-23b4-41ab-8400-0b975155fc8f",
"type": "people"
}
}
}
}
}
Filter
Tags
Tag [CREATE]
Create a Tag associated with the Task
Request
Endpoint
POST /api/v2/tasks/64a273f9-2234-4a8d-b4c6-610129c5ca88/tags
Content-Type: application/vnd.api+json
POST /api/v2/tasks/:task_id/tags
Parameters
{
"data": {
"type": "tags",
"attributes": {
"name": "new_tag"
}
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
{
"data": {
"id": "64a273f9-2234-4a8d-b4c6-610129c5ca88",
"type": "tasks",
"attributes": {
"activity_type": "Call",
"comments_count": 0,
"completed": false,
"completed_at": null,
"created_at": "2018-10-12T19:15:28Z",
"location": "MyString",
"next_action": null,
"notification_time_before": null,
"notification_time_unit": null,
"notification_type": null,
"result": null,
"starred": false,
"start_at": "2012-03-08T12:59:46Z",
"subject": "Call Ms. Julian Feest",
"subject_hidden": false,
"tag_list": [
"new_tag"
],
"updated_at": "2018-10-12T19:15:28Z",
"updated_in_db_at": "2018-10-12T19:15:28Z"
},
"relationships": {
"comments": {
"data": [
]
},
"contacts": {
"data": [
]
},
"people": {
"data": [
]
},
"email_addresses": {
"data": [
]
},
"phone_numbers": {
"data": [
]
},
"activity_contacts": {
"data": [
]
},
"account_list": {
"data": {
"id": "6838d2d2-60f3-41c4-bc30-16a4c6ff4573",
"type": "account_lists"
}
}
}
}
}
Tag [DELETE]
Delete the Task’s Tag with the given name
Request
Endpoint
DELETE /api/v2/tasks/2e9a4b1e-bd94-4328-b8f7-4dc1938cff3e/tags/new_tag
Content-Type: application/vnd.api+json
DELETE /api/v2/tasks/:task_id/tags/:tag_name
Parameters
| Name | Type | Description | Required |
|---|
Response
204 No Content
Tag [LIST]
List Task Tags
Request
Endpoint
GET /api/v2/tasks/tags
Content-Type: application/vnd.api+json
GET /api/v2/tasks/tags
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": [
{
"id": "f702c67f-c143-4cf3-859e-d6d0bd4db741",
"type": "tags",
"attributes": {
"name": "new_tag"
}
}
]
}
Tags [BULK DELETE]
Tags [BULK DELETE]
Request
Endpoint
DELETE /api/v2/tasks/tags/bulk
Content-Type: application/vnd.api+json
DELETE /api/v2/tasks/tags/bulk
Parameters
{
"data": [
{
"data": {
"type": "tags",
"attributes": {
"name": "tag_one"
}
}
},
{
"data": {
"type": "tags",
"attributes": {
"name": "tag_two"
}
}
}
],
"filter": {
"task_ids": "b320c7a3-da6f-4f19-81ec-89bf224f4d52, 26896f8d-e801-4455-a5e8-2009e4117b32"
}
}
| Name | Type | Description | Required |
|---|---|---|---|
| Filters | |||
filter[account_list_id] |
ID string |
The ID of an Account List to scope the tasks to |
- |
filter[task_ids] |
string (comma delimited IDs) |
A comma delimited list of Task IDs to remove the Tag from. If ommited the Tag will be removed from all Tasks. | - |
| Attributes | |||
name |
string |
The name of the Tag to be deleted | true |
Response
204 No Content
Tags [BULK POST]
Tags [BULK POST]
Request
Endpoint
POST /api/v2/tasks/tags/bulk
Content-Type: application/vnd.api+json
POST /api/v2/tasks/tags/bulk
Parameters
{
"data": [
{
"data": {
"type": "tags",
"attributes": {
"name": "tag_one"
}
}
},
{
"data": {
"type": "tags",
"attributes": {
"name": "tag_two"
}
}
}
],
"filter": {
"task_ids": "5cd93535-e9d8-4903-9b4b-5d07d71dbd8c, 4cc8efac-5f36-4a11-93ae-a0fde9a8fcc3"
}
}
| Name | Type | Description | Required |
|---|---|---|---|
| Filters | |||
filter[account_list_id] |
ID string |
The ID of an Account List to scope the tasks to |
- |
filter[task_ids] |
string (comma delimited IDs) |
A comma delimited list of Task IDs to add the Tag to. If ommited the Tag will be added to all Tasks. | - |
| Attributes | |||
name |
string |
The name of the Tag to be added | true |
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
[
{
"data": {
"id": "4cc8efac-5f36-4a11-93ae-a0fde9a8fcc3",
"type": "tasks",
"attributes": {
"activity_type": "Call",
"comments_count": 0,
"completed": false,
"completed_at": null,
"created_at": "2018-10-12T19:15:27Z",
"location": "MyString",
"next_action": null,
"notification_time_before": null,
"notification_time_unit": null,
"notification_type": null,
"result": null,
"starred": false,
"start_at": "2012-03-08T12:59:46Z",
"subject": "Call Maymie Cassin",
"subject_hidden": false,
"tag_list": [
"tag_two",
"tag_three",
"tag_one"
],
"updated_at": "2018-10-12T19:15:27Z",
"updated_in_db_at": "2018-10-12T19:15:27Z"
},
"relationships": {
"comments": {
"data": [
]
},
"contacts": {
"data": [
]
},
"people": {
"data": [
]
},
"email_addresses": {
"data": [
]
},
"phone_numbers": {
"data": [
]
},
"activity_contacts": {
"data": [
]
},
"account_list": {
"data": {
"id": "15f35a3b-8ee5-4d0e-8ef1-5cc50134dda0",
"type": "account_lists"
}
}
}
}
},
{
"data": {
"id": "5cd93535-e9d8-4903-9b4b-5d07d71dbd8c",
"type": "tasks",
"attributes": {
"activity_type": "Call",
"comments_count": 0,
"completed": false,
"completed_at": null,
"created_at": "2018-10-12T19:15:27Z",
"location": "MyString",
"next_action": null,
"notification_time_before": null,
"notification_time_unit": null,
"notification_type": null,
"result": null,
"starred": false,
"start_at": "2012-03-08T12:59:46Z",
"subject": "Call Sofia Ryan",
"subject_hidden": false,
"tag_list": [
"tag_two",
"tag_one"
],
"updated_at": "2018-10-12T19:15:27Z",
"updated_in_db_at": "2018-10-12T19:15:27Z"
},
"relationships": {
"comments": {
"data": [
]
},
"contacts": {
"data": [
]
},
"people": {
"data": [
]
},
"email_addresses": {
"data": [
]
},
"phone_numbers": {
"data": [
]
},
"activity_contacts": {
"data": [
]
},
"account_list": {
"data": {
"id": "15f35a3b-8ee5-4d0e-8ef1-5cc50134dda0",
"type": "account_lists"
}
}
}
}
}
]
Fields
| Name | Type | Description |
|---|---|---|
| Attributes | ||
created_at |
ISO8601 timestamp |
The timestamp of when this resource was created |
updated_at |
ISO8601 timestamp |
The timestamp of when this resource was last updated |
updated_in_db_at |
ISO8601 timestamp |
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. |
User Api
Authenticate
Authenticate [CREATE]
Create a JSON Web Token from a provided valid CAS Ticket
Request
Endpoint
POST /api/v2/user/authenticate
Content-Type: application/vnd.api+json
POST /api/v2/user/authenticate
Parameters
{
"data": {
"type": "authenticate",
"attributes": {
"cas_ticket": "ST-314971-9fjrd0HfOINCehJ5TKXX-cas2a"
}
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "",
"type": "authenticate",
"attributes": {
"created_at": "2018-10-12T19:15:29Z",
"json_web_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiNjA0OTRiNDItMTAzMy00NmIzLWIyN2ItMTczNWQzOTU2NDkyIiwiZXhwIjoxNTQxOTYzNzI5fQ.qyfj7lqEHod1Slxlj3BgD--LXg4Scsgg8zk-5aOYAZM",
"updated_at": null,
"updated_in_db_at": null
}
}
}
Fields
| Name | Type | Description |
|---|
Google Accounts
Google Account [CREATE]
Create a Google Account associated with the current_user
Request
Endpoint
POST /api/v2/user/google_accounts
Content-Type: application/vnd.api+json
POST /api/v2/user/google_accounts
Parameters
{
"data": {
"type": "google_accounts",
"attributes": {
"email": "foo17@example.com",
"expires_at": "2018-10-12 22:15:31 +0200",
"refresh_token": "MyString",
"remote_id": "MyString",
"token": "MyString",
"updated_in_db_at": "2018-10-12 21:15:31 +0200",
"valid_token": true
},
"relationships": {
"person": {
"data": {
"type": "people",
"id": "b107ea1f-a034-4e82-9fe3-3360f044346c"
}
}
}
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
{
"data": {
"id": "1708b073-e742-4486-9fab-212b9cd12efb",
"type": "google_accounts",
"attributes": {
"created_at": "2018-10-12T19:15:31Z",
"email": "foo17@example.com",
"expires_at": null,
"last_download": null,
"last_email_sync": null,
"primary": false,
"remote_id": "MyString",
"token_expired": true,
"updated_at": "2018-10-12T19:15:31Z",
"updated_in_db_at": "2018-10-12T19:15:31Z"
},
"relationships": {
"contact_groups": {
"data": [
]
}
}
}
}
Google Account [DELETE]
Delete the current_user’s Google Account with the given ID
Request
Endpoint
DELETE /api/v2/user/google_accounts/d9b87fa0-45a6-4ee0-9133-a91c4ff51271
Content-Type: application/vnd.api+json
DELETE /api/v2/user/google_accounts/:id
Parameters
None known.
Response
204 No Content
Google Account [GET]
The current_user’s Google Account with the given ID
Request
Endpoint
GET /api/v2/user/google_accounts/5db4d4b2-2140-4e7e-9782-5ce339125b00
Content-Type: application/vnd.api+json
GET /api/v2/user/google_accounts/:id
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "5db4d4b2-2140-4e7e-9782-5ce339125b00",
"type": "google_accounts",
"attributes": {
"created_at": "2018-10-12T19:15:31Z",
"email": "foo15@example.com",
"expires_at": "2018-10-12T20:15:31Z",
"last_download": null,
"last_email_sync": null,
"primary": false,
"remote_id": "MyString",
"token_expired": false,
"updated_at": "2018-10-12T19:15:31Z",
"updated_in_db_at": "2018-10-12T19:15:31Z"
},
"relationships": {
"contact_groups": {
"data": [
]
}
}
}
}
Fields
| Name | Type | Description |
|---|
Google Account [LIST]
List of Google Accounts associated to current_user
Request
Endpoint
GET /api/v2/user/google_accounts
Content-Type: application/vnd.api+json
GET /api/v2/user/google_accounts
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": [
{
"id": "3bf20712-b368-4542-b2b7-47ed1dbbdaf6",
"type": "google_accounts",
"attributes": {
"created_at": "2018-10-12T19:15:31Z",
"email": "foo14@example.com",
"expires_at": "2018-10-12T20:15:31Z",
"last_download": null,
"last_email_sync": null,
"primary": false,
"remote_id": "MyString",
"token_expired": false,
"updated_at": "2018-10-12T19:15:31Z",
"updated_in_db_at": "2018-10-12T19:15:31Z"
},
"relationships": {
"contact_groups": {
"data": [
]
}
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 1,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}
Google Account [UPDATE]
Update the current_user’s Google Account with the given ID
Request
Endpoint
PUT /api/v2/user/google_accounts/4a6e4a92-c287-4c33-ba8d-136531203209
Content-Type: application/vnd.api+json
PUT /api/v2/user/google_accounts/:id
Parameters
{
"data": {
"type": "google_accounts",
"attributes": {
"email": "foo19@example.com",
"expires_at": "2018-10-12 22:15:31 +0200",
"refresh_token": "MyString",
"remote_id": "MyString",
"token": "MyString",
"updated_in_db_at": "2018-10-12 21:15:31 +0200",
"valid_token": true
},
"relationships": {
"person": {
"data": {
"type": "people",
"id": "133339fc-0800-42d1-8a4f-8fad191a0a8b"
}
}
}
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "4a6e4a92-c287-4c33-ba8d-136531203209",
"type": "google_accounts",
"attributes": {
"created_at": "2018-10-12T19:15:31Z",
"email": "foo19@example.com",
"expires_at": "2018-10-12T20:15:31Z",
"last_download": null,
"last_email_sync": null,
"primary": false,
"remote_id": "MyString",
"token_expired": false,
"updated_at": "2018-10-12T19:15:31Z",
"updated_in_db_at": "2018-10-12T19:15:31Z"
},
"relationships": {
"contact_groups": {
"data": [
]
}
}
}
}
Key Accounts
Key Account [CREATE]
Create a Key Account associated with the current_user
Request
Endpoint
POST /api/v2/user/key_accounts
Content-Type: application/vnd.api+json
POST /api/v2/user/key_accounts
Parameters
{
"data": {
"type": "key_accounts",
"attributes": {
"email": "justus@erdman.io",
"first_name": "Amelie",
"last_name": "Shanahan",
"remote_id": 227,
"updated_in_db_at": "2018-10-12 21:15:31 +0200"
},
"relationships": {
"person": {
"data": {
"type": "persons",
"id": "a99e1618-112d-4968-94eb-3d50a4245786"
}
}
}
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
{
"data": {
"id": "a921c78a-4449-456b-a05a-1b9f458d2259",
"type": "key_accounts",
"attributes": {
"created_at": "2018-10-12T19:15:31Z",
"email": "justus@erdman.io",
"first_name": "Amelie",
"last_download": null,
"last_name": "Shanahan",
"primary": false,
"remote_id": "227",
"updated_at": "2018-10-12T19:15:31Z",
"updated_in_db_at": "2018-10-12T19:15:31Z"
}
}
}
Key Account [DELETE]
Delete the current_user’s Key Account with the given ID
Request
Endpoint
DELETE /api/v2/user/key_accounts/5a8fd42d-87ef-40a4-bb28-e67c2b904efd
Content-Type: application/vnd.api+json
DELETE /api/v2/user/key_accounts/:id
Parameters
None known.
Response
204 No Content
Key Account [GET]
The current_user’s Key Account with the given ID
Request
Endpoint
GET /api/v2/user/key_accounts/0cc0aa94-b44a-428a-83da-2e24e3332cc8
Content-Type: application/vnd.api+json
GET /api/v2/user/key_accounts/:id
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "0cc0aa94-b44a-428a-83da-2e24e3332cc8",
"type": "key_accounts",
"attributes": {
"created_at": "2018-10-12T19:15:31Z",
"email": "sylvester_vandervort@feilmoriette.biz",
"first_name": "Sid",
"last_download": null,
"last_name": "Gutmann",
"primary": false,
"remote_id": "224",
"updated_at": "2018-10-12T19:15:31Z",
"updated_in_db_at": "2018-10-12T19:15:31Z"
}
}
}
Fields
| Name | Type | Description |
|---|
Key Account [LIST]
List of Key Accounts associated to current_user
Request
Endpoint
GET /api/v2/user/key_accounts
Content-Type: application/vnd.api+json
GET /api/v2/user/key_accounts
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": [
{
"id": "f2e314d4-2cb8-406c-84a8-17347e995d83",
"type": "key_accounts",
"attributes": {
"created_at": "2018-10-12T19:15:31Z",
"email": "rosalia_gislason@mcdermott.net",
"first_name": "Isabell",
"last_download": null,
"last_name": "Roob",
"primary": false,
"remote_id": "221",
"updated_at": "2018-10-12T19:15:31Z",
"updated_in_db_at": "2018-10-12T19:15:31Z"
}
},
{
"id": "c8a22d7e-b105-45bf-883b-a1f6be439cda",
"type": "key_accounts",
"attributes": {
"created_at": "2018-10-12T19:15:31Z",
"email": "malika@bogisich.io",
"first_name": "Taurean",
"last_download": null,
"last_name": "Murray",
"primary": false,
"remote_id": "222",
"updated_at": "2018-10-12T19:15:31Z",
"updated_in_db_at": "2018-10-12T19:15:31Z"
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 2,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}
Key Account [UPDATE]
Update the current_user’s Key Account with the given ID
Request
Endpoint
PUT /api/v2/user/key_accounts/0452549c-14a1-428b-8dfd-88290a302dd6
Content-Type: application/vnd.api+json
PUT /api/v2/user/key_accounts/:id
Parameters
{
"data": {
"type": "key_accounts",
"attributes": {
"email": "amelie@shanahanheidenreich.org",
"first_name": "Hope",
"last_name": "Kunze",
"remote_id": 230,
"updated_in_db_at": "2018-10-12 21:15:31 +0200"
},
"relationships": {
"person": {
"data": {
"type": "persons",
"id": "3d22fb66-0a6a-42ff-917b-afd23c44ed3a"
}
}
}
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "0452549c-14a1-428b-8dfd-88290a302dd6",
"type": "key_accounts",
"attributes": {
"created_at": "2018-10-12T19:15:31Z",
"email": "amelie@shanahanheidenreich.org",
"first_name": "Hope",
"last_download": null,
"last_name": "Kunze",
"primary": false,
"remote_id": "230",
"updated_at": "2018-10-12T19:15:31Z",
"updated_in_db_at": "2018-10-12T19:15:31Z"
}
}
}
Options
Option [CREATE]
Create Option
Request
Endpoint
POST /api/v2/user/options
Content-Type: application/vnd.api+json
POST /api/v2/user/options
Parameters
{
"data": {
"attributes": {
"key": "key_3",
"key": "key_4",
"updated_in_db_at": "2018-10-12 21:15:32 +0200",
"value": "meggings"
},
"type": "user_options"
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
{
"data": {
"id": "a59476b4-dfce-4215-846d-8c2be08976c0",
"type": "user_options",
"attributes": {
"created_at": "2018-10-12T19:15:32Z",
"key": "key_4",
"updated_at": "2018-10-12T19:15:32Z",
"updated_in_db_at": "2018-10-12T19:15:32Z",
"value": "meggings"
}
}
}
Option [DELETE]
Delete Option
Request
Endpoint
DELETE /api/v2/user/options/key_7
Content-Type: application/vnd.api+json
DELETE /api/v2/user/options/:key
Parameters
None known.
Response
204 No Content
Option [GET]
The Option for the given key
Request
Endpoint
GET /api/v2/user/options/key_2
Content-Type: application/vnd.api+json
GET /api/v2/user/options/:key
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "b16d15ed-e18d-4bd0-97cd-935fd51c2941",
"type": "user_options",
"attributes": {
"created_at": "2018-10-12T19:15:32Z",
"key": "key_2",
"updated_at": "2018-10-12T19:15:32Z",
"updated_in_db_at": "2018-10-12T19:15:32Z",
"value": "sriracha"
}
}
}
Fields
| Name | Type | Description |
|---|
Option [LIST]
List of Options
Request
Endpoint
GET /api/v2/user/options
Content-Type: application/vnd.api+json
GET /api/v2/user/options
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": [
{
"id": "bec0c151-39fb-413f-858a-7128461f818f",
"type": "user_options",
"attributes": {
"created_at": "2018-10-12T19:15:32Z",
"key": "key_1",
"updated_at": "2018-10-12T19:15:32Z",
"updated_in_db_at": "2018-10-12T19:15:32Z",
"value": "sustainable"
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 1,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}
Option [UPDATE]
Update Option
Request
Endpoint
PUT /api/v2/user/options/key_5
Content-Type: application/vnd.api+json
PUT /api/v2/user/options/:key
Parameters
{
"data": {
"type": "user_options",
"attributes": {
"key": "key_6",
"updated_in_db_at": "2018-10-12 21:15:32 +0200",
"value": "microdosing"
}
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "215140ea-86e5-41e2-a01c-2f7bb5c982be",
"type": "user_options",
"attributes": {
"created_at": "2018-10-12T19:15:32Z",
"key": "key_6",
"updated_at": "2018-10-12T19:15:32Z",
"updated_in_db_at": "2018-10-12T19:15:32Z",
"value": "microdosing"
}
}
}
Organization Accounts
Organization Account [CREATE]
Create an Organization Account associated with the current_user
Request
Endpoint
POST /api/v2/user/organization_accounts
Content-Type: application/vnd.api+json
POST /api/v2/user/organization_accounts
Parameters
{
"data": {
"type": "organization_accounts",
"attributes": {
"authenticated": true,
"password": "bar",
"remote_id": 1,
"updated_in_db_at": "2018-10-12 21:15:32 +0200",
"username": "foo",
"valid_credentials": true
},
"relationships": {
"person": {
"data": {
"type": "people",
"id": "968bb118-a4fd-42f9-9926-19e2df9128f2"
}
},
"organization": {
"data": {
"type": "organizations",
"id": "968ca7a1-1eb3-4c4f-82d6-ce84dab8588c"
}
}
}
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
{
"data": {
"id": "d4a6cfc4-6131-4653-9834-4ff2e6b67d8b",
"type": "organization_accounts",
"attributes": {
"created_at": "2018-10-12T19:15:32Z",
"disable_downloads": false,
"last_download": null,
"locked_at": null,
"remote_id": null,
"updated_at": "2018-10-12T19:15:32Z",
"updated_in_db_at": "2018-10-12T19:15:32Z",
"username": "foo"
},
"relationships": {
"organization": {
"data": {
"id": "968ca7a1-1eb3-4c4f-82d6-ce84dab8588c",
"type": "organizations"
}
},
"person": {
"data": {
"id": "968bb118-a4fd-42f9-9926-19e2df9128f2",
"type": "people"
}
}
}
}
}
Organization Account [DELETE]
Delete the current_user’s Organization Account with the given ID
Request
Endpoint
DELETE /api/v2/user/organization_accounts/050146d0-b08d-468a-aa0a-16325f8e0e86
Content-Type: application/vnd.api+json
DELETE /api/v2/user/organization_accounts/:id
Parameters
None known.
Response
204 No Content
Organization Account [GET]
The User’s Organization Account with the given ID
Request
Endpoint
GET /api/v2/user/organization_accounts/0ebef81a-b2fc-40e4-9719-60a2be334745
Content-Type: application/vnd.api+json
GET /api/v2/user/organization_accounts/:id
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "0ebef81a-b2fc-40e4-9719-60a2be334745",
"type": "organization_accounts",
"attributes": {
"created_at": "2018-10-12T19:15:32Z",
"disable_downloads": false,
"last_download": null,
"locked_at": null,
"remote_id": "1",
"updated_at": "2018-10-12T19:15:32Z",
"updated_in_db_at": "2018-10-12T19:15:32Z",
"username": "foo"
},
"relationships": {
"organization": {
"data": {
"id": "2fae4c5c-aaae-4701-87f2-a81fa3fcffbb",
"type": "organizations"
}
},
"person": {
"data": {
"id": "81026c03-6a51-4803-87b4-dc04a3b51e33",
"type": "people"
}
}
}
}
}
Fields
| Name | Type | Description |
|---|
Organization Account [LIST]
List of Organization Accounts associated to current_user
Request
Endpoint
GET /api/v2/user/organization_accounts
Content-Type: application/vnd.api+json
GET /api/v2/user/organization_accounts
Parameters
None known.
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": [
{
"id": "15a49958-fd78-4589-8381-21671b184c76",
"type": "organization_accounts",
"attributes": {
"created_at": "2018-10-12T19:15:32Z",
"disable_downloads": false,
"last_download": null,
"locked_at": null,
"remote_id": "1",
"updated_at": "2018-10-12T19:15:32Z",
"updated_in_db_at": "2018-10-12T19:15:32Z",
"username": "foo"
},
"relationships": {
"organization": {
"data": {
"id": "8017345c-d1bd-40fd-af33-3db035c4556c",
"type": "organizations"
}
},
"person": {
"data": {
"id": "80bc71d0-8ae9-4aab-adfc-120ec8ab0df2",
"type": "people"
}
}
}
},
{
"id": "8045b54e-3e2f-47ba-904a-1327fb3ce3e4",
"type": "organization_accounts",
"attributes": {
"created_at": "2018-10-12T19:15:32Z",
"disable_downloads": false,
"last_download": null,
"locked_at": null,
"remote_id": "1",
"updated_at": "2018-10-12T19:15:32Z",
"updated_in_db_at": "2018-10-12T19:15:32Z",
"username": "foo"
},
"relationships": {
"organization": {
"data": {
"id": "54c0e34a-6334-4f16-a7a4-ae11724213c2",
"type": "organizations"
}
},
"person": {
"data": {
"id": "80bc71d0-8ae9-4aab-adfc-120ec8ab0df2",
"type": "people"
}
}
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 2,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}
Organization Account [UPDATE]
Update the current_user’s Organization Account with the given ID
Request
Endpoint
PUT /api/v2/user/organization_accounts/ae2aa746-b5ff-4708-a081-40f61dcf37af
Content-Type: application/vnd.api+json
PUT /api/v2/user/organization_accounts/:id
Parameters
{
"data": {
"type": "organization_accounts",
"attributes": {
"authenticated": true,
"password": "bar",
"remote_id": 1,
"updated_in_db_at": "2018-10-12 21:15:33 +0200",
"username": "foo",
"valid_credentials": true
},
"relationships": {
"person": {
"data": {
"type": "people",
"id": "c3520ed1-ee2d-4a3d-b5b6-306b0f0e82d4"
}
},
"organization": {
"data": {
"type": "organizations",
"id": "ad101c70-24d3-4d77-9d1c-edad802525e6"
}
}
}
}
}
| Name | Type | Description | Required |
|---|
Response
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
{
"data": {
"id": "ae2aa746-b5ff-4708-a081-40f61dcf37af",
"type": "organization_accounts",
"attributes": {
"created_at": "2018-10-12T19:15:33Z",
"disable_downloads": false,
"last_download": null,
"locked_at": null,
"remote_id": "1",
"updated_at": "2018-10-12T19:15:33Z",
"updated_in_db_at": "2018-10-12T19:15:33Z",
"username": "foo"
},
"relationships": {
"organization": {
"data": {
"id": "ad101c70-24d3-4d77-9d1c-edad802525e6",
"type": "organizations"
}
},
"person": {
"data": {
"id": "c3520ed1-ee2d-4a3d-b5b6-306b0f0e82d4",
"type": "people"
}
}
}
}
}