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 null instead 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.

8 October 2018

• BREAKING CHANGE account_lists/notifications [POST] removed
• BREAKING CHANGE account_lists/notifications [DELETE] removed
• BREAKING CHANGE account_lists/notifications [PUT] updatable fields changed to only allow cleared
• account_lists/notifications/cleared [PUT] added to bulk update all notifications to cleared = true

4 October 2018

• Added user/devices endpoint

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

18 September 2018

• Add legacy_account_number attribute to donor_account
• Add legacy_designation_number attribute to designation_account
• Add legacy_remote_id attribute to donation

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 requests key that has an array of request objects. A request object needs to have a method key and a path key. It may also have a body key.
  • The response will be a JSON array of response objects. A response object has a status key, a headers key, and a body key. The body is a string of the server response.
  • In addition to the requests key in the payload, you may also specify a on_error key which may be set to CONTINUE, or ABORT. CONTINUE is 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. ABORT will 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.

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_frequencies to Constants.

7 April 2017

• Added a way to overwrite data on PATCH requests without providing an updated_in_db_at value.

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-Override header 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 List information, unless they are part of the Cru-USA organization
• 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 related account_list for 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 _id now 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 website attribute to Contact objects
• Adjust Bulk Delete Tags endpoints (api/v2/contacts/tags/bulk and api/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 id to 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_at as a filterable attribute on the LIST endpoint for all database backed Resources
• Added sorting by donation_date to Account Lists > Donations > LIST
• Added filtering by donation_date with 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
• 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

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/f63a97cd-a9c7-4412-b385-5faaa26ef37e
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": "f63a97cd-a9c7-4412-b385-5faaa26ef37e",
    "type": "account_lists",
    "attributes": {
      "active_mpd_finish_at": null,
      "active_mpd_monthly_goal": null,
      "active_mpd_start_at": null,
      "created_at": "2018-10-12T19:04:38Z",
      "currency": "USD",
      "default_currency": "USD",
      "home_country": "United States",
      "monthly_goal": 5354,
      "name": "Hirthe Group",
      "salary_organization": null,
      "tester": false,
      "total_pledges": 0,
      "updated_at": "2018-10-12T19:04:38Z",
      "updated_in_db_at": "2018-10-12T19:04:38Z"
    },
    "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": "68072bdd-4354-40e3-924a-b35f52236bdd",
      "type": "account_lists",
      "attributes": {
        "active_mpd_finish_at": null,
        "active_mpd_monthly_goal": null,
        "active_mpd_start_at": null,
        "created_at": "2018-10-12T19:04:38Z",
        "currency": "USD",
        "default_currency": "USD",
        "home_country": "United States",
        "monthly_goal": 5369,
        "name": "Roob and Sons",
        "salary_organization": null,
        "tester": false,
        "total_pledges": 0,
        "updated_at": "2018-10-12T19:04:38Z",
        "updated_in_db_at": "2018-10-12T19:04:38Z"
      },
      "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/6483c92c-a8b1-4cb5-b2a7-2ae3f02cf44b
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": 8839,
      "name": "Casper, Johnson and Mayert",
      "tester": false,
      "updated_in_db_at": "2018-10-13 03:04:38 +0800"
    }
  }
}

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": "6483c92c-a8b1-4cb5-b2a7-2ae3f02cf44b",
    "type": "account_lists",
    "attributes": {
      "active_mpd_finish_at": null,
      "active_mpd_monthly_goal": null,
      "active_mpd_start_at": null,
      "created_at": "2018-10-12T19:04:38Z",
      "currency": "USD",
      "default_currency": "USD",
      "home_country": "United States",
      "monthly_goal": 8839,
      "name": "Casper, Johnson and Mayert",
      "salary_organization": null,
      "tester": false,
      "total_pledges": 0,
      "updated_at": "2018-10-12T19:04:38Z",
      "updated_in_db_at": "2018-10-12T19:04:38Z"
    },
    "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/76318f3c-3e07-4ae0-9252-f212db3790cd
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/1bb454bb-beec-4bc8-ab17-e7bf54583935
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": "1bb454bb-beec-4bc8-ab17-e7bf54583935",
    "type": "appeals",
    "attributes": {
      "amount": "1000.0",
      "created_at": "2018-10-12T19:04:40Z",
      "currencies": [
        "ZAR"
      ],
      "description": "The description for my new Appeal",
      "end_date": "2018-10-20",
      "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:04:40Z",
      "updated_in_db_at": "2018-10-12T19:04:40Z"
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "071a9fdc-48f6-4c4d-94d9-4fcbef3722a2",
          "type": "account_lists"
        }
      },
      "contacts": {
        "data": [

        ]
      },
      "donations": {
        "data": [
          {
            "id": "38fafcf2-d217-4656-9097-52a4c1f77002",
            "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": "11042c4e-777c-43f3-8cea-f0a41663c0a6",
      "type": "appeals",
      "attributes": {
        "amount": "1000.0",
        "created_at": "2018-10-12T19:04:40Z",
        "currencies": [
          "ZAR"
        ],
        "description": "The description for my new Appeal",
        "end_date": "2018-10-20",
        "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:04:40Z",
        "updated_in_db_at": "2018-10-12T19:04:40Z"
      },
      "relationships": {
        "account_list": {
          "data": {
            "id": "3fce4a86-b88d-409a-9053-2ea9460de322",
            "type": "account_lists"
          }
        },
        "contacts": {
          "data": [

          ]
        },
        "donations": {
          "data": [
            {
              "id": "9312c79d-cb78-4d89-83cd-49f2c72cb369",
              "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-20",
      "exclusion_filter": {
        "status": "Partner - Financial"
      },
      "inclusion_filter": {
        "status": "Partner - Financial,Partner - Pray"
      },
      "name": "Appeal #11",
      "updated_in_db_at": "2018-10-13 03:04:40 +0800"
    },
    "relationships": {
      "account_list": {
        "data": {
          "type": "account_lists",
          "id": "2af3f091-6186-4ebe-ae27-0266f4a87e24"
        }
      }
    }
  }
}

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": "d9fbdb3d-ce8d-47ae-b90f-48868a9520a3",
    "type": "appeals",
    "attributes": {
      "amount": "1000.0",
      "created_at": "2018-10-12T19:04:40Z",
      "currencies": [

      ],
      "description": "The description for my new Appeal",
      "end_date": "2018-10-20",
      "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:04:40Z",
      "updated_in_db_at": "2018-10-12T19:04:40Z"
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "2af3f091-6186-4ebe-ae27-0266f4a87e24",
          "type": "account_lists"
        }
      },
      "contacts": {
        "data": [
          {
            "id": "b637315c-1dfb-4e3c-973e-36152290517d",
            "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/4f7fa621-ee5f-4fe5-8b9b-fd1093ab1e5f
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-20",
      "exclusion_filter": {
        "status": "Partner - Financial"
      },
      "inclusion_filter": {
        "status": "Partner - Financial,Partner - Pray"
      },
      "name": "Appeal #13",
      "updated_in_db_at": "2018-10-13 03:04:40 +0800"
    }
  }
}

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": "4f7fa621-ee5f-4fe5-8b9b-fd1093ab1e5f",
    "type": "appeals",
    "attributes": {
      "amount": "1000.0",
      "created_at": "2018-10-12T19:04:40Z",
      "currencies": [
        "ZAR"
      ],
      "description": "The description for my new Appeal",
      "end_date": "2018-10-20",
      "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:04:40Z",
      "updated_in_db_at": "2018-10-12T19:04:40Z"
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "ae581202-f72d-410c-aaa1-df7699177db0",
          "type": "account_lists"
        }
      },
      "contacts": {
        "data": [

        ]
      },
      "donations": {
        "data": [
          {
            "id": "fffe5dc6-0371-4c21-85c6-a81f4527843e",
            "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/87d8ffe8-e885-49bd-a7c5-1dadc65774e8
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/71ff0e05-697d-4e05-a1af-f3c6eb897d89
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": "71ff0e05-697d-4e05-a1af-f3c6eb897d89",
    "type": "background_batches",
    "attributes": {
      "created_at": "2018-10-12T19:04:41Z",
      "pending": 0,
      "total": 1,
      "updated_at": "2018-10-12T19:04:41Z",
      "updated_in_db_at": "2018-10-12T19:04:41Z"
    },
    "relationships": {
      "requests": {
        "data": [
          {
            "id": "fc35ae0b-74a2-4384-94be-aa49d78f5c00",
            "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": "22d0bddd-6fd1-4d58-8db0-712ff166e043",
      "type": "background_batches",
      "attributes": {
        "created_at": "2018-10-12T19:04:41Z",
        "pending": 0,
        "total": 1,
        "updated_at": "2018-10-12T19:04:41Z",
        "updated_in_db_at": "2018-10-12T19:04:41Z"
      },
      "relationships": {
        "requests": {
          "data": [
            {
              "id": "a3373510-baa9-46f5-984d-ce6aa9b055ec",
              "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 requests array

{
  "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": "4ae50528-37e9-4461-ad2e-f2babc6d5952",
            "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": "e771e105-3812-4b42-b031-6747847375a4",
    "type": "background_batches",
    "attributes": {
      "created_at": "2018-10-12T19:04:41Z",
      "pending": 0,
      "total": 1,
      "updated_at": "2018-10-12T19:04:41Z",
      "updated_in_db_at": "2018-10-12T19:04:41Z"
    },
    "relationships": {
      "requests": {
        "data": [
          {
            "id": "39c28053-63f6-4252-9d68-72aa3acbaea9",
            "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": {
        "09c5dcd9_b00a_4dc2_ac97_9807a1adbf4d": "Partner missed a gift",
        "77e88554_e897_45e1_9129_94d08d6d8891": "Partner started giving",
        "e022a9a4_cbc8_4bc5_ac50_a170f7d20a4b": "Partner gave a larger gift than commitment",
        "f66584a5_6337_4ae4_9cf2_ae384c4a6857": "Partner gave a Special Gift",
        "0c5fabed_914f_4e8b_8345_f4fcc6986400": "Partner gave less than commitment",
        "10fc99c8_6504_4496_8741_80cf7f27ba51": "Partner recontinued giving",
        "fa814030_d289_41ae_9787_ea8675b5995a": "Partner gave with commitment of semi-annual or more",
        "04610b3e_1a2f_44dd_9c31_00e790bebcf0": "Partner have not had an attempted call logged in the past year",
        "d8e66634_4bcd_47e4_8b26_62291ad84045": "Partner have not had a thank you note logged in the past year",
        "a54cd7ae_4b50_4c04_b118_96d4bba06724": "Partner (semiannual, annual, etc) has an expected donation one month from now. Send them a reminder.",
        "7ef1f311_574f_4c33_aca1_1b7315c2b9ab": "Contact is on the physical newsletter but has no mailing address.",
        "b2a50aad_b518_403b_8589_370fc305291f": "Contact is on the email newsletter but has no people with a valid email address."
      },
      "organizations": {
        "56112705_9298_4c00_b6fb_d543e0ad2708": "Organization198",
        "a15ccebf_623b_4546_af8b_d17c9067aead": "Organization199"
      },
      "organizations_attributes": {
        "56112705_9298_4c00_b6fb_d543e0ad2708": {
          "name": "Organization198",
          "api_class": "FakeApi",
          "help_email": null,
          "oauth": false
        },
        "a15ccebf_623b_4546_af8b_d17c9067aead": {
          "name": "Organization199",
          "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",
          "US",
          "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": "09c5dcd9-b00a-4dc2-ac97-9807a1adbf4d",
          "value": "Partner missed a gift"
        },
        {
          "id": "Partner started giving",
          "key": "77e88554-e897-45e1-9129-94d08d6d8891",
          "value": "Partner started giving"
        },
        {
          "id": "Partner gave a larger gift than commitment",
          "key": "e022a9a4-cbc8-4bc5-ac50-a170f7d20a4b",
          "value": "Partner gave a larger gift than commitment"
        },
        {
          "id": "Partner gave a Special Gift",
          "key": "f66584a5-6337-4ae4-9cf2-ae384c4a6857",
          "value": "Partner gave a Special Gift"
        },
        {
          "id": "Partner gave less than commitment",
          "key": "0c5fabed-914f-4e8b-8345-f4fcc6986400",
          "value": "Partner gave less than commitment"
        },
        {
          "id": "Partner recontinued giving",
          "key": "10fc99c8-6504-4496-8741-80cf7f27ba51",
          "value": "Partner recontinued giving"
        },
        {
          "id": "Partner gave with commitment of semi-annual or more",
          "key": "fa814030-d289-41ae-9787-ea8675b5995a",
          "value": "Partner gave with commitment of semi-annual or more"
        },
        {
          "id": "Partner have not had an attempted call logged in the past year",
          "key": "04610b3e-1a2f-44dd-9c31-00e790bebcf0",
          "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": "d8e66634-4bcd-47e4-8b26-62291ad84045",
          "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": "a54cd7ae-4b50-4c04-b118-96d4bba06724",
          "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": "7ef1f311-574f-4c33-aca1-1b7315c2b9ab",
          "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": "b2a50aad-b518-403b-8589-370fc305291f",
          "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": "09c5dcd9-b00a-4dc2-ac97-9807a1adbf4d",
          "value": "Partner missed a gift"
        },
        {
          "id": "Partner started giving",
          "key": "77e88554-e897-45e1-9129-94d08d6d8891",
          "value": "Partner started giving"
        },
        {
          "id": "Partner gave a larger gift than commitment",
          "key": "e022a9a4-cbc8-4bc5-ac50-a170f7d20a4b",
          "value": "Partner gave a larger gift than commitment"
        },
        {
          "id": "Partner gave a Special Gift",
          "key": "f66584a5-6337-4ae4-9cf2-ae384c4a6857",
          "value": "Partner gave a Special Gift"
        },
        {
          "id": "Partner gave less than commitment",
          "key": "0c5fabed-914f-4e8b-8345-f4fcc6986400",
          "value": "Partner gave less than commitment"
        },
        {
          "id": "Partner recontinued giving",
          "key": "10fc99c8-6504-4496-8741-80cf7f27ba51",
          "value": "Partner recontinued giving"
        },
        {
          "id": "Partner gave with commitment of semi-annual or more",
          "key": "fa814030-d289-41ae-9787-ea8675b5995a",
          "value": "Partner gave with commitment of semi-annual or more"
        },
        {
          "id": "Partner have not had an attempted call logged in the past year",
          "key": "04610b3e-1a2f-44dd-9c31-00e790bebcf0",
          "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": "d8e66634-4bcd-47e4-8b26-62291ad84045",
          "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": "a54cd7ae-4b50-4c04-b118-96d4bba06724",
          "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": "7ef1f311-574f-4c33-aca1-1b7315c2b9ab",
          "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": "b2a50aad-b518-403b-8589-370fc305291f",
          "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/39291daf-06d9-4b3c-aa94-f5d54bdc69c9
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/4ff32033-f263-436f-945a-0d8f7a9f7039
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": "4ff32033-f263-436f-945a-0d8f7a9f7039",
    "type": "contacts",
    "attributes": {
      "avatar": "https://mpdx.org/images/avatar.png",
      "church_name": null,
      "created_at": "2018-10-12T19:04:59Z",
      "deceased": false,
      "direct_deposit": false,
      "envelope_greeting": "Sherman 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-08",
      "lifetime_donations": "0.0",
      "likely_to_give": null,
      "locale": "en",
      "magazine": false,
      "name": "Raynor, Sherman",
      "next_ask": null,
      "no_appeals": null,
      "no_gift_aid": null,
      "notes": "Test Note.",
      "notes_saved_at": "2018-10-12T19:04:59Z",
      "pledge_amount": "100.0",
      "pledge_currency": "USD",
      "pledge_currency_symbol": "$",
      "pledge_frequency": "1",
      "pledge_received": false,
      "pledge_start_date": "2018-09-08",
      "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:04:59Z",
      "updated_in_db_at": "2018-10-12T19:04:59Z",
      "website": "http://bruen.biz/sigmund_weinat"
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "53093aa9-d2c7-4d31-828a-6e915debe8e8",
          "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": "b821dc4f-9646-430d-873a-a456d1974767",
      "type": "contacts",
      "attributes": {
        "avatar": "https://mpdx.org/images/avatar.png",
        "church_name": null,
        "created_at": "2018-10-12T19:04:59Z",
        "deceased": false,
        "direct_deposit": false,
        "envelope_greeting": "Mercedes 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-08",
        "likely_to_give": null,
        "locale": "en",
        "magazine": false,
        "name": "Heidenreich, Mercedes",
        "next_ask": null,
        "no_appeals": null,
        "no_gift_aid": null,
        "notes": "Test Note.",
        "notes_saved_at": "2018-10-12T19:04:59Z",
        "pledge_amount": "100.0",
        "pledge_currency": "USD",
        "pledge_currency_symbol": "$",
        "pledge_frequency": "1",
        "pledge_received": false,
        "pledge_start_date": "2018-09-08",
        "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:04:59Z",
        "updated_in_db_at": "2018-10-12T19:04:59Z",
        "website": "http://johns.name/preston_streich"
      },
      "relationships": {
        "account_list": {
          "data": {
            "id": "aa27031d-0941-4496-9f62-c742b717cf23",
            "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": "Leuschke, Rodrigo",
      "notes": "Test Note.",
      "overwrite": true,
      "pledge_amount": 100,
      "pledge_frequency": 1,
      "pledge_start_date": "2018-09-08 03:05:00 +0800",
      "status": "Partner - Financial",
      "website": "http://herman.info/abagail.schiller"
    },
    "relationships": {
      "account_list": {
        "data": {
          "type": "account_lists",
          "id": "5a4716d8-6e62-4129-872a-5d524b1aba02"
        }
      }
    }
  }
}

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": "6133960d-748e-472e-aeba-485aca518192",
    "type": "contacts",
    "attributes": {
      "avatar": "https://mpdx.org/images/avatar.png",
      "church_name": null,
      "created_at": "2018-10-12T19:05:00Z",
      "deceased": false,
      "direct_deposit": false,
      "envelope_greeting": "Rodrigo Leuschke",
      "greeting": "Rodrigo",
      "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-08",
      "lifetime_donations": "0.0",
      "likely_to_give": null,
      "locale": "en",
      "magazine": false,
      "name": "Leuschke, Rodrigo",
      "next_ask": null,
      "no_appeals": null,
      "no_gift_aid": null,
      "notes": "Test Note.",
      "notes_saved_at": "2018-10-12T19:05:00Z",
      "pledge_amount": "100.0",
      "pledge_currency": "USD",
      "pledge_currency_symbol": "$",
      "pledge_frequency": "1",
      "pledge_received": false,
      "pledge_start_date": "2018-09-08",
      "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:05:00Z",
      "updated_in_db_at": "2018-10-12T19:05:00Z",
      "website": "http://herman.info/abagail.schiller"
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "5a4716d8-6e62-4129-872a-5d524b1aba02",
          "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": "3c67560e-8557-477e-87b7-67b563fd5a97",
            "type": "people"
          }
        ]
      },
      "tasks": {
        "data": [

        ]
      },
      "primary_person": {
        "data": {
          "id": "3c67560e-8557-477e-87b7-67b563fd5a97",
          "type": "people"
        }
      },
      "primary_or_first_person": {
        "data": {
          "id": "3c67560e-8557-477e-87b7-67b563fd5a97",
          "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/bd9df84d-5ddc-4e82-950e-ba193e8ed57a
Content-Type: application/vnd.api+json

PUT /api/v2/contacts/:id

Parameters

{
  "data": {
    "type": "contacts",
    "attributes": {
      "locale": "en",
      "name": "Bartoletti, Name",
      "notes": "Test Note.",
      "overwrite": true,
      "pledge_amount": 100,
      "pledge_frequency": 1,
      "pledge_start_date": "2018-09-08 03:05:00 +0800",
      "status": "Partner - Financial",
      "website": "http://reichelschimmel.info/linnie"
    },
    "relationships": {
      "account_list": {
        "data": {
          "type": "account_lists",
          "id": "6ceb8f30-59a9-4e2b-b266-306c9f95f033"
        }
      }
    }
  }
}

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": "bd9df84d-5ddc-4e82-950e-ba193e8ed57a",
    "type": "contacts",
    "attributes": {
      "avatar": "https://mpdx.org/images/avatar.png",
      "church_name": null,
      "created_at": "2018-10-12T19:05:00Z",
      "deceased": false,
      "direct_deposit": false,
      "envelope_greeting": "Name 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-08",
      "lifetime_donations": "0.0",
      "likely_to_give": null,
      "locale": "en",
      "magazine": false,
      "name": "Bartoletti, Name",
      "next_ask": null,
      "no_appeals": null,
      "no_gift_aid": null,
      "notes": "Test Note.",
      "notes_saved_at": "2018-10-12T19:05:00Z",
      "pledge_amount": "100.0",
      "pledge_currency": "USD",
      "pledge_currency_symbol": "$",
      "pledge_frequency": "1",
      "pledge_received": false,
      "pledge_start_date": "2018-09-08",
      "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:05:00Z",
      "updated_in_db_at": "2018-10-12T19:05:00Z",
      "website": "http://reichelschimmel.info/linnie"
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "6ceb8f30-59a9-4e2b-b266-306c9f95f033",
          "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": "695fb382-5018-49b4-bc42-7d0b38d95e12"
      }
    },
    {
      "data": {
        "type": "contacts",
        "id": "fd087d52-ce50-4356-9bc7-5fe96c574ea3"
      }
    }
  ]
}

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": "fd087d52-ce50-4356-9bc7-5fe96c574ea3",
      "type": "contacts",
      "attributes": {
        "avatar": "https://mpdx.org/images/avatar.png",
        "church_name": null,
        "created_at": "2018-10-12T19:04:44Z",
        "deceased": false,
        "direct_deposit": false,
        "envelope_greeting": "Darian Berge",
        "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-08",
        "likely_to_give": null,
        "locale": "en",
        "magazine": false,
        "name": "Berge, Darian",
        "next_ask": null,
        "no_appeals": null,
        "no_gift_aid": null,
        "notes": "Test Note.",
        "notes_saved_at": "2018-10-12T19:04:44Z",
        "pledge_amount": "100.0",
        "pledge_currency": "USD",
        "pledge_currency_symbol": "$",
        "pledge_frequency": "1",
        "pledge_received": false,
        "pledge_start_date": "2018-09-08",
        "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:04:44Z",
        "updated_in_db_at": "2018-10-12T19:04:44Z",
        "website": "http://treutel.co/evelyn"
      },
      "relationships": {
        "account_list": {
          "data": {
            "id": "b159a909-20ac-48fc-a224-8b2db9843b60",
            "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": "695fb382-5018-49b4-bc42-7d0b38d95e12",
      "type": "contacts",
      "attributes": {
        "avatar": "https://mpdx.org/images/avatar.png",
        "church_name": null,
        "created_at": "2018-10-12T19:04:44Z",
        "deceased": false,
        "direct_deposit": false,
        "envelope_greeting": "Lesly Weimann",
        "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-08",
        "likely_to_give": null,
        "locale": "en",
        "magazine": false,
        "name": "Weimann, Lesly",
        "next_ask": null,
        "no_appeals": null,
        "no_gift_aid": null,
        "notes": "Test Note.",
        "notes_saved_at": "2018-10-12T19:04:44Z",
        "pledge_amount": "100.0",
        "pledge_currency": "USD",
        "pledge_currency_symbol": "$",
        "pledge_frequency": "1",
        "pledge_received": false,
        "pledge_start_date": "2018-09-08",
        "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:04:44Z",
        "updated_in_db_at": "2018-10-12T19:04:44Z",
        "website": "http://toy.name/rashawn"
      },
      "relationships": {
        "account_list": {
          "data": {
            "id": "b159a909-20ac-48fc-a224-8b2db9843b60",
            "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 data array

{
  "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 id to be used for the Contact being created.
• Each member of the array must contain a type that has the value of 'contacts'.
• Each member of the array must have an attributes hash 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": "850786ec-d258-4a70-bca7-6c5d00a39bba",
        "attributes": {
          "locale": "en",
          "name": "Durgan, Jacinto",
          "notes": "Test Note.",
          "pledge_amount": 100,
          "pledge_frequency": 1,
          "pledge_start_date": "2018-09-08 03:04:44 +0800",
          "status": "Partner - Financial",
          "website": "http://lemke.info/carlos",
          "updated_in_db_at": "2018-10-13 03:04:44 +0800"
        },
        "relationships": {
          "account_list": {
            "data": {
              "id": "8a798f22-dfcb-43df-b16c-bece3e18da02",
              "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": "850786ec-d258-4a70-bca7-6c5d00a39bba",
      "type": "contacts",
      "attributes": {
        "avatar": "https://mpdx.org/images/avatar.png",
        "church_name": null,
        "created_at": "2018-10-12T19:04:44Z",
        "deceased": false,
        "direct_deposit": false,
        "envelope_greeting": "Jacinto Durgan",
        "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-08",
        "likely_to_give": null,
        "locale": "en",
        "magazine": false,
        "name": "Durgan, Jacinto",
        "next_ask": null,
        "no_appeals": null,
        "no_gift_aid": null,
        "notes": "Test Note.",
        "notes_saved_at": "2018-10-12T19:04:44Z",
        "pledge_amount": "100.0",
        "pledge_currency": "USD",
        "pledge_currency_symbol": "$",
        "pledge_frequency": "1",
        "pledge_received": false,
        "pledge_start_date": "2018-09-08",
        "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:04:44Z",
        "updated_in_db_at": "2018-10-12T19:04:44Z",
        "website": "http://lemke.info/carlos"
      },
      "relationships": {
        "account_list": {
          "data": {
            "id": "8a798f22-dfcb-43df-b16c-bece3e18da02",
            "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": "4bb4ba17-17c0-4a34-8599-86363c301fdc",
        "attributes": {
          "locale": "en",
          "name": "Olson, Neal",
          "notes": "Test Note.",
          "pledge_amount": 100,
          "pledge_frequency": 1,
          "pledge_start_date": "2018-09-08 03:04:44 +0800",
          "status": "Partner - Financial",
          "website": "http://thiel.org/rogers.monahan",
          "updated_in_db_at": "2018-10-13 03:04:44 +0800"
        }
      }
    }
  ]
}

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": "4bb4ba17-17c0-4a34-8599-86363c301fdc",
      "type": "contacts",
      "attributes": {
        "avatar": "https://mpdx.org/images/avatar.png",
        "church_name": null,
        "created_at": "2018-10-12T19:04:44Z",
        "deceased": false,
        "direct_deposit": false,
        "envelope_greeting": "Neal Olson",
        "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-08",
        "likely_to_give": null,
        "locale": "en",
        "magazine": false,
        "name": "Olson, Neal",
        "next_ask": null,
        "no_appeals": null,
        "no_gift_aid": null,
        "notes": "Test Note.",
        "notes_saved_at": "2018-10-12T19:04:44Z",
        "pledge_amount": "100.0",
        "pledge_currency": "USD",
        "pledge_currency_symbol": "$",
        "pledge_frequency": "1",
        "pledge_received": false,
        "pledge_start_date": "2018-09-08",
        "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:04:44Z",
        "updated_in_db_at": "2018-10-12T19:04:44Z",
        "website": "http://thiel.org/rogers.monahan"
      },
      "relationships": {
        "account_list": {
          "data": {
            "id": "3e635a23-927d-4b44-aa2c-114e436cfcd0",
            "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/10c2a3cc-6136-4946-b223-6d5565306e09/people
Content-Type: application/vnd.api+json

POST /api/v2/contacts/:contact_id/people

Parameters

{
  "data": {
    "type": "people",
    "attributes": {
      "first_name": "Mpdx",
      "last_name": "Rosenbaum",
      "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": "b9ad8665-bd39-46ef-beb8-1c880958af66",
    "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:04:56Z",
      "deceased": false,
      "employer": null,
      "first_name": "Mpdx",
      "gender": null,
      "last_name": "Rosenbaum",
      "legal_first_name": null,
      "marital_status": null,
      "middle_name": null,
      "occupation": null,
      "optout_enewsletter": false,
      "parent_contacts": [
        "10c2a3cc-6136-4946-b223-6d5565306e09"
      ],
      "suffix": null,
      "title": null,
      "updated_at": "2018-10-12T19:04:56Z",
      "updated_in_db_at": "2018-10-12T19:04:56Z"
    },
    "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/bf3078c7-3bc2-4201-aee3-14791e50e033/people/e7af768f-d621-4c63-8f95-a7f41d8680b1
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": "e7af768f-d621-4c63-8f95-a7f41d8680b1",
    "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:04:56Z",
      "deceased": false,
      "employer": null,
      "first_name": "Mervin",
      "gender": null,
      "last_name": "Grant",
      "legal_first_name": null,
      "marital_status": null,
      "middle_name": null,
      "occupation": null,
      "optout_enewsletter": false,
      "parent_contacts": [
        "bf3078c7-3bc2-4201-aee3-14791e50e033"
      ],
      "suffix": null,
      "title": null,
      "updated_at": "2018-10-12T19:04:56Z",
      "updated_in_db_at": "2018-10-12T19:04:56Z"
    },
    "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/ca3bed64-a41e-4512-955b-1fd46b6251f6/people/2b05f3ab-a352-4b0a-b620-6d88754985c1
Content-Type: application/vnd.api+json

PUT /api/v2/contacts/:contact_id/people/:id

Parameters

{
  "data": {
    "type": "people",
    "attributes": {
      "first_name": "Mpdx",
      "last_name": "Turcotte",
      "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": "2b05f3ab-a352-4b0a-b620-6d88754985c1",
    "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:04:57Z",
      "deceased": false,
      "employer": null,
      "first_name": "Mpdx",
      "gender": null,
      "last_name": "Turcotte",
      "legal_first_name": null,
      "marital_status": null,
      "middle_name": null,
      "occupation": null,
      "optout_enewsletter": false,
      "parent_contacts": [
        "ca3bed64-a41e-4512-955b-1fd46b6251f6"
      ],
      "suffix": null,
      "title": null,
      "updated_at": "2018-10-12T19:04:57Z",
      "updated_in_db_at": "2018-10-12T19:04:57Z"
    },
    "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/a3d64176-3861-4207-9250-c246f86e2e22/people/7ea4dcc9-a7e1-4004-aebf-cc737f1e860c
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/a46daf0e-e089-4487-90c9-bf8b8f6352e1/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": "0350606f-6362-4add-b82b-12de9ce5916a",
      "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:04:56Z",
        "deceased": false,
        "employer": null,
        "first_name": "Albina",
        "gender": null,
        "last_name": "O'Connell",
        "legal_first_name": null,
        "marital_status": null,
        "middle_name": null,
        "occupation": null,
        "optout_enewsletter": false,
        "parent_contacts": [
          "a46daf0e-e089-4487-90c9-bf8b8f6352e1"
        ],
        "suffix": null,
        "title": null,
        "updated_at": "2018-10-12T19:04:56Z",
        "updated_in_db_at": "2018-10-12T19:04:56Z"
      },
      "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": "c9def549-016b-43ce-abc7-3670963b6176"
      }
    },
    {
      "data": {
        "type": "people",
        "id": "d3a32cd2-6d16-478e-890b-4e27f131a898"
      }
    }
  ]
}

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": "c9def549-016b-43ce-abc7-3670963b6176",
      "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:04:48Z",
        "deceased": false,
        "employer": null,
        "first_name": "Catalina",
        "gender": null,
        "last_name": "Bechtelar",
        "legal_first_name": null,
        "marital_status": null,
        "middle_name": null,
        "occupation": null,
        "optout_enewsletter": false,
        "parent_contacts": [
          "4472b043-1166-4107-ada3-563eb489d898"
        ],
        "suffix": null,
        "title": null,
        "updated_at": "2018-10-12T19:04:48Z",
        "updated_in_db_at": "2018-10-12T19:04:48Z"
      },
      "relationships": {
        "email_addresses": {
          "data": [

          ]
        },
        "facebook_accounts": {
          "data": [

          ]
        },
        "family_relationships": {
          "data": [

          ]
        },
        "linkedin_accounts": {
          "data": [

          ]
        },
        "phone_numbers": {
          "data": [

          ]
        },
        "twitter_accounts": {
          "data": [

          ]
        },
        "websites": {
          "data": [

          ]
        }
      }
    }
  },
  {
    "data": {
      "id": "d3a32cd2-6d16-478e-890b-4e27f131a898",
      "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:04:48Z",
        "deceased": false,
        "employer": null,
        "first_name": "Jordane",
        "gender": null,
        "last_name": "Bosco",
        "legal_first_name": null,
        "marital_status": null,
        "middle_name": null,
        "occupation": null,
        "optout_enewsletter": false,
        "parent_contacts": [
          "4472b043-1166-4107-ada3-563eb489d898"
        ],
        "suffix": null,
        "title": null,
        "updated_at": "2018-10-12T19:04:48Z",
        "updated_in_db_at": "2018-10-12T19:04:48Z"
      },
      "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 data array

{
  "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 id to be used for the Person being created.
• Each member of the array must contain a type that has the value of 'people'.
• Each member of the array must have an attributes hash 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": "841ebfe4-1d07-4f2b-be93-6de9deb9e630",
        "attributes": {
          "first_name": "Casandra",
          "last_name": "Shanahan",
          "updated_in_db_at": "2018-10-13 03:04:47 +0800"
        },
        "relationships": {
          "contacts": {
            "data": [
              {
                "type": "contacts",
                "id": "db390ffe-1aef-494e-b1a5-2366e6a78e93"
              }
            ]
          }
        }
      }
    }
  ]
}

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": "841ebfe4-1d07-4f2b-be93-6de9deb9e630",
      "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:04:47Z",
        "deceased": false,
        "employer": null,
        "first_name": "Casandra",
        "gender": null,
        "last_name": "Shanahan",
        "legal_first_name": null,
        "marital_status": null,
        "middle_name": null,
        "occupation": null,
        "optout_enewsletter": false,
        "parent_contacts": [
          "db390ffe-1aef-494e-b1a5-2366e6a78e93"
        ],
        "suffix": null,
        "title": null,
        "updated_at": "2018-10-12T19:04:47Z",
        "updated_in_db_at": "2018-10-12T19:04:47Z"
      },
      "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": "c461f29d-8947-4e6e-8065-7e7afcb7fa4f",
        "attributes": {
          "first_name": "Brown",
          "last_name": "Hoppe",
          "updated_in_db_at": "2018-10-13 03:04:48 +0800"
        }
      }
    }
  ]
}

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": "c461f29d-8947-4e6e-8065-7e7afcb7fa4f",
      "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:04:48Z",
        "deceased": false,
        "employer": null,
        "first_name": "Brown",
        "gender": null,
        "last_name": "Hoppe",
        "legal_first_name": null,
        "marital_status": null,
        "middle_name": null,
        "occupation": null,
        "optout_enewsletter": false,
        "parent_contacts": [
          "54862a9a-bee4-4695-b5b4-78780adb88b9"
        ],
        "suffix": null,
        "title": null,
        "updated_at": "2018-10-12T19:04:48Z",
        "updated_in_db_at": "2018-10-12T19:04:48Z"
      },
      "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/4d0c93bf-bdcd-4509-8413-8fb65c4b2861
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": "4d0c93bf-bdcd-4509-8413-8fb65c4b2861",
    "type": "tasks",
    "attributes": {
      "activity_type": "Call",
      "comments_count": 0,
      "completed": false,
      "completed_at": null,
      "created_at": "2018-10-12T19:05:05Z",
      "location": "MyString",
      "next_action": null,
      "notification_time_before": null,
      "notification_time_unit": null,
      "notification_type": null,
      "result": null,
      "starred": false,
      "start_at": "2012-03-08T06:59:46Z",
      "subject": "Call Mrs. Lamar Schaden",
      "subject_hidden": false,
      "tag_list": [

      ],
      "updated_at": "2018-10-12T19:05:05Z",
      "updated_in_db_at": "2018-10-12T19:05:05Z"
    },
    "relationships": {
      "comments": {
        "data": [

        ]
      },
      "contacts": {
        "data": [

        ]
      },
      "people": {
        "data": [

        ]
      },
      "email_addresses": {
        "data": [

        ]
      },
      "phone_numbers": {
        "data": [

        ]
      },
      "activity_contacts": {
        "data": [

        ]
      },
      "account_list": {
        "data": {
          "id": "e4cb1a92-d39b-47d4-bb99-9fe0e1dadf39",
          "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": "34e8ddd3-f4ef-436d-94b6-34b07d900a09",
      "type": "tasks",
      "attributes": {
        "activity_type": "Call",
        "comments_count": 0,
        "completed": false,
        "completed_at": null,
        "created_at": "2018-10-12T19:05:05Z",
        "location": "MyString",
        "next_action": null,
        "notification_time_before": null,
        "notification_time_unit": null,
        "notification_type": null,
        "result": null,
        "starred": false,
        "start_at": "2012-03-08T06:59:46Z",
        "subject": "Call Jerod Will Jr.",
        "subject_hidden": false,
        "tag_list": [

        ],
        "updated_at": "2018-10-12T19:05:05Z",
        "updated_in_db_at": "2018-10-12T19:05:05Z"
      },
      "relationships": {
        "comments": {
          "data": [

          ]
        },
        "contacts": {
          "data": [

          ]
        },
        "people": {
          "data": [

          ]
        },
        "email_addresses": {
          "data": [

          ]
        },
        "phone_numbers": {
          "data": [

          ]
        },
        "activity_contacts": {
          "data": [

          ]
        },
        "account_list": {
          "data": {
            "id": "ea0f57eb-f1dc-4193-93b5-aba5099909c5",
            "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 Eleazar Schroeder Jr.",
      "updated_in_db_at": "2018-10-13 03:05:05 +0800"
    },
    "type": "tasks",
    "relationships": {
      "account_list": {
        "data": {
          "type": "account_lists",
          "id": "98f52573-0d82-43f4-8f3e-f37e7c7a7a10"
        }
      }
    }
  }
}

Name	Type	Description	Required

Response

Content-Type: application/vnd.api+json; charset=utf-8
201 Created

{
  "data": {
    "id": "503e6f7b-5968-40ad-8e64-e6f123f6f6aa",
    "type": "tasks",
    "attributes": {
      "activity_type": "Call",
      "comments_count": 0,
      "completed": false,
      "completed_at": null,
      "created_at": "2018-10-12T19:05:05Z",
      "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 Eleazar Schroeder Jr.",
      "subject_hidden": false,
      "tag_list": [

      ],
      "updated_at": "2018-10-12T19:05:05Z",
      "updated_in_db_at": "2018-10-12T19:05:05Z"
    },
    "relationships": {
      "comments": {
        "data": [

        ]
      },
      "contacts": {
        "data": [

        ]
      },
      "people": {
        "data": [

        ]
      },
      "email_addresses": {
        "data": [

        ]
      },
      "phone_numbers": {
        "data": [

        ]
      },
      "activity_contacts": {
        "data": [

        ]
      },
      "account_list": {
        "data": {
          "id": "98f52573-0d82-43f4-8f3e-f37e7c7a7a10",
          "type": "account_lists"
        }
      }
    }
  }
}

Task [PUT]

Task [PUT]

Request

Endpoint

PUT /api/v2/tasks/0077cd84-8914-4677-8ef7-11eb0c2e36bd
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 Pearl Lesch",
      "updated_in_db_at": "2018-10-13 03:05:05 +0800"
    },
    "relationships": {
      "account_list": {
        "data": {
          "type": "account_lists",
          "id": "22d7fff7-8e5b-47c8-b5b3-c1f93e63bf7c"
        }
      }
    }
  }
}

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": "0077cd84-8914-4677-8ef7-11eb0c2e36bd",
    "type": "tasks",
    "attributes": {
      "activity_type": "Call",
      "comments_count": 0,
      "completed": false,
      "completed_at": null,
      "created_at": "2018-10-12T19:05:05Z",
      "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 Pearl Lesch",
      "subject_hidden": false,
      "tag_list": [

      ],
      "updated_at": "2018-10-12T19:05:06Z",
      "updated_in_db_at": "2018-10-12T19:05:06Z"
    },
    "relationships": {
      "comments": {
        "data": [

        ]
      },
      "contacts": {
        "data": [

        ]
      },
      "people": {
        "data": [

        ]
      },
      "email_addresses": {
        "data": [

        ]
      },
      "phone_numbers": {
        "data": [

        ]
      },
      "activity_contacts": {
        "data": [

        ]
      },
      "account_list": {
        "data": {
          "id": "22d7fff7-8e5b-47c8-b5b3-c1f93e63bf7c",
          "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": "4dd20c62-b3c3-4cc7-80db-3bba8e018d05"
      }
    },
    {
      "data": {
        "type": "tasks",
        "id": "da7781d6-c61a-49b8-87a2-476e2950b099"
      }
    }
  ]
}

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": "4dd20c62-b3c3-4cc7-80db-3bba8e018d05",
      "type": "tasks",
      "attributes": {
        "activity_type": "Call",
        "comments_count": 0,
        "completed": false,
        "completed_at": null,
        "created_at": "2018-10-12T19:05:03Z",
        "location": "MyString",
        "next_action": null,
        "notification_time_before": null,
        "notification_time_unit": null,
        "notification_type": null,
        "result": null,
        "starred": false,
        "start_at": "2012-03-08T06:59:46Z",
        "subject": "Call Karlie Cronin DDS",
        "subject_hidden": false,
        "tag_list": [

        ],
        "updated_at": "2018-10-12T19:05:03Z",
        "updated_in_db_at": "2018-10-12T19:05:03Z"
      },
      "relationships": {
        "comments": {
          "data": [

          ]
        },
        "contacts": {
          "data": [

          ]
        },
        "people": {
          "data": [

          ]
        },
        "email_addresses": {
          "data": [

          ]
        },
        "phone_numbers": {
          "data": [

          ]
        },
        "activity_contacts": {
          "data": [

          ]
        },
        "account_list": {
          "data": {
            "id": "cc35b241-f1e4-4cab-878f-dc3929ddc28b",
            "type": "account_lists"
          }
        }
      }
    }
  },
  {
    "data": {
      "id": "da7781d6-c61a-49b8-87a2-476e2950b099",
      "type": "tasks",
      "attributes": {
        "activity_type": "Call",
        "comments_count": 0,
        "completed": false,
        "completed_at": null,
        "created_at": "2018-10-12T19:05:03Z",
        "location": "MyString",
        "next_action": null,
        "notification_time_before": null,
        "notification_time_unit": null,
        "notification_type": null,
        "result": null,
        "starred": false,
        "start_at": "2012-03-08T06:59:46Z",
        "subject": "Call Kale Klocko",
        "subject_hidden": false,
        "tag_list": [

        ],
        "updated_at": "2018-10-12T19:05:03Z",
        "updated_in_db_at": "2018-10-12T19:05:03Z"
      },
      "relationships": {
        "comments": {
          "data": [

          ]
        },
        "contacts": {
          "data": [

          ]
        },
        "people": {
          "data": [

          ]
        },
        "email_addresses": {
          "data": [

          ]
        },
        "phone_numbers": {
          "data": [

          ]
        },
        "activity_contacts": {
          "data": [

          ]
        },
        "account_list": {
          "data": {
            "id": "cc35b241-f1e4-4cab-878f-dc3929ddc28b",
            "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": "9e53cf1d-88c9-47a4-861d-121a19683c81",
        "attributes": {
          "starred": false,
          "location": "MyString",
          "subject": "Call Jolie Hartmann",
          "start_at": "2012-03-08 14:59:46",
          "activity_type": "Call",
          "result": null,
          "completed_at": null,
          "updated_in_db_at": "2018-10-13 03:05:03 +0800"
        },
        "relationships": {
          "account_list": {
            "data": {
              "id": "1f2fa20a-5302-48db-a1fe-8fd4064f1ebf",
              "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": "9e53cf1d-88c9-47a4-861d-121a19683c81",
      "type": "tasks",
      "attributes": {
        "activity_type": "Call",
        "comments_count": 0,
        "completed": false,
        "completed_at": null,
        "created_at": "2018-10-12T19:05:03Z",
        "location": "MyString",
        "next_action": null,
        "notification_time_before": null,
        "notification_time_unit": null,
        "notification_type": null,
        "result": null,
        "starred": false,
        "start_at": "2012-03-08T06:59:46Z",
        "subject": "Call Jolie Hartmann",
        "subject_hidden": false,
        "tag_list": [

        ],
        "updated_at": "2018-10-12T19:05:03Z",
        "updated_in_db_at": "2018-10-12T19:05:03Z"
      },
      "relationships": {
        "comments": {
          "data": [

          ]
        },
        "contacts": {
          "data": [

          ]
        },
        "people": {
          "data": [

          ]
        },
        "email_addresses": {
          "data": [

          ]
        },
        "phone_numbers": {
          "data": [

          ]
        },
        "activity_contacts": {
          "data": [

          ]
        },
        "account_list": {
          "data": {
            "id": "1f2fa20a-5302-48db-a1fe-8fd4064f1ebf",
            "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": "dd6ebed4-a5ce-48f7-911b-f477ee67ea54",
        "attributes": {
          "starred": false,
          "location": "MyString",
          "subject": "Call Cristian Wiegand",
          "start_at": "2012-03-08 14:59:46",
          "activity_type": "Call",
          "result": null,
          "completed_at": null,
          "updated_in_db_at": "2018-10-13 03:05:03 +0800"
        }
      }
    }
  ]
}

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": "dd6ebed4-a5ce-48f7-911b-f477ee67ea54",
      "type": "tasks",
      "attributes": {
        "activity_type": "Call",
        "comments_count": 0,
        "completed": false,
        "completed_at": null,
        "created_at": "2018-10-12T19:05:03Z",
        "location": "MyString",
        "next_action": null,
        "notification_time_before": null,
        "notification_time_unit": null,
        "notification_type": null,
        "result": null,
        "starred": false,
        "start_at": "2012-03-08T06:59:46Z",
        "subject": "Call Cristian Wiegand",
        "subject_hidden": false,
        "tag_list": [

        ],
        "updated_at": "2018-10-12T19:05:03Z",
        "updated_in_db_at": "2018-10-12T19:05:03Z"
      },
      "relationships": {
        "comments": {
          "data": [

          ]
        },
        "contacts": {
          "data": [

          ]
        },
        "people": {
          "data": [

          ]
        },
        "email_addresses": {
          "data": [

          ]
        },
        "phone_numbers": {
          "data": [

          ]
        },
        "activity_contacts": {
          "data": [

          ]
        },
        "account_list": {
          "data": {
            "id": "7a3bad56-5b02-4781-a3fc-8ea4f9546443",
            "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": "ef2d9fb0-4af2-4cf7-9486-9eec23b4061c",
    "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:05:11Z",
      "deceased": false,
      "employer": null,
      "first_name": "Greta",
      "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:05:11Z",
      "updated_in_db_at": "2018-10-12T19:05:11Z"
    },
    "relationships": {
      "email_addresses": {
        "data": [
          {
            "id": "d1c57dba-9da7-4578-89a8-906aa8842ff8",
            "type": "email_addresses"
          }
        ]
      },
      "facebook_accounts": {
        "data": [

        ]
      },
      "family_relationships": {
        "data": [

        ]
      },
      "linkedin_accounts": {
        "data": [

        ]
      },
      "phone_numbers": {
        "data": [

        ]
      },
      "twitter_accounts": {
        "data": [

        ]
      },
      "websites": {
        "data": [

        ]
      },
      "account_lists": {
        "data": [
          {
            "id": "04f44bc7-bcc0-455f-a3e0-1be45b21abae",
            "type": "account_lists"
          }
        ]
      },
      "master_person": {
        "data": {
          "id": "9d8535b6-e9ed-4397-b0f6-996c6a0b5911",
          "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": "Jamar",
      "preferences": {
        "time_zone": "Perth"
      },
      "updated_in_db_at": "2018-10-13 03:05:11 +0800"
    }
  }
}

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": "5c962063-9963-4a40-9943-c7808507c485",
    "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:05:11Z",
      "deceased": false,
      "employer": null,
      "first_name": "Jamar",
      "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": "Perth",
        "locale": "en",
        "default_account_list": null,
        "setup": "no default_account_list"
      },
      "suffix": null,
      "title": null,
      "updated_at": "2018-10-12T19:05:11Z",
      "updated_in_db_at": "2018-10-12T19:05:11Z"
    },
    "relationships": {
      "email_addresses": {
        "data": [
          {
            "id": "725d0f93-b39a-4a49-bf24-d68644a42924",
            "type": "email_addresses"
          }
        ]
      },
      "facebook_accounts": {
        "data": [

        ]
      },
      "family_relationships": {
        "data": [

        ]
      },
      "linkedin_accounts": {
        "data": [

        ]
      },
      "phone_numbers": {
        "data": [

        ]
      },
      "twitter_accounts": {
        "data": [

        ]
      },
      "websites": {
        "data": [

        ]
      },
      "account_lists": {
        "data": [
          {
            "id": "a04dbc10-0700-4f7f-b411-ae0f88794824",
            "type": "account_lists"
          }
        ]
      },
      "master_person": {
        "data": {
          "id": "6d5e4f4f-c025-454c-8603-4adab88f84d2",
          "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/12ea70fe-362e-4879-9002-5d15ad8ca9cc/analytics?filter[start_date]=2018-10-06T03%3A04%3A26%2B08%3A00&filter[end_date]=2018-10-13T03%3A04%3A26%2B08%3A00
Content-Type: application/vnd.api+json

GET /api/v2/account_lists/:account_list_id/analytics

Parameters

filter: {"start_date"=>"2018-10-06T03:04:26+08:00", "end_date"=>"2018-10-13T03:04:26+08: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:04:26Z",
      "electronic": {
        "appointments": 0,
        "received": 0,
        "sent": 0
      },
      "email": {
        "received": 0,
        "sent": 0
      },
      "end_date": "2018-10-12T19:04:26Z",
      "facebook": {
        "received": 0,
        "sent": 0
      },
      "phone": {
        "appointments": 0,
        "attempted": 0,
        "completed": 0,
        "received": 0,
        "talktoinperson": 0
      },
      "start_date": "2018-09-12T19:04:26Z",
      "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/d6941f07-e92c-494d-b887-45f88fd96fe9/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:04:26Z",
      "electronic": {
        "appointments": 0,
        "received": 0,
        "sent": 0
      },
      "email": {
        "received": 0,
        "sent": 0
      },
      "end_date": "2018-10-12T19:04:26Z",
      "facebook": {
        "received": 0,
        "sent": 0
      },
      "phone": {
        "appointments": 0,
        "attempted": 0,
        "completed": 0,
        "received": 0,
        "talktoinperson": 0
      },
      "start_date": "2018-09-12T19:04:26Z",
      "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/a5c58109-627c-457a-b192-1a390969f29b/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:04:26Z",
      "updated_at": null,
      "updated_in_db_at": null
    }
  }
}

Designation Accounts

Designation Account [LIST]

Designation Account [LIST]

Request

Endpoint

GET /api/v2/account_lists/06ad33d9-b44a-406c-9e38-f36bf852caf7/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": "7bf96693-977a-420c-81b1-81afa5832bc5",
      "type": "designation_accounts",
      "attributes": {
        "active": true,
        "balance": "9.99",
        "balance_updated_at": null,
        "converted_balance": 9.99,
        "created_at": "-4713-12-31T16:16:36Z",
        "currency": "USD",
        "currency_symbol": "$",
        "designation_number": "1",
        "display_name": "Designation Name (1)",
        "exchange_rate": 1.0,
        "legacy_designation_number": null,
        "name": "Designation Name",
        "organization_name": "Organization15",
        "updated_at": "-4713-12-31T16:16:36Z",
        "updated_in_db_at": "-4713-12-31T16:16:36Z"
      },
      "relationships": {
        "organization": {
          "data": {
            "id": "ad53f8fb-ac14-4e55-ae61-dedccd1768f5",
            "type": "organizations"
          }
        },
        "balances": {
          "data": [
            {
              "id": "13b1ae54-ff72-49d1-8f8b-d3423b0b8035",
              "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/25a5c469-a934-4cc2-ae2d-c3b02236a236/designation_accounts/8acc952a-6ba6-468a-a75d-838c7edc6c26
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": "8acc952a-6ba6-468a-a75d-838c7edc6c26",
    "type": "designation_accounts",
    "attributes": {
      "active": true,
      "balance": "9.99",
      "balance_updated_at": null,
      "converted_balance": 9.99,
      "created_at": "-4713-12-31T16:16:36Z",
      "currency": "USD",
      "currency_symbol": "$",
      "designation_number": "3",
      "display_name": "Designation Name (3)",
      "exchange_rate": 1.0,
      "legacy_designation_number": null,
      "name": "Designation Name",
      "organization_name": "Organization21",
      "updated_at": "-4713-12-31T16:16:36Z",
      "updated_in_db_at": "-4713-12-31T16:16:36Z"
    },
    "relationships": {
      "organization": {
        "data": {
          "id": "d1de5b73-aae2-4ab5-8a9f-54dd9c362427",
          "type": "organizations"
        }
      },
      "balances": {
        "data": [
          {
            "id": "62e833f7-9641-4ea8-87a9-5ba9a56c81b8",
            "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
legacy_designation_number	-	The legacy remote system designation number
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

Request

Endpoint

GET /api/v2/account_lists/c4dce03a-b9c7-469e-a98b-9c336fc3c664/designation_accounts/589f6085-6544-414c-8b48-bbdaf34c2dff
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": "589f6085-6544-414c-8b48-bbdaf34c2dff",
    "type": "designation_accounts",
    "attributes": {
      "active": true,
      "balance": "9.99",
      "balance_updated_at": null,
      "converted_balance": 9.99,
      "created_at": "-4713-12-31T16:16:36Z",
      "currency": "USD",
      "currency_symbol": "$",
      "designation_number": "2",
      "display_name": "Designation Name (2)",
      "exchange_rate": 1.0,
      "legacy_designation_number": null,
      "name": "Designation Name",
      "organization_name": "Organization18",
      "updated_at": "-4713-12-31T16:16:36Z",
      "updated_in_db_at": "-4713-12-31T16:16:36Z"
    },
    "relationships": {
      "organization": {
        "data": {
          "id": "0bb1b625-d2c0-478b-9040-bcd60d8ea029",
          "type": "organizations"
        }
      },
      "balances": {
        "data": [
          {
            "id": "59a2004a-ec7f-4077-a013-5776461af18f",
            "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/69727efd-f409-419c-9895-1f401a63f493/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-13 03:04:28 +0800"
    },
    "relationships": {
      "donor_account": {
        "data": {
          "type": "donor_accounts",
          "id": "ae24dc52-e727-467a-a580-541b8083e6bc"
        }
      },
      "designation_account": {
        "data": {
          "type": "designation_accounts",
          "id": "b02066b6-5253-4493-b63a-2b2ba2440b4b"
        }
      }
    }
  }
}

Name	Type	Description	Required

Response

Content-Type: application/vnd.api+json; charset=utf-8
201 Created

{
  "data": {
    "id": "2508b7ed-3b61-497b-927b-be01d0efb910",
    "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:04:28Z",
      "currency": "ZAR",
      "donation_date": "2018-10-12",
      "legacy_remote_id": null,
      "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:04:28Z",
      "updated_in_db_at": "2018-10-12T19:04:28Z"
    },
    "relationships": {
      "appeal": {
        "data": null
      },
      "contact": {
        "data": {
          "id": "f947a39b-0b4a-4651-9db2-e5503b955bb8",
          "type": "contacts"
        }
      },
      "designation_account": {
        "data": {
          "id": "b02066b6-5253-4493-b63a-2b2ba2440b4b",
          "type": "designation_accounts"
        }
      },
      "donor_account": {
        "data": {
          "id": "ae24dc52-e727-467a-a580-541b8083e6bc",
          "type": "donor_accounts"
        }
      },
      "pledge": {
        "data": null
      }
    }
  }
}

Donation [DELETE]

Deletes the Donation associated with the Account List

Request

Endpoint

DELETE /api/v2/account_lists/e2b306f5-5f91-42e1-b5db-d85fb94ac9a4/donations/8ffc8035-a476-4439-9f41-83999cd05b19
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/60fe7c90-ac3c-47cc-bc18-f7c6ba308568/donations/fcc08246-a9a8-4943-ad08-b82a7ecbb8d2
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": "fcc08246-a9a8-4943-ad08-b82a7ecbb8d2",
    "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:04:28Z",
      "currency": "ZAR",
      "donation_date": "2018-10-12",
      "legacy_remote_id": null,
      "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:04:28Z",
      "updated_in_db_at": "2018-10-12T19:04:28Z"
    },
    "relationships": {
      "appeal": {
        "data": null
      },
      "contact": {
        "data": {
          "id": "53c19e3f-afac-4113-a520-48acc0a0dcab",
          "type": "contacts"
        }
      },
      "designation_account": {
        "data": {
          "id": "055fa404-6f21-4692-a946-0092c58a079e",
          "type": "designation_accounts"
        }
      },
      "donor_account": {
        "data": {
          "id": "a0612525-2c8b-4d81-b4ce-80b48caae5a8",
          "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/16eabf03-4aae-4b32-baff-69ec59e4b675/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": "fe4a993f-ae62-42d3-b2fd-6b34d2157770",
      "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:04:27Z",
        "currency": "ZAR",
        "donation_date": "2018-10-12",
        "legacy_remote_id": null,
        "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:04:27Z",
        "updated_in_db_at": "2018-10-12T19:04:27Z"
      },
      "relationships": {
        "appeal": {
          "data": null
        },
        "contact": {
          "data": {
            "id": "b40e727f-b5bc-4864-bfb9-99c901c68e1b",
            "type": "contacts"
          }
        },
        "designation_account": {
          "data": {
            "id": "10053611-8da9-4b46-b164-737e605e1708",
            "type": "designation_accounts"
          }
        },
        "donor_account": {
          "data": {
            "id": "2cbcbd25-b6b9-44b5-8217-c38f69ab6dcb",
            "type": "donor_accounts"
          }
        },
        "pledge": {
          "data": null
        }
      }
    },
    {
      "id": "f1d314e8-1d2f-4bea-a3cb-605217aea19d",
      "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:04:28Z",
        "currency": "ZAR",
        "donation_date": "2018-10-12",
        "legacy_remote_id": null,
        "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:04:28Z",
        "updated_in_db_at": "2018-10-12T19:04:28Z"
      },
      "relationships": {
        "appeal": {
          "data": null
        },
        "contact": {
          "data": {
            "id": "b40e727f-b5bc-4864-bfb9-99c901c68e1b",
            "type": "contacts"
          }
        },
        "designation_account": {
          "data": {
            "id": "10053611-8da9-4b46-b164-737e605e1708",
            "type": "designation_accounts"
          }
        },
        "donor_account": {
          "data": {
            "id": "2cbcbd25-b6b9-44b5-8217-c38f69ab6dcb",
            "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/1f64646a-7bd5-420c-b1db-5ff22c7296c5/donations/ea146d47-219a-4215-986e-16bb5116377f
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-13 03:04:28 +0800"
    }
  }
}

Name	Type	Description	Required

Response

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

{
  "data": {
    "id": "ea146d47-219a-4215-986e-16bb5116377f",
    "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:04:28Z",
      "currency": "ZAR",
      "donation_date": "2018-10-12",
      "legacy_remote_id": null,
      "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:04:28Z",
      "updated_in_db_at": "2018-10-12T19:04:28Z"
    },
    "relationships": {
      "appeal": {
        "data": null
      },
      "contact": {
        "data": {
          "id": "4dbba5b9-7109-4fb4-a70c-416ac3f068fb",
          "type": "contacts"
        }
      },
      "designation_account": {
        "data": {
          "id": "84554db5-888f-44a0-bc1d-f50fba977fce",
          "type": "designation_accounts"
        }
      },
      "donor_account": {
        "data": {
          "id": "9801c915-b2ee-4761-9846-4b9f5106bf84",
          "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/d52aa6da-7369-41c2-8bee-ef4becc98580/donor_accounts/733d3084-70a1-4f15-97e9-5af71543c837
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": "733d3084-70a1-4f15-97e9-5af71543c837",
    "type": "donor_accounts",
    "attributes": {
      "account_number": "MyString",
      "created_at": "2018-10-12T19:04:29Z",
      "display_name": "Williamson, Fernando (MyString)",
      "donor_type": "Type",
      "first_donation_date": "2018-10-12",
      "last_donation_date": "2018-10-12",
      "legacy_account_number": null,
      "total_donations": "3.0",
      "updated_at": "2018-10-12T19:04:29Z",
      "updated_in_db_at": "2018-10-12T19:04:29Z"
    },
    "relationships": {
      "organization": {
        "data": {
          "id": "ff5fd8e7-d3c7-4dc8-a843-dcc48d6f28e4",
          "type": "organizations"
        }
      },
      "contacts": {
        "data": [
          {
            "id": "1ef9065a-580c-4c82-9208-2733c047f7cb",
            "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/67b35b19-e2de-472e-a969-f0a847625b4f/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": "cff1ccc2-766f-43ae-9027-1f88b9a28f78",
      "type": "donor_accounts",
      "attributes": {
        "account_number": "MyString",
        "created_at": "2018-10-12T19:04:29Z",
        "display_name": "Greenholt, Alvah (MyString)",
        "donor_type": "Type",
        "first_donation_date": "2018-10-12",
        "last_donation_date": "2018-10-12",
        "legacy_account_number": null,
        "total_donations": "3.0",
        "updated_at": "2018-10-12T19:04:29Z",
        "updated_in_db_at": "2018-10-12T19:04:29Z"
      },
      "relationships": {
        "organization": {
          "data": {
            "id": "fc50bb91-1712-440a-b87d-3e8fb2deb4ae",
            "type": "organizations"
          }
        },
        "contacts": {
          "data": [
            {
              "id": "e389c139-a07c-432e-9c73-844512182688",
              "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/61a5ce12-feb6-4c23-bed8-5d4d62a80e83/imports/f45e35af-9e23-4ee9-9a4f-a3740e9695c1
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": "f45e35af-9e23-4ee9-9a4f-a3740e9695c1",
    "type": "imports",
    "attributes": {
      "account_list_id": "61a5ce12-feb6-4c23-bed8-5d4d62a80e83",
      "created_at": "2018-10-12T19:04:32Z",
      "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:04:32Z",
      "updated_in_db_at": "2018-10-12T19:04:32Z"
    },
    "relationships": {
      "user": {
        "data": {
          "id": "f692bb86-41b9-49d7-b299-2b92d1fa8da9",
          "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/9eafac13-e3c2-49b4-8c67-0a707f900177/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-13 03:04:30 +0800
------------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-13 03:04:30 +0800
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][updated_in_db_at]"

2018-10-13 03:04:30 +0800
------------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]"

9eafac13-e3c2-49b4-8c67-0a707f900177
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[relationships][user][data][type]"

users
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[relationships][user][data][id]"

f502c467-ba62-4b0f-91ce-a125d0890b7e
------------XnJLe9ZIbbGUYtzPQJ16u1--

Name	Type	Description	Required

Response

Content-Type: application/vnd.api+json; charset=utf-8
201 Created

{
  "data": {
    "id": "2b418d92-2009-47fb-8d02-aeea762d4cb2",
    "type": "imports",
    "attributes": {
      "account_list_id": "9eafac13-e3c2-49b4-8c67-0a707f900177",
      "created_at": "2018-10-12T19:04:30Z",
      "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/2b418d92-2009-47fb-8d02-aeea762d4cb2/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:04:30Z",
      "updated_in_db_at": "2018-10-12T19:04:30Z"
    },
    "relationships": {
      "user": {
        "data": {
          "id": "f502c467-ba62-4b0f-91ce-a125d0890b7e",
          "type": "users"
        }
      },
      "sample_contacts": {
        "data": [
          {
            "id": "cbfb27b6-f20a-451d-bab2-d3a3700d4de7",
            "type": "contacts"
          },
          {
            "id": "0d9b5ad7-f3ac-49e9-b4a4-c02352115cc4",
            "type": "contacts"
          },
          {
            "id": "b425d56d-31cd-4b1f-9cff-8868a7a61b6f",
            "type": "contacts"
          }
        ]
      }
    }
  }
}

Fields

Name	Type	Description

CSV Import [GET]

The Import with the given ID

Request

Endpoint

GET /api/v2/account_lists/82b349f6-0dd0-41ea-bea2-db4f6405a5c2/imports/csv/532a4ed1-a947-42ab-9641-385f635f350d
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": "532a4ed1-a947-42ab-9641-385f635f350d",
    "type": "imports",
    "attributes": {
      "account_list_id": "82b349f6-0dd0-41ea-bea2-db4f6405a5c2",
      "created_at": "2018-10-12T19:04:29Z",
      "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/532a4ed1-a947-42ab-9641-385f635f350d/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:04:29Z",
      "updated_in_db_at": "2018-10-12T19:04:29Z"
    },
    "relationships": {
      "user": {
        "data": {
          "id": "e7b25ccf-f3d7-4869-9e25-fdb061c1ba49",
          "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/0c3a0d9a-f995-4346-be78-bfe521408180/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": "ed587679-a2da-43ef-a816-2bac06600e78",
      "type": "imports",
      "attributes": {
        "account_list_id": "0c3a0d9a-f995-4346-be78-bfe521408180",
        "created_at": "2018-10-12T19:04:29Z",
        "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/ed587679-a2da-43ef-a816-2bac06600e78/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:04:29Z",
        "updated_in_db_at": "2018-10-12T19:04:29Z"
      },
      "relationships": {
        "user": {
          "data": {
            "id": "c7a15e84-1a8d-4f90-b918-e3f13d1fbc55",
            "type": "users"
          }
        },
        "sample_contacts": {
          "data": [

          ]
        }
      }
    },
    {
      "id": "4f9a3351-9ad2-4636-8758-6117df3be17b",
      "type": "imports",
      "attributes": {
        "account_list_id": "0c3a0d9a-f995-4346-be78-bfe521408180",
        "created_at": "2018-10-12T19:04:29Z",
        "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/4f9a3351-9ad2-4636-8758-6117df3be17b/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:04:29Z",
        "updated_in_db_at": "2018-10-12T19:04:29Z"
      },
      "relationships": {
        "user": {
          "data": {
            "id": "c7a15e84-1a8d-4f90-b918-e3f13d1fbc55",
            "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/c949fac2-2f60-44e5-84d7-d827f62f9f30/imports/csv/2413a7f6-3c77-4f72-9f4d-b10ec1ddba41
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-13 03:04:29 +0800
------------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-13 03:04:29 +0800
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[attributes][updated_in_db_at]"

2018-10-13 03:04:29 +0800
------------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]"

c949fac2-2f60-44e5-84d7-d827f62f9f30
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[relationships][user][data][type]"

users
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[relationships][user][data][id]"

4b3c9582-d1d8-474c-854b-25195616b433
------------XnJLe9ZIbbGUYtzPQJ16u1--

Name	Type	Description	Required

Response

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

{
  "data": {
    "id": "2413a7f6-3c77-4f72-9f4d-b10ec1ddba41",
    "type": "imports",
    "attributes": {
      "account_list_id": "c949fac2-2f60-44e5-84d7-d827f62f9f30",
      "created_at": "2018-10-12T19:04:29Z",
      "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/2413a7f6-3c77-4f72-9f4d-b10ec1ddba41/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:04:30Z",
      "updated_in_db_at": "2018-10-12T19:04:30Z"
    },
    "relationships": {
      "user": {
        "data": {
          "id": "4b3c9582-d1d8-474c-854b-25195616b433",
          "type": "users"
        }
      },
      "sample_contacts": {
        "data": [
          {
            "id": "11db18ca-9514-4adc-9236-644b823503c0",
            "type": "contacts"
          },
          {
            "id": "e9d86dac-dabb-41ad-acc9-c9ade109c9b5",
            "type": "contacts"
          },
          {
            "id": "a9053eff-ce93-4d06-8451-3b0c3dccda47",
            "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/7515304e-157c-425e-ae71-e1e0d1e45bd3/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": "0a72e084-a98e-4b04-8624-95f0f79ec1b2"
        }
      }
    }
  }
}

Name	Type	Description	Required

Response

Content-Type: application/vnd.api+json; charset=utf-8
201 Created

{
  "data": {
    "id": "3008eecd-e3e5-4fbd-835f-87e11983ec0e",
    "type": "imports",
    "attributes": {
      "account_list_id": "7515304e-157c-425e-ae71-e1e0d1e45bd3",
      "created_at": "2018-10-12T19:04:31Z",
      "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:04:31Z",
      "updated_in_db_at": "2018-10-12T19:04:31Z"
    },
    "relationships": {
      "user": {
        "data": {
          "id": "6aff25b2-1816-4bd2-93b6-44dd5da8fb56",
          "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/defd1105-c3c3-4145-a543-fe1b25f62661/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]"

defd1105-c3c3-4145-a543-fe1b25f62661
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[relationships][user][data][type]"

users
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[relationships][user][data][id]"

5bd8660e-a857-4729-802b-45c103807af3
------------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]"

b5324fd6-3da4-4cb0-88ac-3574b31cafc3
------------XnJLe9ZIbbGUYtzPQJ16u1--

Name	Type	Description	Required

Response

Content-Type: application/vnd.api+json; charset=utf-8
201 Created

{
  "data": {
    "id": "69ee284c-5884-469b-8ea4-30c6431e7d21",
    "type": "imports",
    "attributes": {
      "account_list_id": "defd1105-c3c3-4145-a543-fe1b25f62661",
      "created_at": "2018-10-12T19:04:31Z",
      "file_constants": {
      },
      "file_constants_mappings": {
      },
      "file_headers": {
      },
      "file_headers_mappings": {
      },
      "file_url": "/uploads/import/file/69ee284c-5884-469b-8ea4-30c6431e7d21/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:04:31Z",
      "updated_in_db_at": "2018-10-12T19:04:31Z"
    },
    "relationships": {
      "user": {
        "data": {
          "id": "5bd8660e-a857-4729-802b-45c103807af3",
          "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/30422989-d24d-4a4d-8850-a4a617a09696/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]"

30422989-d24d-4a4d-8850-a4a617a09696
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[relationships][user][data][type]"

users
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="data[relationships][user][data][id]"

25860c3d-5e2a-4812-8fd6-deacff9382d1
------------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]"

d333711e-074f-4b78-ba4c-361bd4b89cbd
------------XnJLe9ZIbbGUYtzPQJ16u1--

Name	Type	Description	Required

Response

Content-Type: application/vnd.api+json; charset=utf-8
201 Created

{
  "data": {
    "id": "e7d56a35-287e-445d-b62f-e6cd60730535",
    "type": "imports",
    "attributes": {
      "account_list_id": "30422989-d24d-4a4d-8850-a4a617a09696",
      "created_at": "2018-10-12T19:04:31Z",
      "file_constants": {
      },
      "file_constants_mappings": {
      },
      "file_headers": {
      },
      "file_headers_mappings": {
      },
      "file_url": "/uploads/import/file/e7d56a35-287e-445d-b62f-e6cd60730535/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:04:31Z",
      "updated_in_db_at": "2018-10-12T19:04:31Z"
    },
    "relationships": {
      "user": {
        "data": {
          "id": "25860c3d-5e2a-4812-8fd6-deacff9382d1",
          "type": "users"
        }
      },
      "sample_contacts": {
        "data": [

        ]
      }
    }
  }
}

Fields

Name	Type	Description

Invites

Invite [ACCEPT]

Accepts the invite

Request

Endpoint

PUT /api/v2/account_lists/97853d32-cb8d-4225-9f6a-b6ea99821ddf/invites/bf9c90e4-e1f5-4037-b664-a314b418ebbd/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": "bf9c90e4-e1f5-4037-b664-a314b418ebbd",
    "type": "account_list_invites",
    "attributes": {
      "accepted_at": "2018-10-12T19:04:33Z",
      "code": "abc",
      "created_at": "2018-10-12T19:04:33Z",
      "invite_user_as": "user",
      "recipient_email": "joe@example.com",
      "updated_at": "2018-10-12T19:04:33Z",
      "updated_in_db_at": "2018-10-12T19:04:33Z"
    },
    "relationships": {
      "accepted_by_user": {
        "data": {
          "id": "ea61e60b-cc5d-4276-8c7e-202b91eacc06",
          "type": "users"
        }
      },
      "cancelled_by_user": {
        "data": null
      },
      "invited_by_user": {
        "data": {
          "id": "a0804731-73b8-47ca-9401-3d49440f4351",
          "type": "users"
        }
      }
    }
  }
}

Invite [CANCEL]

Cancels the invite

Request

Endpoint

DELETE /api/v2/account_lists/f0d15596-30e9-4b66-b323-2dc9e68eb332/invites/4e2cc037-63d4-462c-a471-5f3fcc151ebd
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/7e4a5baf-c771-4dae-a295-ed3ca8a97447/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": "384d8137-c403-4363-9846-cba94d3a4b76",
    "type": "account_list_invites",
    "attributes": {
      "accepted_at": null,
      "code": "a42a05aa6b4a6563823a7aef87036e0352af344bea0c6121837bd48b2865415b",
      "created_at": "2018-10-12T19:04:33Z",
      "invite_user_as": "user",
      "recipient_email": "joe@example.com",
      "updated_at": "2018-10-12T19:04:33Z",
      "updated_in_db_at": "2018-10-12T19:04:33Z"
    },
    "relationships": {
      "accepted_by_user": {
        "data": null
      },
      "cancelled_by_user": {
        "data": null
      },
      "invited_by_user": {
        "data": {
          "id": "b6409d9f-6d2e-46d7-970d-dee2301fd79c",
          "type": "users"
        }
      }
    }
  }
}

Invite [GET]

The Account List Invite with the given ID

Request

Endpoint

GET /api/v2/account_lists/7cf3a2e0-036a-461e-ad39-12ac2d3a2de7/invites/0ba7f042-f945-4099-a224-4ce488a99fbd
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": "0ba7f042-f945-4099-a224-4ce488a99fbd",
    "type": "account_list_invites",
    "attributes": {
      "accepted_at": "-4713-12-31T16:16:36Z",
      "code": "abc",
      "created_at": "2018-10-12T19:04:32Z",
      "invite_user_as": "user",
      "recipient_email": "joe@example.com",
      "updated_at": "2018-10-12T19:04:32Z",
      "updated_in_db_at": "2018-10-12T19:04:32Z"
    },
    "relationships": {
      "accepted_by_user": {
        "data": null
      },
      "cancelled_by_user": {
        "data": null
      },
      "invited_by_user": {
        "data": {
          "id": "aa428bdd-f7dd-4b38-b75b-c259d447760f",
          "type": "users"
        }
      }
    }
  }
}

Fields

Name	Type	Description

Invite [LIST]

List of Invites associated with the Account List

Request

Endpoint

GET /api/v2/account_lists/03ded066-e212-4b3c-bb31-458442e40a62/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": "f572e8f0-cac3-4f83-baaa-ef84d4b9063d",
      "type": "account_list_invites",
      "attributes": {
        "accepted_at": "-4713-12-31T16:16:36Z",
        "code": "abc",
        "created_at": "2018-10-12T19:04:32Z",
        "invite_user_as": "user",
        "recipient_email": "joe@example.com",
        "updated_at": "2018-10-12T19:04:32Z",
        "updated_in_db_at": "2018-10-12T19:04:32Z"
      },
      "relationships": {
        "accepted_by_user": {
          "data": null
        },
        "cancelled_by_user": {
          "data": null
        },
        "invited_by_user": {
          "data": {
            "id": "113464be-a6bb-4095-837b-9d65dac0fae5",
            "type": "users"
          }
        }
      }
    },
    {
      "id": "7f2eec6f-63dd-44db-8230-78ad51a117b8",
      "type": "account_list_invites",
      "attributes": {
        "accepted_at": "-4713-12-31T16:16:36Z",
        "code": "abc",
        "created_at": "2018-10-12T19:04:32Z",
        "invite_user_as": "coach",
        "recipient_email": "joe@example.com",
        "updated_at": "2018-10-12T19:04:32Z",
        "updated_in_db_at": "2018-10-12T19:04:32Z"
      },
      "relationships": {
        "accepted_by_user": {
          "data": null
        },
        "cancelled_by_user": {
          "data": null
        },
        "invited_by_user": {
          "data": {
            "id": "d7c27e07-9cc7-4061-ab57-1a349509412d",
            "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/feaa71dd-7360-44e9-88ff-55b2f65be8d6/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/80d9ab63-c448-47a6-9635-3605edecf806/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": "103975a8-eea5-4430-8d6c-8352adc8643a",
    "type": "mail_chimp_accounts",
    "attributes": {
      "active": false,
      "api_key": "fake-us4",
      "auto_log_campaigns": false,
      "created_at": "2018-10-12T19:04:33Z",
      "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:04:33Z",
      "updated_in_db_at": "2018-10-12T19:04:33Z",
      "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/54427352-70b9-4cbe-a13e-185d12f00a3b/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": "931f01f0-7cd5-4fbf-aa2f-34bf17aab556",
    "type": "mail_chimp_accounts",
    "attributes": {
      "active": false,
      "api_key": "fake-us4",
      "auto_log_campaigns": true,
      "created_at": "2018-10-12T19:04:34Z",
      "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:04:34Z",
      "updated_in_db_at": "2018-10-12T19:04:34Z",
      "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/71d31944-618d-4a1f-9d6a-152b975c146d/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/5a0cd8fd-36bb-437b-94ef-2199ca937091/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": "29de5b0a-17ed-41cf-bca5-6d992455b993"
        }
      }
    }
  }
}

Name	Type	Description	Required

Response

Content-Type: application/vnd.api+json; charset=utf-8
201 Created

{
  "data": {
    "id": "08c0f12a-a2d4-491d-92bc-19d15154dd40",
    "type": "notification_preferences",
    "attributes": {
      "created_at": "2018-10-12T19:04:35Z",
      "email": true,
      "task": true,
      "updated_at": "2018-10-12T19:04:35Z",
      "updated_in_db_at": "2018-10-12T19:04:35Z"
    },
    "relationships": {
      "notification_type": {
        "data": {
          "id": "29de5b0a-17ed-41cf-bca5-6d992455b993",
          "type": "notification_type"
        }
      }
    }
  }
}

Notification Preference [DELETE]

Delete Notification Preference

Request

Endpoint

DELETE /api/v2/account_lists/cced4266-4ecd-46d0-8da4-b9ef4e083929/notification_preferences/3485cc49-b6cc-4ee7-b155-ee14387b1e94
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/025f36bd-865d-4a5a-8722-0ce52ba7820d/notification_preferences/5119cae1-e027-4df8-87cd-571ff5146b75
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": "5119cae1-e027-4df8-87cd-571ff5146b75",
    "type": "notification_preferences",
    "attributes": {
      "created_at": "2018-10-12T19:04:35Z",
      "email": true,
      "task": true,
      "updated_at": "2018-10-12T19:04:35Z",
      "updated_in_db_at": "2018-10-12T19:04:35Z"
    },
    "relationships": {
      "notification_type": {
        "data": {
          "id": "b6234a69-0d02-4073-a0a2-f2385087c526",
          "type": "notification_type"
        }
      }
    }
  }
}

Fields

Name	Type	Description

Notification Preference [LIST]

List of Notification Preferences

Request

Endpoint

GET /api/v2/account_lists/2b9e489f-7411-44e1-a7db-469f083a9e28/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": "92e24a9f-a214-4fce-8d44-387fce5b53c4",
      "type": "notification_preferences",
      "attributes": {
        "created_at": "2018-10-12T19:04:34Z",
        "email": true,
        "task": true,
        "updated_at": "2018-10-12T19:04:34Z",
        "updated_in_db_at": "2018-10-12T19:04:34Z"
      },
      "relationships": {
        "notification_type": {
          "data": {
            "id": "cc5ed63f-9cfb-4ae5-aeb1-6ad64f96b3eb",
            "type": "notification_type"
          }
        }
      }
    },
    {
      "id": "c63a30d0-1c2a-4b46-bb40-7153e41924b9",
      "type": "notification_preferences",
      "attributes": {
        "created_at": "2018-10-12T19:04:34Z",
        "email": true,
        "task": true,
        "updated_at": "2018-10-12T19:04:34Z",
        "updated_in_db_at": "2018-10-12T19:04:34Z"
      },
      "relationships": {
        "notification_type": {
          "data": {
            "id": "50778ce2-4d78-4043-a476-cfa932541749",
            "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 Clear [PUT]

set all cleared value to true for all notifications associated with account list to

Request

Endpoint

PUT /api/v2/account_lists/25b8e145-ddd3-42e3-98ff-92aaca3e806b/notifications/clear
Content-Type: application/vnd.api+json

PUT /api/v2/account_lists/:account_list_id/notifications/clear

Parameters

None known.

Response

Content-Type: text/html; charset=utf-8
200 OK

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.

Notification [GET]

Notification [GET]

Request

Endpoint

GET /api/v2/account_lists/a54876ac-69e1-4f09-b79f-04c8539c3621/notifications/8ea9807c-c476-442c-8fbf-172f34be0aa1
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": "8ea9807c-c476-442c-8fbf-172f34be0aa1",
    "type": "notifications",
    "attributes": {
      "cleared": false,
      "created_at": "2018-10-12T19:04:35Z",
      "event_date": "2012-10-23T09:03:15Z",
      "updated_at": "2018-10-12T19:04:35Z",
      "updated_in_db_at": "2018-10-12T19:04:35Z"
    },
    "relationships": {
      "contact": {
        "data": {
          "id": "e062102b-06cd-4471-bd21-fe3f0e98e259",
          "type": "contacts"
        }
      },
      "notification_type": {
        "data": {
          "id": "18aae343-7a9a-47a2-a01f-c8e3988934f6",
          "type": "notification_type"
        }
      },
      "donation": {
        "data": {
          "id": "05a12e51-5f20-41ab-b133-1d6ac5798db3",
          "type": "donations"
        }
      }
    }
  }
}

Fields

Name	Type	Description
Attributes
cleared	boolean	If this notification has been read by the user then cleared should be marked as true
created_at	ISO8601 timestamp	The timestamp of when this resource was created
event_date	date	The date the event that triggered the notification occured
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
contact.data	Contact	The Contact the notification applies to
donation.data	Donation	The Donation the notification applies to (Optional)
notification_type.data	NotificationType	The notification type indicating what event triggered the notification

Notification [LIST]

Notification [LIST]

Request

Endpoint

GET /api/v2/account_lists/94bef348-7b4a-4948-a6d7-1e25323ac4b8/notifications
Content-Type: application/vnd.api+json

GET /api/v2/account_lists/:account_list_id/notifications

Parameters

Name	Type	Description	Required
Filters
filter[cleared]	boolean	Filter by cleared	-

Response

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

{
  "data": [
    {
      "id": "71402c5d-ea72-4fbf-900f-0cd63066d92c",
      "type": "notifications",
      "attributes": {
        "cleared": false,
        "created_at": "2018-10-12T19:04:35Z",
        "event_date": "2012-10-23T09:03:15Z",
        "updated_at": "2018-10-12T19:04:35Z",
        "updated_in_db_at": "2018-10-12T19:04:35Z"
      },
      "relationships": {
        "contact": {
          "data": {
            "id": "8dc5d737-af2a-4c9b-b898-e4f4615214e7",
            "type": "contacts"
          }
        },
        "notification_type": {
          "data": {
            "id": "eeb173e3-829d-4da3-a51f-c9d5acddde88",
            "type": "notification_type"
          }
        },
        "donation": {
          "data": {
            "id": "6767af52-2d65-43e5-a5da-3ddd38abb801",
            "type": "donations"
          }
        }
      }
    },
    {
      "id": "6cf4bca5-214f-4226-a18f-1d6a53644fee",
      "type": "notifications",
      "attributes": {
        "cleared": false,
        "created_at": "2018-10-12T19:04:35Z",
        "event_date": "2012-10-23T09:03:15Z",
        "updated_at": "2018-10-12T19:04:35Z",
        "updated_in_db_at": "2018-10-12T19:04:35Z"
      },
      "relationships": {
        "contact": {
          "data": {
            "id": "8dc5d737-af2a-4c9b-b898-e4f4615214e7",
            "type": "contacts"
          }
        },
        "notification_type": {
          "data": {
            "id": "45045896-6fb4-4e58-95d7-16aedc668a3b",
            "type": "notification_type"
          }
        },
        "donation": {
          "data": {
            "id": "418bcfb7-b13e-4e28-9f5a-84b9aed40311",
            "type": "donations"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 2,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

Fields

Name	Type	Description
data	[Notification]	An array of Notification Objects

Notification [PUT]

Notification [PUT]

Request

Endpoint

PUT /api/v2/account_lists/3f8720e9-30b7-4766-9719-bc0a5f838937/notifications/79642fc9-ada6-4bcd-a181-cfe7b8ce52a3
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-13 03:04:36 +0800"
    },
    "relationships": {
      "contact": {
        "data": {
          "type": "contacts",
          "id": "39c1ca31-2859-45a2-b936-72664742fa0b"
        }
      },
      "donation": {
        "data": {
          "type": "donations",
          "id": "afbd4517-184b-4228-b74a-96cbd580c54d"
        }
      },
      "notification_type": {
        "data": {
          "type": "notification_types",
          "id": "84a8693c-2e00-4365-ba8c-8bb74642e039"
        }
      }
    }
  }
}

Name	Type	Description	Required
Attributes
cleared	boolean	If this notification has been read by the user then cleared should be marked as true	-
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": "79642fc9-ada6-4bcd-a181-cfe7b8ce52a3",
    "type": "notifications",
    "attributes": {
      "cleared": false,
      "created_at": "2018-10-12T19:04:36Z",
      "event_date": "2012-10-23T09:03:15Z",
      "updated_at": "2018-10-12T19:04:36Z",
      "updated_in_db_at": "2018-10-12T19:04:36Z"
    },
    "relationships": {
      "contact": {
        "data": {
          "id": "39c1ca31-2859-45a2-b936-72664742fa0b",
          "type": "contacts"
        }
      },
      "notification_type": {
        "data": {
          "id": "84a8693c-2e00-4365-ba8c-8bb74642e039",
          "type": "notification_type"
        }
      },
      "donation": {
        "data": {
          "id": "4c14ce47-438a-4482-adfe-14ee2016672c",
          "type": "donations"
        }
      }
    }
  }
}

Fields

Name	Type	Description
Attributes
cleared	boolean	If this notification has been read by the user then cleared should be marked as true
created_at	ISO8601 timestamp	The timestamp of when this resource was created
event_date	date	The date the event that triggered the notification occured
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
contact.data	Contact	The Contact the notification applies to
donation.data	Donation	The Donation the notification applies to (Optional)
notification_type.data	NotificationType	The notification type indicating what event triggered the notification

Prayer Letters Accounts

Prayer Letters Account [CREATE]

Create a Prayer Letters Account associated with the Account List

Request

Endpoint

POST /api/v2/account_lists/b58a4163-b420-4dd4-9b1b-375d108772bf/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": "6af85b50-30dc-479b-bbc8-a60e90ba6cd1",
    "type": "prayer_letters_accounts",
    "attributes": {
      "created_at": "2018-10-12T19:04:37Z",
      "token": null,
      "updated_at": "2018-10-12T19:04:37Z",
      "updated_in_db_at": "2018-10-12T19:04:37Z"
    }
  }
}

Prayer Letters Account [DELETE]

Deletes the Prayer Letters Account associated with the Account List

Request

Endpoint

DELETE /api/v2/account_lists/2c00add4-58b0-40fd-a37f-4dc3da840594/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/c338629c-35e6-484b-aa96-c99358bbe916/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": "401d6e44-ccbf-4cf2-93e1-cc0cf63bf603",
    "type": "prayer_letters_accounts",
    "attributes": {
      "created_at": "2018-10-12T19:04:37Z",
      "token": "MyString",
      "updated_at": "2018-10-12T19:04:37Z",
      "updated_in_db_at": "2018-10-12T19:04:37Z"
    }
  }
}

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/bf2c5d42-7ced-49df-9f6a-8ed5626c7c5b/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/f7d41ab3-c620-4adc-9d9c-eafc6b32041c/users/002ecea7-752d-4b48-bb52-8da6fe6289d1
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/9c14f9e0-256e-4289-9131-dc3b4a92374f/users/572cffd5-1e23-46f7-a1bb-4e21c6a18809
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": "572cffd5-1e23-46f7-a1bb-4e21c6a18809",
    "type": "users",
    "attributes": {
      "created_at": "2018-10-12T19:04:37Z",
      "first_name": "Van",
      "last_name": null,
      "updated_at": "2018-10-12T19:04:37Z",
      "updated_in_db_at": "2018-10-12T19:04:37Z"
    }
  }
}

Fields

Name	Type	Description

User [LIST]

List of Users associated to the Account List

Request

Endpoint

GET /api/v2/account_lists/1c104475-a086-43f3-b25e-8c061624c30d/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": "5dca42fb-f5e8-49e1-974a-6e6d4fa709cb",
      "type": "users",
      "attributes": {
        "created_at": "2018-10-12T19:04:37Z",
        "first_name": "Keira",
        "last_name": null,
        "updated_at": "2018-10-12T19:04:37Z",
        "updated_in_db_at": "2018-10-12T19:04:37Z"
      }
    },
    {
      "id": "82d755c1-718f-4839-86ae-fa211a66a5fb",
      "type": "users",
      "attributes": {
        "created_at": "2018-10-12T19:04:37Z",
        "first_name": "Kenton",
        "last_name": null,
        "updated_at": "2018-10-12T19:04:37Z",
        "updated_in_db_at": "2018-10-12T19:04:37Z"
      }
    },
    {
      "id": "e3725846-6174-461c-9ca6-9de88692563b",
      "type": "users",
      "attributes": {
        "created_at": "2018-10-12T19:04:37Z",
        "first_name": "Aditya",
        "last_name": null,
        "updated_at": "2018-10-12T19:04:37Z",
        "updated_in_db_at": "2018-10-12T19:04:37Z"
      }
    }
  ],
  "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/fa763e23-8fc1-445f-b903-7e725cff9127/addresses/834b7126-acbe-4aea-b94c-40ca625f095d
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/5d2672ec-b6d0-404c-b96d-f57d6d5a1a6d/addresses/f2a12675-fe12-4528-bdd2-8e286cd07a92
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": "f2a12675-fe12-4528-bdd2-8e286cd07a92",
    "type": "addresses",
    "attributes": {
      "city": "Fremont",
      "country": "United States",
      "created_at": "2018-10-12T19:04:43Z",
      "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:04:43Z",
      "updated_in_db_at": "2018-10-12T19:04:43Z",
      "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/e1e3e7c4-2b72-4206-9535-30f4a787a241/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": "2329c5fd-8bdb-4e72-9761-53dba0d9aacf",
      "type": "addresses",
      "attributes": {
        "city": "Fremont",
        "country": "United States",
        "created_at": "2018-10-12T19:04:43Z",
        "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:04:43Z",
        "updated_in_db_at": "2018-10-12T19:04:43Z",
        "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/7ddb827b-3adf-4caf-ab9a-bc780d35880c/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-13 03:04:43 +0800",
      "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": "a590eebf-984e-46ba-8753-24037e6cbd7b",
    "type": "addresses",
    "attributes": {
      "city": "Fremont",
      "country": "United States",
      "created_at": "2018-10-12T19:04:43Z",
      "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:04:43Z",
      "updated_in_db_at": "2018-10-12T19:04:43Z",
      "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/1cea8e34-b336-437d-a596-03ca79810489/addresses/bf9a7189-9c6a-47c1-82bf-9be2a26c6fb1
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-13 03:04:43 +0800",
      "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": "bf9a7189-9c6a-47c1-82bf-9be2a26c6fb1",
    "type": "addresses",
    "attributes": {
      "city": "Fremont",
      "country": "United States",
      "created_at": "2018-10-12T19:04:43Z",
      "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:04:43Z",
      "updated_in_db_at": "2018-10-12T19:04:43Z",
      "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:04:44Z",
      "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": "35a44337-7ef4-47e1-a929-24812ba46a97",
            "type": "people"
          },
          {
            "id": "f9e85bce-71fe-4f09-b217-7b36c9f3392d",
            "type": "people"
          }
        ]
      },
      "anniversaries_this_week": {
        "data": [
          {
            "id": "6736b1f0-0e0e-4ab2-82ad-89156154f5b6",
            "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]=e86ca644-e5ee-438e-9fa0-369863e911ad
Content-Type: application/vnd.api+json

GET /api/v2/contacts/analytics

Parameters

filter: {"account_list_id"=>"e86ca644-e5ee-438e-9fa0-369863e911ad"}

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:04:44Z",
      "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": "27ff5765-503f-4954-bf25-8c994f102dfd",
            "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/565b37b4-9745-47d1-9840-273023910326
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": "565b37b4-9745-47d1-9840-273023910326",
    "type": "duplicate_record_pairs",
    "attributes": {
      "created_at": "2018-10-12T19:04:45Z",
      "ignore": false,
      "reason": "Just testing",
      "updated_at": "2018-10-12T19:04:45Z",
      "updated_in_db_at": "2018-10-12T19:04:45Z"
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "ebb4ab0a-0eab-443c-8940-61439bfe858f",
          "type": "account_lists"
        }
      },
      "records": {
        "data": [
          {
            "id": "e11c7ecf-8396-467c-bdcd-6dd1fe1d1292",
            "type": "contacts"
          },
          {
            "id": "63355546-6f9b-45ba-8372-1ee4d2d9865e",
            "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": "9ffe2e62-1175-4de4-97e1-ba649d66c758",
      "type": "duplicate_record_pairs",
      "attributes": {
        "created_at": "2018-10-12T19:04:45Z",
        "ignore": false,
        "reason": "Just testing",
        "updated_at": "2018-10-12T19:04:45Z",
        "updated_in_db_at": "2018-10-12T19:04:45Z"
      },
      "relationships": {
        "account_list": {
          "data": {
            "id": "58e01370-db0a-4733-8ebd-26db818bd5f0",
            "type": "account_lists"
          }
        },
        "records": {
          "data": [
            {
              "id": "7733b113-ced5-4277-9872-c45fc772f438",
              "type": "contacts"
            },
            {
              "id": "d928228e-e75a-4f4f-98b2-0014ec54d9cc",
              "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/c155bd76-fa5c-404d-aca7-0b1a9c56ea3f
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-13 03:04:45 +0800"
    },
    "relationships": {
      "account_list": {
        "data": {
          "type": "account_lists",
          "id": "b7e701fb-3819-4e1a-b905-fec38dfb7e0e"
        }
      }
    }
  }
}

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": "c155bd76-fa5c-404d-aca7-0b1a9c56ea3f",
    "type": "duplicate_record_pairs",
    "attributes": {
      "created_at": "2018-10-12T19:04:45Z",
      "ignore": true,
      "reason": "Just testing",
      "updated_at": "2018-10-12T19:04:45Z",
      "updated_in_db_at": "2018-10-12T19:04:45Z"
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "b7e701fb-3819-4e1a-b905-fec38dfb7e0e",
          "type": "account_lists"
        }
      },
      "records": {
        "data": [
          {
            "id": "7ab57c31-8219-4800-af5d-a3b909abde1e",
            "type": "contacts"
          },
          {
            "id": "880e65ab-c35b-415b-9d59-46cac149f8f2",
            "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": "935cb5f7-8c68-4dfa-b575-29e628a2cc1a"
  },
  "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/8a85245a-fd5c-44ae-9dbb-a9e55c5389e0
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": "8a85245a-fd5c-44ae-9dbb-a9e55c5389e0",
    "type": "export_logs",
    "attributes": {
      "created_at": "2018-10-12T19:04:46Z",
      "export_at": "2017-07-28T07:19:32Z",
      "params": {
        "filter": {
          "status": "active"
        }
      },
      "type": "Contacts Export",
      "updated_at": "2018-10-12T19:04:46Z",
      "updated_in_db_at": "2018-10-12T19:04:46Z"
    },
    "relationships": {
      "user": {
        "data": {
          "id": "8c4b7cfe-bcf2-4da4-8da3-d1a1a5056a28",
          "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": "f63e7add-0162-404d-8a89-1d7fd2257e0f",
    "type": "export_logs",
    "attributes": {
      "created_at": "2018-10-12T19:04:47Z",
      "export_at": "2018-10-12T19:04:47Z",
      "params": {
        "filter": {
          "status": "active"
        }
      },
      "type": "Contacts",
      "updated_at": "2018-10-12T19:04:47Z",
      "updated_in_db_at": "2018-10-12T19:04:47Z"
    },
    "relationships": {
      "user": {
        "data": {
          "id": "5c7bf50c-32af-4dd1-a3c9-7904f4454703",
          "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": "3181ce8c-a6f5-4a42-bb5c-7225e88a166a"
        }
      },
      "winner": {
        "data": {
          "type": "contacts",
          "id": "918248f8-1e41-46ae-9306-12055bc97925"
        }
      }
    }
  }
}

Name	Type	Description	Required

Response

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

{
  "data": {
    "id": "918248f8-1e41-46ae-9306-12055bc97925",
    "type": "contacts",
    "attributes": {
      "avatar": "https://mpdx.org/images/avatar.png",
      "church_name": null,
      "created_at": "2018-10-12T19:04:47Z",
      "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-08",
      "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:04:47Z",
      "pledge_amount": "100.0",
      "pledge_currency": "USD",
      "pledge_currency_symbol": "$",
      "pledge_frequency": "1",
      "pledge_received": false,
      "pledge_start_date": "2018-09-08",
      "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:04:47Z",
      "updated_in_db_at": "2018-10-12T19:04:47Z",
      "website": "http://abbott.name/ricardo_upton"
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "b0af5855-08a7-4620-bcda-def920797fea",
          "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": "8a65277b-a79f-458b-a231-d66e3273a27f",
          "loser_id": "f090f5d5-281b-412c-b003-f2f892ac84fa"
        }
      }
    }
  ]
}

Name	Type	Description	Required

Response

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

[
  {
    "data": {
      "id": "8a65277b-a79f-458b-a231-d66e3273a27f",
      "type": "contacts",
      "attributes": {
        "avatar": "https://mpdx.org/images/avatar.png",
        "church_name": null,
        "created_at": "2018-10-12T19:04:47Z",
        "deceased": false,
        "direct_deposit": false,
        "envelope_greeting": "America Ebert",
        "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-08",
        "likely_to_give": null,
        "locale": "en",
        "magazine": false,
        "name": "Ebert, America",
        "next_ask": null,
        "no_appeals": null,
        "no_gift_aid": null,
        "notes": "Test Note.\nTest Note.",
        "notes_saved_at": "2018-10-12T19:04:47Z",
        "pledge_amount": "100.0",
        "pledge_currency": "USD",
        "pledge_currency_symbol": "$",
        "pledge_frequency": "1",
        "pledge_received": false,
        "pledge_start_date": "2018-09-08",
        "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:04:47Z",
        "updated_in_db_at": "2018-10-12T19:04:47Z",
        "website": "http://sporer.io/aurore_kuphal"
      },
      "relationships": {
        "account_list": {
          "data": {
            "id": "d7ac99d7-d8a4-481a-b6d4-87f2a21589b9",
            "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/c2af599a-163b-4a0e-9d15-8845bd0a204e/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": "c2af599a-163b-4a0e-9d15-8845bd0a204e",
    "type": "contacts",
    "attributes": {
      "avatar": "https://mpdx.org/images/avatar.png",
      "church_name": null,
      "created_at": "2018-10-12T19:04:59Z",
      "deceased": false,
      "direct_deposit": false,
      "envelope_greeting": "Kody Graham",
      "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-08",
      "likely_to_give": null,
      "locale": "en",
      "magazine": false,
      "name": "Graham, Kody",
      "next_ask": null,
      "no_appeals": null,
      "no_gift_aid": null,
      "notes": "Test Note.",
      "notes_saved_at": "2018-10-12T19:04:59Z",
      "pledge_amount": "100.0",
      "pledge_currency": "USD",
      "pledge_currency_symbol": "$",
      "pledge_frequency": "1",
      "pledge_received": false,
      "pledge_start_date": "2018-09-08",
      "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:04:59Z",
      "updated_in_db_at": "2018-10-12T19:04:59Z",
      "website": "http://howell.io/zachery"
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "ec501487-fc2a-4cdd-9fa7-25c4fafd8144",
          "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/405ae406-4aee-44c7-8673-e27f7ac3bae2/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": "f4c51258-0c70-4ad8-8bde-675dad7b39ec",
      "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": "a202c8c8-47ea-4430-bde4-8f3c30dbb5fd,11ae1c39-aea7-4bf8-832f-c6744a7a85d0"
  }
}

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": "68a95ab5-eb8a-4841-824d-d595d6fd3daa,c62940a9-cf56-4075-8834-50693aca8c71"
  }
}

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": "68a95ab5-eb8a-4841-824d-d595d6fd3daa",
      "type": "contacts",
      "attributes": {
        "avatar": "https://mpdx.org/images/avatar.png",
        "church_name": null,
        "created_at": "2018-10-12T19:04:58Z",
        "deceased": false,
        "direct_deposit": false,
        "envelope_greeting": "Kobe Harris",
        "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-08",
        "likely_to_give": null,
        "locale": "en",
        "magazine": false,
        "name": "Harris, Kobe",
        "next_ask": null,
        "no_appeals": null,
        "no_gift_aid": null,
        "notes": "Test Note.",
        "notes_saved_at": "2018-10-12T19:04:58Z",
        "pledge_amount": "100.0",
        "pledge_currency": "USD",
        "pledge_currency_symbol": "$",
        "pledge_frequency": "1",
        "pledge_received": false,
        "pledge_start_date": "2018-09-08",
        "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:04:58Z",
        "updated_in_db_at": "2018-10-12T19:04:58Z",
        "website": "http://barton.io/ozella"
      },
      "relationships": {
        "account_list": {
          "data": {
            "id": "50be5c75-d94a-4b55-89e3-9b4bebd98515",
            "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": "c62940a9-cf56-4075-8834-50693aca8c71",
      "type": "contacts",
      "attributes": {
        "avatar": "https://mpdx.org/images/avatar.png",
        "church_name": null,
        "created_at": "2018-10-12T19:04:58Z",
        "deceased": false,
        "direct_deposit": false,
        "envelope_greeting": "Trey Boehm",
        "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-08",
        "likely_to_give": null,
        "locale": "en",
        "magazine": false,
        "name": "Boehm, Trey",
        "next_ask": null,
        "no_appeals": null,
        "no_gift_aid": null,
        "notes": "Test Note.",
        "notes_saved_at": "2018-10-12T19:04:58Z",
        "pledge_amount": "100.0",
        "pledge_currency": "USD",
        "pledge_currency_symbol": "$",
        "pledge_frequency": "1",
        "pledge_received": false,
        "pledge_start_date": "2018-09-08",
        "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:04:58Z",
        "updated_in_db_at": "2018-10-12T19:04:58Z",
        "website": "http://luettgenbashirian.info/delpha"
      },
      "relationships": {
        "account_list": {
          "data": {
            "id": "50be5c75-d94a-4b55-89e3-9b4bebd98515",
            "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/5479da3e-c35e-4996-84e9-a51f6853c255
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": "5479da3e-c35e-4996-84e9-a51f6853c255",
    "type": "duplicate_record_pairs",
    "attributes": {
      "created_at": "2018-10-12T19:04:48Z",
      "ignore": false,
      "reason": "Just testing",
      "updated_at": "2018-10-12T19:04:48Z",
      "updated_in_db_at": "2018-10-12T19:04:48Z"
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "e2b80e26-48ff-4f87-b7a0-24e64ec782e4",
          "type": "account_lists"
        }
      },
      "records": {
        "data": [
          {
            "id": "46937833-8a59-49b9-aae3-cd457cb07940",
            "type": "people"
          },
          {
            "id": "63e5823b-f847-4a84-9117-2b627814d06f",
            "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": "c276ae5b-6086-4e1e-9ef2-7c30374b621b",
      "type": "duplicate_record_pairs",
      "attributes": {
        "created_at": "2018-10-12T19:04:48Z",
        "ignore": false,
        "reason": "Just testing",
        "updated_at": "2018-10-12T19:04:48Z",
        "updated_in_db_at": "2018-10-12T19:04:48Z"
      },
      "relationships": {
        "account_list": {
          "data": {
            "id": "020c0b47-02b6-4c3b-889a-5b98c64c88c3",
            "type": "account_lists"
          }
        },
        "records": {
          "data": [
            {
              "id": "842bc48a-f96d-4028-96fe-cf7d9e79758a",
              "type": "people"
            },
            {
              "id": "d9056986-3665-473c-893e-aa507fb6c6ae",
              "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/b6744fde-239f-4e45-adb3-a3f891ba6205
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-13 03:04:48 +0800"
    },
    "relationships": {
      "account_list": {
        "data": {
          "type": "account_lists",
          "id": "30a3877f-112f-43fb-a22b-570e4b31235d"
        }
      }
    }
  }
}

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": "b6744fde-239f-4e45-adb3-a3f891ba6205",
    "type": "duplicate_record_pairs",
    "attributes": {
      "created_at": "2018-10-12T19:04:48Z",
      "ignore": true,
      "reason": "Just testing",
      "updated_at": "2018-10-12T19:04:48Z",
      "updated_in_db_at": "2018-10-12T19:04:48Z"
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "30a3877f-112f-43fb-a22b-570e4b31235d",
          "type": "account_lists"
        }
      },
      "records": {
        "data": [
          {
            "id": "0f4f26b5-7f62-4fbf-ad2f-23721ad9f8df",
            "type": "people"
          },
          {
            "id": "5ad15552-bd6d-498d-a3c6-7947d73b5b73",
            "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/7fdbe259-0191-4141-8c47-462c235e047e/people/da44b3ee-1643-4724-add3-48133df44d38/email_addresses/b379cb44-b539-435e-9ac4-b9916871b056
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/0e303cbc-436c-4c72-87f8-0332a1c3593f/people/a64c6ea8-b7cf-46a8-b4b6-c5d9843a1e91/email_addresses/b15f7e2c-9fe4-48f8-8ff9-21673931a58a
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": "b15f7e2c-9fe4-48f8-8ff9-21673931a58a",
    "type": "email_addresses",
    "attributes": {
      "created_at": "2018-10-12T19:04:49Z",
      "email": "foo-11@example.com",
      "historic": false,
      "location": "home",
      "primary": true,
      "source": "MPDX",
      "updated_at": "2018-10-12T19:04:49Z",
      "updated_in_db_at": "2018-10-12T19:04:49Z",
      "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/b9328b05-2837-4246-8534-1ad89be9b068/people/77825678-93b3-4c8d-830b-cfa9576c0caa/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": "f44ef472-4309-414e-bdf8-e0a6c73fea48",
      "type": "email_addresses",
      "attributes": {
        "created_at": "2018-10-12T19:04:49Z",
        "email": "foo-10@example.com",
        "historic": false,
        "location": "home",
        "primary": true,
        "source": "MPDX",
        "updated_at": "2018-10-12T19:04:49Z",
        "updated_in_db_at": "2018-10-12T19:04:49Z",
        "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/be2eb634-7b4c-4709-ad33-1538bc116a6d/people/be778fd2-d325-466d-9560-f3bcc64e4167/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-13 03:04:49 +0800"
    }
  }
}

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": "1598f324-db16-436d-92b4-41ea8ec60167",
    "type": "email_addresses",
    "attributes": {
      "created_at": "2018-10-12T19:04:49Z",
      "email": "foo-13@example.com",
      "historic": false,
      "location": "home",
      "primary": false,
      "source": "MPDX",
      "updated_at": "2018-10-12T19:04:49Z",
      "updated_in_db_at": "2018-10-12T19:04:49Z",
      "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/38313671-7004-4f72-b473-199054816659/people/a7b9348d-84e4-4944-9770-78fce67fba3b/email_addresses/6ee203cf-1361-4dba-8b36-691e42f3955a
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-13 03:04:49 +0800",
      "deleted": false,
      "email": "new-email@example.com",
      "historic": false,
      "location": "home",
      "primary": false,
      "source": "MPDX",
      "updated_at": "2018-10-13 03:04:49 +0800",
      "updated_in_db_at": "2018-10-13 03:04:49 +0800",
      "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": "6ee203cf-1361-4dba-8b36-691e42f3955a",
    "type": "email_addresses",
    "attributes": {
      "created_at": "2018-10-12T19:04:49Z",
      "email": "new-email@example.com",
      "historic": false,
      "location": "home",
      "primary": false,
      "source": "MPDX",
      "updated_at": "2018-10-12T19:04:49Z",
      "updated_in_db_at": "2018-10-12T19:04:49Z",
      "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/025b6f30-23ff-4b6d-8b3d-cb89692ee6cd/people/3b88ce81-588c-498f-ae28-d9eb72f86b2a/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": "Ian",
      "last_name": "Dietrich",
      "token": "TokenString",
      "token_expires_at": "2018-10-14 03:04:50 +0800",
      "updated_in_db_at": "2018-10-13 03:04:50 +0800",
      "username": "ian_dietrich"
    }
  }
}

Name	Type	Description	Required

Response

Content-Type: application/vnd.api+json; charset=utf-8
201 Created

{
  "data": {
    "id": "9189e38d-55d1-43a6-9768-ada63f7b2923",
    "type": "facebook_accounts",
    "attributes": {
      "created_at": "2018-10-12T19:04:50Z",
      "first_name": "Ian",
      "last_name": "Dietrich",
      "remote_id": null,
      "updated_at": "2018-10-12T19:04:50Z",
      "updated_in_db_at": "2018-10-12T19:04:50Z",
      "username": "ian_dietrich"
    }
  }
}

Facebook Account [DELETE]

Delete the Person’s Facebook Account with the given ID

Request

Endpoint

DELETE /api/v2/contacts/44932910-3f9b-4546-b0b8-00c9a74316ba/people/1b8ae583-e23b-43d9-8c52-f517610f32e2/facebook_accounts/134c78d3-5450-41b7-9cde-0a9a4dbdabc1
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/d63cfa17-5838-4bfe-9140-084d9bf90f8d/people/a5cc5d1f-e66e-48b7-9657-5115c003ff84/facebook_accounts/74112674-3f24-4fa1-9505-bb0904ced8ff
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": "74112674-3f24-4fa1-9505-bb0904ced8ff",
    "type": "facebook_accounts",
    "attributes": {
      "created_at": "2018-10-12T19:04:50Z",
      "first_name": "Linda",
      "last_name": "Stehr",
      "remote_id": 6,
      "updated_at": "2018-10-12T19:04:50Z",
      "updated_in_db_at": "2018-10-12T19:04:50Z",
      "username": "stehr.linda"
    }
  }
}

Fields

Name	Type	Description

Facebook Account [LIST]

List of Facebook Accounts associated to the Person

Request

Endpoint

GET /api/v2/contacts/6554f663-6f6b-4d9d-a0fb-84437fb1b5ce/people/d6fe4ab3-871d-446c-927c-a248ba83c7bb/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": "342fc2df-b579-49fe-b560-1ef0ea044208",
      "type": "facebook_accounts",
      "attributes": {
        "created_at": "2018-10-12T19:04:50Z",
        "first_name": "Tomas",
        "last_name": "Hermiston",
        "remote_id": 4,
        "updated_at": "2018-10-12T19:04:50Z",
        "updated_in_db_at": "2018-10-12T19:04:50Z",
        "username": "tomas.hermiston"
      }
    },
    {
      "id": "f2aa27f2-94ef-49db-948c-1aaac7e24c17",
      "type": "facebook_accounts",
      "attributes": {
        "created_at": "2018-10-12T19:04:50Z",
        "first_name": "Korey",
        "last_name": "Wisozk",
        "remote_id": 5,
        "updated_at": "2018-10-12T19:04:50Z",
        "updated_in_db_at": "2018-10-12T19:04:50Z",
        "username": "wisozk_korey"
      }
    }
  ],
  "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/3ee9646a-97ca-416a-a14f-71dabe8f75b3/people/af8e4695-0c5e-4ccf-a719-65d1e845f86a/facebook_accounts/9e579a4d-34e3-4333-8e1f-b31c64e4d0a9
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": "Lauretta",
      "last_name": "Herman",
      "token": "TokenString",
      "token_expires_at": "2018-10-14 03:04:50 +0800",
      "updated_in_db_at": "2018-10-13 03:04:50 +0800",
      "username": "herman.lauretta"
    }
  }
}

Name	Type	Description	Required

Response

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

{
  "data": {
    "id": "9e579a4d-34e3-4333-8e1f-b31c64e4d0a9",
    "type": "facebook_accounts",
    "attributes": {
      "created_at": "2018-10-12T19:04:50Z",
      "first_name": "Lauretta",
      "last_name": "Herman",
      "remote_id": 11,
      "updated_at": "2018-10-12T19:04:50Z",
      "updated_in_db_at": "2018-10-12T19:04:50Z",
      "username": "herman.lauretta"
    }
  }
}

Linkedin Accounts

Linkedin Account [DELETE]

Linkedin Account [DELETE]

Request

Endpoint

DELETE /api/v2/contacts/64afe6d6-fe3f-4f39-8285-e8dbfb0c2711/people/105d1f40-85ba-4088-98d1-bd5cb3a41eb8/linkedin_accounts/a420f80f-f571-4164-b1c3-70f580319101
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/5657c432-d0a9-4c08-925b-07edd1a45eb6/people/a98b0224-eeb0-4282-a2a3-1e76346288ad/linkedin_accounts/0941330b-6290-47e1-aaa9-93624b0de0f3
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": "0941330b-6290-47e1-aaa9-93624b0de0f3",
    "type": "linkedin_accounts",
    "attributes": {
      "created_at": "2018-10-12T19:04:51Z",
      "public_url": "http://example.com/username1",
      "updated_at": "2018-10-12T19:04:51Z",
      "updated_in_db_at": "2018-10-12T19:04:51Z"
    }
  }
}

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/08416c63-721f-4883-ba87-553a64776df4/people/1a0d5ea4-82dc-408f-bf52-2e63689de645/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": "9e391cf7-6800-47fd-a868-07753e1abdfb",
      "type": "linkedin_accounts",
      "attributes": {
        "created_at": "2018-10-12T19:04:50Z",
        "public_url": "http://example.com/username1",
        "updated_at": "2018-10-12T19:04:50Z",
        "updated_in_db_at": "2018-10-12T19:04:50Z"
      }
    },
    {
      "id": "54b13be6-b8cd-4693-b5a8-cd473db09f3a",
      "type": "linkedin_accounts",
      "attributes": {
        "created_at": "2018-10-12T19:04:50Z",
        "public_url": "http://example.com/username1",
        "updated_at": "2018-10-12T19:04:50Z",
        "updated_in_db_at": "2018-10-12T19:04:50Z"
      }
    }
  ],
  "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/b7788525-cbd7-4827-b05e-8610f5ef309c/people/974136b9-c11a-4931-b183-d57e0a05a41e/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-13 03:04:51 +0800"
    }
  }
}

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": "fa4a7ef2-7a72-468f-836f-ba35a1d280c2",
    "type": "linkedin_accounts",
    "attributes": {
      "created_at": "2018-10-12T19:04:51Z",
      "public_url": "http://example.com/username1",
      "updated_at": "2018-10-12T19:04:51Z",
      "updated_in_db_at": "2018-10-12T19:04:51Z"
    }
  }
}

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/3067000e-1553-4a83-9108-f6b7b768e551/people/1a89bfec-8819-4e2d-b86f-b5767c8aab7e/linkedin_accounts/b6cf9cc7-64fd-40db-a168-4a2f2d001376
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-13 03:04:51 +0800"
    }
  }
}

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": "b6cf9cc7-64fd-40db-a168-4a2f2d001376",
    "type": "linkedin_accounts",
    "attributes": {
      "created_at": "2018-10-12T19:04:51Z",
      "public_url": "http://example.com/username1",
      "updated_at": "2018-10-12T19:04:51Z",
      "updated_in_db_at": "2018-10-12T19:04:51Z"
    }
  }
}

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": "2f7638e0-83a4-4105-b021-0b65e384ba79",
          "loser_id": "690da47c-031a-4805-898b-e30f1df32909"
        }
      }
    }
  ]
}

Name	Type	Description	Required

Response

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

[
  {
    "data": {
      "id": "2f7638e0-83a4-4105-b021-0b65e384ba79",
      "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:04:51Z",
        "deceased": false,
        "employer": null,
        "first_name": "Travon",
        "gender": null,
        "last_name": "Walter",
        "legal_first_name": null,
        "marital_status": null,
        "middle_name": null,
        "occupation": null,
        "optout_enewsletter": false,
        "parent_contacts": [
          "3ca720a4-ddf3-4ca1-95af-58aba3facc70"
        ],
        "suffix": null,
        "title": null,
        "updated_at": "2018-10-12T19:04:51Z",
        "updated_in_db_at": "2018-10-12T19:04:51Z"
      },
      "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/f8049043-4f47-45d2-8a84-9f5f7f570c6a/people/ca610cbb-a89e-4f4c-b5a0-1f48b54bc605/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-13 03:04:52 +0800",
      "valid_values": true
    }
  }
}

Name	Type	Description	Required

Response

Content-Type: application/vnd.api+json; charset=utf-8
201 Created

{
  "data": {
    "id": "a8128870-3539-418e-9198-9422f5f6df94",
    "type": "phone_numbers",
    "attributes": {
      "country_code": "1",
      "created_at": "2018-10-12T19:04:52Z",
      "historic": false,
      "location": "mobile",
      "number": "3561987123",
      "primary": false,
      "source": "MPDX",
      "updated_at": "2018-10-12T19:04:52Z",
      "updated_in_db_at": "2018-10-12T19:04:52Z",
      "valid_values": true
    }
  }
}

Phone [DELETE]

Delete Person’s Phone Number with the given ID

Request

Endpoint

DELETE /api/v2/contacts/060a1a85-f47f-4c3d-9ecb-549e406cedb4/people/b7b7a000-0c0b-49d1-bd30-c04a5ad8bb6e/phones/32126a8c-f961-4657-a9ef-a5152db473d2
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/243d70a6-f8ab-4b7e-b55e-8789ccd02e65/people/9b230c55-0b59-4e42-8a65-b4a525f73554/phones/6bf58fae-ea7d-4a3b-bd69-6522fc9dcab5
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": "6bf58fae-ea7d-4a3b-bd69-6522fc9dcab5",
    "type": "phone_numbers",
    "attributes": {
      "country_code": "1",
      "created_at": "2018-10-12T19:04:52Z",
      "historic": false,
      "location": "mobile",
      "number": "(213) 456-7890",
      "primary": true,
      "source": "MPDX",
      "updated_at": "2018-10-12T19:04:52Z",
      "updated_in_db_at": "2018-10-12T19:04:52Z",
      "valid_values": true
    }
  }
}

Fields

Name	Type	Description

Phone [LIST]

List of Phone Numbers associated to the Person

Request

Endpoint

GET /api/v2/contacts/b370fe61-e566-445b-a0f1-488ec75251cd/people/1dcf5be0-944a-4eff-87da-273e0f1025e5/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": "70dbe95d-2ac7-4b34-a61a-513be79e8079",
      "type": "phone_numbers",
      "attributes": {
        "country_code": "1",
        "created_at": "2018-10-12T19:04:52Z",
        "historic": false,
        "location": "mobile",
        "number": "(213) 456-7890",
        "primary": true,
        "source": "MPDX",
        "updated_at": "2018-10-12T19:04:52Z",
        "updated_in_db_at": "2018-10-12T19:04:52Z",
        "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/a57a68bb-7c33-45c4-8147-33d697903d7e/people/262b5346-3810-4321-a543-fd0d833370b8/phones/4fd72d2a-c65c-45b6-aa0d-6afb484df810
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-13 03:04:52 +0800",
      "valid_values": true
    }
  }
}

Name	Type	Description	Required

Response

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

{
  "data": {
    "id": "4fd72d2a-c65c-45b6-aa0d-6afb484df810",
    "type": "phone_numbers",
    "attributes": {
      "country_code": "1",
      "created_at": "2018-10-12T19:04:52Z",
      "historic": false,
      "location": "mobile",
      "number": "3561987123",
      "primary": false,
      "source": "MPDX",
      "updated_at": "2018-10-12T19:04:52Z",
      "updated_in_db_at": "2018-10-12T19:04:52Z",
      "valid_values": true
    }
  }
}

Relationships

Relationship [CREATE]

Create a Relationship associated with the Person

Request

Endpoint

POST /api/v2/contacts/04e28ef8-6abe-42a3-8fd8-f72808f7c5f3/people/6a56ec9f-2beb-43e9-ac5a-2849e101be81/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": "6a56ec9f-2beb-43e9-ac5a-2849e101be81"
        }
      },
      "related_person": {
        "data": {
          "type": "people",
          "id": "82fce0da-8987-45c8-adc2-8476abd19eab"
        }
      }
    }
  }
}

Name	Type	Description	Required

Response

Content-Type: application/vnd.api+json; charset=utf-8
201 Created

{
  "data": {
    "id": "857bc5c6-edfb-41bd-beb7-8220fb362216",
    "type": "family_relationships",
    "attributes": {
      "created_at": "2018-10-12T19:04:53Z",
      "relationship": "MyString",
      "updated_at": "2018-10-12T19:04:53Z",
      "updated_in_db_at": "2018-10-12T19:04:53Z"
    },
    "relationships": {
      "related_person": {
        "data": {
          "id": "82fce0da-8987-45c8-adc2-8476abd19eab",
          "type": "people"
        }
      }
    }
  }
}

Relationship [DELETE]

Delete the Person’s Relationship with the given ID

Request

Endpoint

DELETE /api/v2/contacts/367332a6-860b-46f7-9a87-8a4133b31113/people/d3073c0a-4efd-405f-b12f-420d4cc8fcdd/relationships/63e43e79-a58e-4ccf-b3dc-d7af2923564f
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/79269b60-5956-464d-bcfd-1f840683fac6/people/8aecba7b-67ff-4753-ba5a-0487449d4d3c/relationships/aac7f915-548d-48c2-a052-57d112b24f25
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": "aac7f915-548d-48c2-a052-57d112b24f25",
    "type": "family_relationships",
    "attributes": {
      "created_at": "2018-10-12T19:04:53Z",
      "relationship": "MyString",
      "updated_at": "2018-10-12T19:04:53Z",
      "updated_in_db_at": "2018-10-12T19:04:53Z"
    },
    "relationships": {
      "related_person": {
        "data": {
          "id": "e4eb1a0f-c0a9-4ad2-8d67-433a1d2b506c",
          "type": "people"
        }
      }
    }
  }
}

Fields

Name	Type	Description

Relationship [LIST]

List of Relationships associated to the Person

Request

Endpoint

GET /api/v2/contacts/72d92695-5c70-41a7-96a1-06a562673fb1/people/db6fefc1-9775-4601-acdc-0e6e180e98df/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": "5b4710ff-f187-4cca-a1e5-aa9737de4532",
      "type": "family_relationships",
      "attributes": {
        "created_at": "2018-10-12T19:04:53Z",
        "relationship": "MyString",
        "updated_at": "2018-10-12T19:04:53Z",
        "updated_in_db_at": "2018-10-12T19:04:53Z"
      },
      "relationships": {
        "related_person": {
          "data": {
            "id": "0344c117-70e6-47b6-ab58-879a194e09f2",
            "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/f5741160-598f-432b-ab30-f4d79e81a311/people/ec5eb67a-9010-4d0d-9c03-e7371ee4bec0/relationships/ff430fe0-66bd-47e5-97c0-8160de146580
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": "ec5eb67a-9010-4d0d-9c03-e7371ee4bec0"
        }
      },
      "related_person": {
        "data": {
          "type": "people",
          "id": "dfd7cf7e-b324-47be-bff6-149106458cf5"
        }
      }
    }
  }
}

Name	Type	Description	Required

Response

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

{
  "data": {
    "id": "ff430fe0-66bd-47e5-97c0-8160de146580",
    "type": "family_relationships",
    "attributes": {
      "created_at": "2018-10-12T19:04:53Z",
      "relationship": "MyString",
      "updated_at": "2018-10-12T19:04:53Z",
      "updated_in_db_at": "2018-10-12T19:04:53Z"
    },
    "relationships": {
      "related_person": {
        "data": {
          "id": "dfd7cf7e-b324-47be-bff6-149106458cf5",
          "type": "people"
        }
      }
    }
  }
}

Twitter Accounts

Twitter Account [DELETE]

Twitter Account [DELETE]

Request

Endpoint

DELETE /api/v2/contacts/506a5e8a-905a-4a53-8f90-d5de0aafcaa5/people/101aa347-950f-40c5-988a-0ea34b7475c4/twitter_accounts/27af1617-bf3a-43bd-bfd0-b4d975e4b421
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/1af8a6df-b98f-457b-ba0d-78ffc9b61814/people/274d6098-f80c-4dcd-b179-0870a2c64800/twitter_accounts/475ee9ac-ddf8-4701-a2e6-1b9ff1a741fc
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": "475ee9ac-ddf8-4701-a2e6-1b9ff1a741fc",
    "type": "twitter_accounts",
    "attributes": {
      "created_at": "2018-10-12T19:04:54Z",
      "primary": false,
      "remote_id": 3,
      "screen_name": "randi",
      "updated_at": "2018-10-12T19:04:54Z",
      "updated_in_db_at": "2018-10-12T19:04:54Z"
    }
  }
}

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/dab169e0-a242-4600-81fc-b1f6b6d42c0a/people/f7b0a7d6-689f-48bd-8cd3-8f54d0f75e11/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": "1c768873-5087-49b0-b5c0-aef9583a0b70",
      "type": "twitter_accounts",
      "attributes": {
        "created_at": "2018-10-12T19:04:54Z",
        "primary": false,
        "remote_id": 1,
        "screen_name": "sigrid",
        "updated_at": "2018-10-12T19:04:54Z",
        "updated_in_db_at": "2018-10-12T19:04:54Z"
      }
    },
    {
      "id": "16ff02e8-71a1-4f72-8934-455369ae1f6b",
      "type": "twitter_accounts",
      "attributes": {
        "created_at": "2018-10-12T19:04:54Z",
        "primary": false,
        "remote_id": 2,
        "screen_name": "mustafa.beier",
        "updated_at": "2018-10-12T19:04:54Z",
        "updated_in_db_at": "2018-10-12T19:04:54Z"
      }
    }
  ],
  "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/e20b14e3-efe1-43c0-96f3-dbb4e09f7e8f/people/3a8536e9-cbf8-485b-83ba-3f3270379946/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": "marcos",
      "updated_in_db_at": "2018-10-13 03:04:54 +0800"
    }
  }
}

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": "0deb9e60-4490-4783-b712-1a8d3d0406b9",
    "type": "twitter_accounts",
    "attributes": {
      "created_at": "2018-10-12T19:04:54Z",
      "primary": false,
      "remote_id": null,
      "screen_name": "marcos",
      "updated_at": "2018-10-12T19:04:54Z",
      "updated_in_db_at": "2018-10-12T19:04:54Z"
    }
  }
}

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/8a744513-f428-4ffc-96f2-d22e5799f32b/people/2575a4fa-496d-4f13-8c29-8597e76acc8e/twitter_accounts/86de75ad-775f-4a24-a4c3-8148ad28955e
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": "dan.wunsch",
      "updated_in_db_at": "2018-10-13 03:04:54 +0800"
    }
  }
}

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": "86de75ad-775f-4a24-a4c3-8148ad28955e",
    "type": "twitter_accounts",
    "attributes": {
      "created_at": "2018-10-12T19:04:54Z",
      "primary": false,
      "remote_id": 8,
      "screen_name": "dan.wunsch",
      "updated_at": "2018-10-12T19:04:54Z",
      "updated_in_db_at": "2018-10-12T19:04:54Z"
    }
  }
}

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/40134ac4-4c80-4d30-9ae7-2d749dfd2f46/people/758078b3-922f-4356-93f9-25d2d6101b18/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-13 03:04:55 +0800",
      "url": "http://wisozk.info/ernie.wyman"
    }
  }
}

Name	Type	Description	Required

Response

Content-Type: application/vnd.api+json; charset=utf-8
201 Created

{
  "data": {
    "id": "2962a549-e0f1-4825-b889-83fdbbb923f0",
    "type": "websites",
    "attributes": {
      "created_at": "2018-10-12T19:04:55Z",
      "primary": false,
      "updated_at": "2018-10-12T19:04:55Z",
      "updated_in_db_at": "2018-10-12T19:04:55Z",
      "url": "http://wisozk.info/ernie.wyman"
    }
  }
}

Website [DELETE]

Delete the Person’s Website with the given ID

Request

Endpoint

DELETE /api/v2/contacts/5f16c50c-ca95-44d1-b478-9544a0ee365b/people/50cb8333-2c90-4b0a-bc49-aac1dae99159/websites/82437177-c157-431b-8f8b-8d0dc4ccda1b
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/7c321dbe-4954-4149-ba7b-be2dd5b191bb/people/8a606f05-06ac-4b19-91a0-796a3275dab1/websites/97c93bec-af62-4431-90b1-0a8e6fe70150
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": "97c93bec-af62-4431-90b1-0a8e6fe70150",
    "type": "websites",
    "attributes": {
      "created_at": "2018-10-12T19:04:55Z",
      "primary": true,
      "updated_at": "2018-10-12T19:04:55Z",
      "updated_in_db_at": "2018-10-12T19:04:55Z",
      "url": "http://simonisfarrell.net/cindy_emard"
    }
  }
}

Fields

Name	Type	Description

Website [LIST]

List of Websites associated to the Person

Request

Endpoint

GET /api/v2/contacts/0125a407-10d3-42b1-b4c7-8441fd10019d/people/b9982f75-0a41-445d-8e0e-f23a0747bf8f/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": "066db14e-fdb5-44c1-af42-6884cd750d55",
      "type": "websites",
      "attributes": {
        "created_at": "2018-10-12T19:04:54Z",
        "primary": true,
        "updated_at": "2018-10-12T19:04:54Z",
        "updated_in_db_at": "2018-10-12T19:04:54Z",
        "url": "http://walsh.biz/jaquelin"
      }
    },
    {
      "id": "94659199-551b-4bfb-ac67-b3ef15fa1438",
      "type": "websites",
      "attributes": {
        "created_at": "2018-10-12T19:04:54Z",
        "primary": true,
        "updated_at": "2018-10-12T19:04:54Z",
        "updated_in_db_at": "2018-10-12T19:04:54Z",
        "url": "http://mrazconroy.biz/melba_lubowitz"
      }
    }
  ],
  "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/0142639c-2ee3-4d4b-a5a1-1f809960c7d8/people/5dcc969f-1e5f-41de-b299-7de8d3e5ecdd/websites/a1469007-2917-42cc-b358-e49c8140cff1
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-13 03:04:55 +0800",
      "url": "http://schoen.com/lisandro"
    }
  }
}

Name	Type	Description	Required

Response

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

{
  "data": {
    "id": "a1469007-2917-42cc-b358-e49c8140cff1",
    "type": "websites",
    "attributes": {
      "created_at": "2018-10-12T19:04:55Z",
      "primary": true,
      "updated_at": "2018-10-12T19:04:55Z",
      "updated_in_db_at": "2018-10-12T19:04:55Z",
      "url": "http://schoen.com/lisandro"
    }
  }
}

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-07",
      "type": "reports_appointment_results_periods",
      "attributes": {
        "created_at": "2018-10-12T19:05:01Z",
        "end_date": "2018-10-13T15: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-06T16: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-30",
      "type": "reports_appointment_results_periods",
      "attributes": {
        "created_at": "2018-10-12T19:05:01Z",
        "end_date": "2018-10-06T15: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-29T16: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-23",
      "type": "reports_appointment_results_periods",
      "attributes": {
        "created_at": "2018-10-12T19:05:01Z",
        "end_date": "2018-09-29T15: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-22T16: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-16",
      "type": "reports_appointment_results_periods",
      "attributes": {
        "created_at": "2018-10-12T19:05:01Z",
        "end_date": "2018-09-22T15: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-15T16: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]=55d93600-8f07-464d-b92e-c9ceac907803&filter[month_range]=2018-06-13+03%3A05%3A01+%2B0800..2018-08-13+03%3A05%3A01+%2B0800
Content-Type: application/vnd.api+json

GET /api/v2/reports/donation_monthly_totals

Parameters

filter: {"account_list_id"=>"55d93600-8f07-464d-b92e-c9ceac907803", "month_range"=>"2018-06-13 03:05:01 +0800..2018-08-13 03:05:01 +0800"}

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:05:01Z",
      "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]=183df43d-5c63-44e3-a5e9-827b638a8b1d
Content-Type: application/vnd.api+json

GET /api/v2/reports/donor_currency_donations

Parameters

filter: {"account_list_id"=>"183df43d-5c63-44e3-a5e9-827b638a8b1d"}

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:05:01Z",
      "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": "183df43d-5c63-44e3-a5e9-827b638a8b1d",
          "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]=c6f2c7d0-55db-40cf-b7b1-cfa8f58a351f
Content-Type: application/vnd.api+json

GET /api/v2/reports/salary_currency_donations

Parameters

filter: {"account_list_id"=>"c6f2c7d0-55db-40cf-b7b1-cfa8f58a351f"}

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:05:02Z",
      "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": "c6f2c7d0-55db-40cf-b7b1-cfa8f58a351f",
          "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]=c485b469-7811-478a-b305-2b147c29bb12
Content-Type: application/vnd.api+json

GET /api/v2/reports/year_donations

Parameters

filter: {"account_list_id"=>"c485b469-7811-478a-b305-2b147c29bb12"}

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:05:02Z",
      "donation_infos": [

      ],
      "donor_infos": [

      ],
      "updated_at": null,
      "updated_in_db_at": null
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "c485b469-7811-478a-b305-2b147c29bb12",
          "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]=ff1dcf90-78a8-453f-b923-6090dfbe2ced
Content-Type: application/vnd.api+json

GET /api/v2/reports/goal_progress

Parameters

filter: {"account_list_id"=>"ff1dcf90-78a8-453f-b923-6090dfbe2ced"}

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:05:01Z",
      "in_hand_percent": null,
      "monthly_goal": null,
      "pledged_percent": null,
      "received_pledges": 0,
      "salary_balance": 0,
      "salary_currency_or_default": "USD",
      "salary_organization_id": "4a594bd7-e0fd-4466-b413-c610069a586e",
      "total_pledges": 0,
      "updated_at": null,
      "updated_in_db_at": null
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "ff1dcf90-78a8-453f-b923-6090dfbe2ced",
          "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]=9f1700a9-e67a-4c76-b37b-45fd5b706bfc
Content-Type: application/vnd.api+json

GET /api/v2/reports/monthly_giving_graph

Parameters

filter: {"account_list_id"=>"9f1700a9-e67a-4c76-b37b-45fd5b706bfc"}

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:05:02Z",
      "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": "9f1700a9-e67a-4c76-b37b-45fd5b706bfc",
          "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]=2af42f07-45f2-4efc-9412-da829da317b7
Content-Type: application/vnd.api+json

GET /api/v2/reports/expected_monthly_totals

Parameters

filter: {"account_list_id"=>"2af42f07-45f2-4efc-9412-da829da317b7"}

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:05:01Z",
      "expected_donations": [

      ],
      "total_currency": "USD",
      "total_currency_symbol": "$",
      "updated_at": null,
      "updated_in_db_at": null
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "2af42f07-45f2-4efc-9412-da829da317b7",
          "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:05:02Z",
      "last_electronic_newsletter_completed_at": "2018-10-11T19:05:02Z",
      "last_physical_newsletter_completed_at": "2018-10-11T19:05:02Z",
      "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]=f7f7637e-e687-4eff-9852-69d28b041d75
Content-Type: application/vnd.api+json

GET /api/v2/tasks/analytics

Parameters

filter: {"account_list_id"=>"f7f7637e-e687-4eff-9852-69d28b041d75"}

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:05:03Z",
      "last_electronic_newsletter_completed_at": "2018-10-10T19:05:03Z",
      "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/02ab7270-fb2c-4bcf-82b3-8fb619145d9c/comments
Content-Type: application/vnd.api+json

POST /api/v2/tasks/:task_id/comments

Parameters

{
  "data": {
    "relationships": {
      "person": "Dach Pablo",
      "person": {
        "data": {
          "type": "people",
          "id": "f3d678f9-a8fb-45fb-9844-f0dd85f02f9e"
        }
      }
    },
    "type": "comments",
    "attributes": {
      "body": "MyText",
      "updated_in_db_at": "2018-10-13 03:05:03 +0800"
    }
  }
}

Name	Type	Description	Required

Response

Content-Type: application/vnd.api+json; charset=utf-8
201 Created

{
  "data": {
    "id": "29838861-b2e0-467b-8624-8b4266dbdb86",
    "type": "comments",
    "attributes": {
      "body": "MyText",
      "created_at": "2018-10-12T19:05:04Z",
      "updated_at": "2018-10-12T19:05:04Z",
      "updated_in_db_at": "2018-10-12T19:05:04Z"
    },
    "relationships": {
      "person": {
        "data": {
          "id": "f3d678f9-a8fb-45fb-9844-f0dd85f02f9e",
          "type": "people"
        }
      }
    }
  }
}

Comment [DELETE]

Delete the Task’s Comment with the given ID

Request

Endpoint

DELETE /api/v2/tasks/5ec8f419-4917-41d7-a05f-01950cc02e0d/comments/393857a6-421d-406f-97d4-558451219bcb
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/27319734-e9ae-4f43-8b92-56a462864abb/comments/6db19740-7f12-4d30-a6dd-dd81e098c965
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": "6db19740-7f12-4d30-a6dd-dd81e098c965",
    "type": "comments",
    "attributes": {
      "body": "MyText",
      "created_at": "2018-10-12T19:05:03Z",
      "updated_at": "2018-10-12T19:05:03Z",
      "updated_in_db_at": "2018-10-12T19:05:03Z"
    },
    "relationships": {
      "person": {
        "data": null
      }
    }
  }
}

Fields

Name	Type	Description

Comment [LIST]

List of Comments associated to the Task

Request

Endpoint

GET /api/v2/tasks/5841a2ae-bb69-488e-aff2-d5083cbab279/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": "fe3259d2-23cb-4f58-a8bf-8de6988bb569",
      "type": "comments",
      "attributes": {
        "body": "MyText",
        "created_at": "2018-10-12T19:05:03Z",
        "updated_at": "2018-10-12T19:05:03Z",
        "updated_in_db_at": "2018-10-12T19:05:03Z"
      },
      "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/35e8a0f3-dad3-4a55-bd00-62360a723fb7/comments/99f51282-f7fb-473d-b81d-e29b0ff06c58
Content-Type: application/vnd.api+json

PUT /api/v2/tasks/:task_id/comments/:id

Parameters

{
  "data": {
    "relationships": {
      "person": "VonRueden Sarah",
      "person": {
        "data": {
          "type": "people",
          "id": "a4c330dc-826b-456c-8060-f5c5e1e6b440"
        }
      }
    },
    "type": "comments",
    "attributes": {
      "body": "MyText",
      "updated_in_db_at": "2018-10-13 03:05:04 +0800"
    }
  }
}

Name	Type	Description	Required

Response

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

{
  "data": {
    "id": "99f51282-f7fb-473d-b81d-e29b0ff06c58",
    "type": "comments",
    "attributes": {
      "body": "MyText",
      "created_at": "2018-10-12T19:05:04Z",
      "updated_at": "2018-10-12T19:05:04Z",
      "updated_in_db_at": "2018-10-12T19:05:04Z"
    },
    "relationships": {
      "person": {
        "data": {
          "id": "a4c330dc-826b-456c-8060-f5c5e1e6b440",
          "type": "people"
        }
      }
    }
  }
}

Filter

Tags

Tag [CREATE]

Create a Tag associated with the Task

Request

Endpoint

POST /api/v2/tasks/1d1e6123-1d7e-4726-b562-a5e25f71b3d3/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": "1d1e6123-1d7e-4726-b562-a5e25f71b3d3",
    "type": "tasks",
    "attributes": {
      "activity_type": "Call",
      "comments_count": 0,
      "completed": false,
      "completed_at": null,
      "created_at": "2018-10-12T19:05:05Z",
      "location": "MyString",
      "next_action": null,
      "notification_time_before": null,
      "notification_time_unit": null,
      "notification_type": null,
      "result": null,
      "starred": false,
      "start_at": "2012-03-08T06:59:46Z",
      "subject": "Call Woodrow Hamill",
      "subject_hidden": false,
      "tag_list": [
        "new_tag"
      ],
      "updated_at": "2018-10-12T19:05:05Z",
      "updated_in_db_at": "2018-10-12T19:05:05Z"
    },
    "relationships": {
      "comments": {
        "data": [

        ]
      },
      "contacts": {
        "data": [

        ]
      },
      "people": {
        "data": [

        ]
      },
      "email_addresses": {
        "data": [

        ]
      },
      "phone_numbers": {
        "data": [

        ]
      },
      "activity_contacts": {
        "data": [

        ]
      },
      "account_list": {
        "data": {
          "id": "789cf4dc-14b1-4af8-8a70-4b86cc1bf8c7",
          "type": "account_lists"
        }
      }
    }
  }
}

Tag [DELETE]

Delete the Task’s Tag with the given name

Request

Endpoint

DELETE /api/v2/tasks/e0c999a9-6024-4567-bb7d-ee48597b1639/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": "0056f88f-f1b0-403c-95fd-59542ebdff76",
      "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": "3c725796-bf10-43a6-9864-da53bead8473, 0a34443a-2bdb-4d07-a994-025131b3fed0"
  }
}

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": "35b056af-e73f-4d30-83e0-2e3ebbeb1179, 9bf8f7e6-773f-4ef8-95a4-c15c8165279a"
  }
}

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": "35b056af-e73f-4d30-83e0-2e3ebbeb1179",
      "type": "tasks",
      "attributes": {
        "activity_type": "Call",
        "comments_count": 0,
        "completed": false,
        "completed_at": null,
        "created_at": "2018-10-12T19:05:04Z",
        "location": "MyString",
        "next_action": null,
        "notification_time_before": null,
        "notification_time_unit": null,
        "notification_type": null,
        "result": null,
        "starred": false,
        "start_at": "2012-03-08T06:59:46Z",
        "subject": "Call Lenny Gulgowski V",
        "subject_hidden": false,
        "tag_list": [
          "tag_two",
          "tag_one"
        ],
        "updated_at": "2018-10-12T19:05:04Z",
        "updated_in_db_at": "2018-10-12T19:05:04Z"
      },
      "relationships": {
        "comments": {
          "data": [

          ]
        },
        "contacts": {
          "data": [

          ]
        },
        "people": {
          "data": [

          ]
        },
        "email_addresses": {
          "data": [

          ]
        },
        "phone_numbers": {
          "data": [

          ]
        },
        "activity_contacts": {
          "data": [

          ]
        },
        "account_list": {
          "data": {
            "id": "c47cc7cf-8832-4752-a870-2c1db9666643",
            "type": "account_lists"
          }
        }
      }
    }
  },
  {
    "data": {
      "id": "9bf8f7e6-773f-4ef8-95a4-c15c8165279a",
      "type": "tasks",
      "attributes": {
        "activity_type": "Call",
        "comments_count": 0,
        "completed": false,
        "completed_at": null,
        "created_at": "2018-10-12T19:05:04Z",
        "location": "MyString",
        "next_action": null,
        "notification_time_before": null,
        "notification_time_unit": null,
        "notification_type": null,
        "result": null,
        "starred": false,
        "start_at": "2012-03-08T06:59:46Z",
        "subject": "Call Mr. Zita Gerlach",
        "subject_hidden": false,
        "tag_list": [
          "tag_two",
          "tag_three",
          "tag_one"
        ],
        "updated_at": "2018-10-12T19:05:04Z",
        "updated_in_db_at": "2018-10-12T19:05:04Z"
      },
      "relationships": {
        "comments": {
          "data": [

          ]
        },
        "contacts": {
          "data": [

          ]
        },
        "people": {
          "data": [

          ]
        },
        "email_addresses": {
          "data": [

          ]
        },
        "phone_numbers": {
          "data": [

          ]
        },
        "activity_contacts": {
          "data": [

          ]
        },
        "account_list": {
          "data": {
            "id": "c47cc7cf-8832-4752-a870-2c1db9666643",
            "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:05:06Z",
      "json_web_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiYTgwMWE1ZWEtNWMzMS00YWExLTlmMWItZDQ2MDFlYWE5NzBiIiwiZXhwIjoxNTQxOTYzMTA2fQ.DMSLv3eMvCiS3RVXkeVGN8MiGWrzpmhHSSm_1mYPyQU",
      "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-13 04:05:09 +0800",
      "refresh_token": "MyString",
      "remote_id": "MyString",
      "token": "MyString",
      "updated_in_db_at": "2018-10-13 03:05:09 +0800",
      "valid_token": true
    },
    "relationships": {
      "person": {
        "data": {
          "type": "people",
          "id": "e4fa9b7a-14b9-43ab-aadb-768aa5f2b8f9"
        }
      }
    }
  }
}

Name	Type	Description	Required

Response

Content-Type: application/vnd.api+json; charset=utf-8
201 Created

{
  "data": {
    "id": "0ff0e075-0e5c-4b73-8059-207a2ae4f499",
    "type": "google_accounts",
    "attributes": {
      "created_at": "2018-10-12T19:05:09Z",
      "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:05:09Z",
      "updated_in_db_at": "2018-10-12T19:05:09Z"
    },
    "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/684918bd-2da2-4bf2-a392-b220f918d275
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/ad7509bd-af55-436d-90e5-1be5a365d762
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": "ad7509bd-af55-436d-90e5-1be5a365d762",
    "type": "google_accounts",
    "attributes": {
      "created_at": "2018-10-12T19:05:08Z",
      "email": "foo15@example.com",
      "expires_at": "2018-10-12T20:05:08Z",
      "last_download": null,
      "last_email_sync": null,
      "primary": false,
      "remote_id": "MyString",
      "token_expired": false,
      "updated_at": "2018-10-12T19:05:08Z",
      "updated_in_db_at": "2018-10-12T19:05:08Z"
    },
    "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": "ffe84cd8-7876-4b93-a650-10e5e32e00ca",
      "type": "google_accounts",
      "attributes": {
        "created_at": "2018-10-12T19:05:08Z",
        "email": "foo14@example.com",
        "expires_at": "2018-10-12T20:05:08Z",
        "last_download": null,
        "last_email_sync": null,
        "primary": false,
        "remote_id": "MyString",
        "token_expired": false,
        "updated_at": "2018-10-12T19:05:08Z",
        "updated_in_db_at": "2018-10-12T19:05:08Z"
      },
      "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/c31e118f-87a8-46b6-a90f-b853507e1375
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-13 04:05:09 +0800",
      "refresh_token": "MyString",
      "remote_id": "MyString",
      "token": "MyString",
      "updated_in_db_at": "2018-10-13 03:05:09 +0800",
      "valid_token": true
    },
    "relationships": {
      "person": {
        "data": {
          "type": "people",
          "id": "d4c0639b-0ac6-461a-ad50-3b305850730e"
        }
      }
    }
  }
}

Name	Type	Description	Required

Response

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

{
  "data": {
    "id": "c31e118f-87a8-46b6-a90f-b853507e1375",
    "type": "google_accounts",
    "attributes": {
      "created_at": "2018-10-12T19:05:09Z",
      "email": "foo19@example.com",
      "expires_at": "2018-10-12T20:05:09Z",
      "last_download": null,
      "last_email_sync": null,
      "primary": false,
      "remote_id": "MyString",
      "token_expired": false,
      "updated_at": "2018-10-12T19:05:09Z",
      "updated_in_db_at": "2018-10-12T19:05:09Z"
    },
    "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": "sydnee.mitchell@greenholt.name",
      "first_name": "Lester",
      "last_name": "Goodwin",
      "remote_id": 232,
      "updated_in_db_at": "2018-10-13 03:05:09 +0800"
    },
    "relationships": {
      "person": {
        "data": {
          "type": "persons",
          "id": "98f45807-27a8-4085-b7d2-e91ebeb0f82d"
        }
      }
    }
  }
}

Name	Type	Description	Required

Response

Content-Type: application/vnd.api+json; charset=utf-8
201 Created

{
  "data": {
    "id": "f0695295-c349-401b-b177-cab0c6ab7440",
    "type": "key_accounts",
    "attributes": {
      "created_at": "2018-10-12T19:05:09Z",
      "email": "sydnee.mitchell@greenholt.name",
      "first_name": "Lester",
      "last_download": null,
      "last_name": "Goodwin",
      "primary": false,
      "remote_id": "232",
      "updated_at": "2018-10-12T19:05:09Z",
      "updated_in_db_at": "2018-10-12T19:05:09Z"
    }
  }
}

Key Account [DELETE]

Delete the current_user’s Key Account with the given ID

Request

Endpoint

DELETE /api/v2/user/key_accounts/dde7534b-c4d6-4485-8e29-931eae702b8f
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/9cc5636a-ef80-4390-8c42-a7715081e18b
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": "9cc5636a-ef80-4390-8c42-a7715081e18b",
    "type": "key_accounts",
    "attributes": {
      "created_at": "2018-10-12T19:05:09Z",
      "email": "virgie.schimmel@kelerrolfson.io",
      "first_name": "Robert",
      "last_download": null,
      "last_name": "Murphy",
      "primary": false,
      "remote_id": "229",
      "updated_at": "2018-10-12T19:05:09Z",
      "updated_in_db_at": "2018-10-12T19:05:09Z"
    }
  }
}

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": "bd9e378d-8873-48e4-8be5-21475d538e43",
      "type": "key_accounts",
      "attributes": {
        "created_at": "2018-10-12T19:05:09Z",
        "email": "braeden@orn.org",
        "first_name": "Zaria",
        "last_download": null,
        "last_name": "Stehr",
        "primary": false,
        "remote_id": "226",
        "updated_at": "2018-10-12T19:05:09Z",
        "updated_in_db_at": "2018-10-12T19:05:09Z"
      }
    },
    {
      "id": "94cfae6b-7bf7-446c-821c-09d50bca32e9",
      "type": "key_accounts",
      "attributes": {
        "created_at": "2018-10-12T19:05:09Z",
        "email": "damon_zemlak@funkpadberg.net",
        "first_name": "Jaiden",
        "last_download": null,
        "last_name": "Heathcote",
        "primary": false,
        "remote_id": "227",
        "updated_at": "2018-10-12T19:05:09Z",
        "updated_in_db_at": "2018-10-12T19:05:09Z"
      }
    }
  ],
  "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/5f17f57f-ce6e-4e44-aa40-f41ac3ba002e
Content-Type: application/vnd.api+json

PUT /api/v2/user/key_accounts/:id

Parameters

{
  "data": {
    "type": "key_accounts",
    "attributes": {
      "email": "lizzie.dubuque@lesch.co",
      "first_name": "Hank",
      "last_name": "Reinger",
      "remote_id": 235,
      "updated_in_db_at": "2018-10-13 03:05:09 +0800"
    },
    "relationships": {
      "person": {
        "data": {
          "type": "persons",
          "id": "5f1ae643-2acd-480b-b1b0-a676ce6131d8"
        }
      }
    }
  }
}

Name	Type	Description	Required

Response

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

{
  "data": {
    "id": "5f17f57f-ce6e-4e44-aa40-f41ac3ba002e",
    "type": "key_accounts",
    "attributes": {
      "created_at": "2018-10-12T19:05:09Z",
      "email": "lizzie.dubuque@lesch.co",
      "first_name": "Hank",
      "last_download": null,
      "last_name": "Reinger",
      "primary": false,
      "remote_id": "235",
      "updated_at": "2018-10-12T19:05:09Z",
      "updated_in_db_at": "2018-10-12T19:05:09Z"
    }
  }
}

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-13 03:05:10 +0800",
      "value": "ugh"
    },
    "type": "user_options"
  }
}

Name	Type	Description	Required

Response

Content-Type: application/vnd.api+json; charset=utf-8
201 Created

{
  "data": {
    "id": "5c1018e6-24b6-4bd7-b3ba-fd04f1364062",
    "type": "user_options",
    "attributes": {
      "created_at": "2018-10-12T19:05:10Z",
      "key": "key_4",
      "updated_at": "2018-10-12T19:05:10Z",
      "updated_in_db_at": "2018-10-12T19:05:10Z",
      "value": "ugh"
    }
  }
}

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": "154a4571-53e5-4985-b2fc-270512d21251",
    "type": "user_options",
    "attributes": {
      "created_at": "2018-10-12T19:05:10Z",
      "key": "key_2",
      "updated_at": "2018-10-12T19:05:10Z",
      "updated_in_db_at": "2018-10-12T19:05:10Z",
      "value": "health"
    }
  }
}

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": "783f9655-55fc-4b3c-bd7a-5bbd04e4e9cc",
      "type": "user_options",
      "attributes": {
        "created_at": "2018-10-12T19:05:09Z",
        "key": "key_1",
        "updated_at": "2018-10-12T19:05:09Z",
        "updated_in_db_at": "2018-10-12T19:05:09Z",
        "value": "VHS"
      }
    }
  ],
  "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-13 03:05:10 +0800",
      "value": "freegan"
    }
  }
}

Name	Type	Description	Required

Response

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

{
  "data": {
    "id": "4968eef7-6a1d-45b7-a91a-d3ea9bb7bb7b",
    "type": "user_options",
    "attributes": {
      "created_at": "2018-10-12T19:05:10Z",
      "key": "key_6",
      "updated_at": "2018-10-12T19:05:10Z",
      "updated_in_db_at": "2018-10-12T19:05:10Z",
      "value": "freegan"
    }
  }
}

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-13 03:05:10 +0800",
      "username": "foo",
      "valid_credentials": true
    },
    "relationships": {
      "person": {
        "data": {
          "type": "people",
          "id": "91cc9b60-5e8e-4dc5-85c8-d13c772db2e5"
        }
      },
      "organization": {
        "data": {
          "type": "organizations",
          "id": "6ee4da31-9ae4-4677-b1b9-0e468b3753cc"
        }
      }
    }
  }
}

Name	Type	Description	Required

Response

Content-Type: application/vnd.api+json; charset=utf-8
201 Created

{
  "data": {
    "id": "a1cf5d74-2a5d-4ae0-98b0-1a172703c4c5",
    "type": "organization_accounts",
    "attributes": {
      "created_at": "2018-10-12T19:05:10Z",
      "disable_downloads": false,
      "last_download": null,
      "locked_at": null,
      "remote_id": null,
      "updated_at": "2018-10-12T19:05:10Z",
      "updated_in_db_at": "2018-10-12T19:05:10Z",
      "username": "foo"
    },
    "relationships": {
      "organization": {
        "data": {
          "id": "6ee4da31-9ae4-4677-b1b9-0e468b3753cc",
          "type": "organizations"
        }
      },
      "person": {
        "data": {
          "id": "91cc9b60-5e8e-4dc5-85c8-d13c772db2e5",
          "type": "people"
        }
      }
    }
  }
}

Organization Account [DELETE]

Delete the current_user’s Organization Account with the given ID

Request

Endpoint

DELETE /api/v2/user/organization_accounts/2e94cf30-4baf-4fcf-9bd0-dd87c123e7ec
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/065acc62-944c-40d7-b20a-69c87e6ad283
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": "065acc62-944c-40d7-b20a-69c87e6ad283",
    "type": "organization_accounts",
    "attributes": {
      "created_at": "2018-10-12T19:05:10Z",
      "disable_downloads": false,
      "last_download": null,
      "locked_at": null,
      "remote_id": "1",
      "updated_at": "2018-10-12T19:05:10Z",
      "updated_in_db_at": "2018-10-12T19:05:10Z",
      "username": "foo"
    },
    "relationships": {
      "organization": {
        "data": {
          "id": "fc41ac0d-a7ef-41c9-847d-5958e5b91905",
          "type": "organizations"
        }
      },
      "person": {
        "data": {
          "id": "a2ff1f2d-adf2-48c6-b085-c4a143ea4e79",
          "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": "fd1b00c4-3f1b-45d3-9e24-7432eecba4b7",
      "type": "organization_accounts",
      "attributes": {
        "created_at": "2018-10-12T19:05:10Z",
        "disable_downloads": false,
        "last_download": null,
        "locked_at": null,
        "remote_id": "1",
        "updated_at": "2018-10-12T19:05:10Z",
        "updated_in_db_at": "2018-10-12T19:05:10Z",
        "username": "foo"
      },
      "relationships": {
        "organization": {
          "data": {
            "id": "dfe0ed3f-a23b-4b25-8902-02a529b39e90",
            "type": "organizations"
          }
        },
        "person": {
          "data": {
            "id": "93868a89-9bd9-4c5d-8e38-e1a824a11737",
            "type": "people"
          }
        }
      }
    },
    {
      "id": "7fe7b090-d68c-448b-a35d-131a721020ab",
      "type": "organization_accounts",
      "attributes": {
        "created_at": "2018-10-12T19:05:10Z",
        "disable_downloads": false,
        "last_download": null,
        "locked_at": null,
        "remote_id": "1",
        "updated_at": "2018-10-12T19:05:10Z",
        "updated_in_db_at": "2018-10-12T19:05:10Z",
        "username": "foo"
      },
      "relationships": {
        "organization": {
          "data": {
            "id": "51ee2a75-0aa9-405d-8dc7-30d728156ab9",
            "type": "organizations"
          }
        },
        "person": {
          "data": {
            "id": "93868a89-9bd9-4c5d-8e38-e1a824a11737",
            "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/9d1a90b7-f8d0-4457-830f-aab48c978c91
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-13 03:05:10 +0800",
      "username": "foo",
      "valid_credentials": true
    },
    "relationships": {
      "person": {
        "data": {
          "type": "people",
          "id": "fc2ebf17-1b4e-4d81-bda3-e14c8d871689"
        }
      },
      "organization": {
        "data": {
          "type": "organizations",
          "id": "37a5194e-46bd-46c7-a7cf-4f04390b57cb"
        }
      }
    }
  }
}

Name	Type	Description	Required

Response

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

{
  "data": {
    "id": "9d1a90b7-f8d0-4457-830f-aab48c978c91",
    "type": "organization_accounts",
    "attributes": {
      "created_at": "2018-10-12T19:05:10Z",
      "disable_downloads": false,
      "last_download": null,
      "locked_at": null,
      "remote_id": "1",
      "updated_at": "2018-10-12T19:05:10Z",
      "updated_in_db_at": "2018-10-12T19:05:10Z",
      "username": "foo"
    },
    "relationships": {
      "organization": {
        "data": {
          "id": "37a5194e-46bd-46c7-a7cf-4f04390b57cb",
          "type": "organizations"
        }
      },
      "person": {
        "data": {
          "id": "fc2ebf17-1b4e-4d81-bda3-e14c8d871689",
          "type": "people"
        }
      }
    }
  }
}