MPDX Developers
HomeHelp
Production
Production
  • Changelog
  • README
  • org_data_transfer
  • README
    • README
      • Account Lists
        • :Account List
        • Analytics
        • Chalkline Mail
        • Coaches
        • Designation Accounts
        • Donations
        • Donor Accounts
        • Entries
        • Financial Accounts
        • Imports
          • Csv
          • Google
          • Tnt
          • Tnt Data Sync
        • Invites
        • Mail Chimp Account
        • Merge
        • Notification Preferences
          • Bulk
        • Notifications
        • Pledges
        • Prayer Letters Account
        • Users
        • :account_list_id
          • Donations
        • :account_list_id
          • donations
            • Bulk
      • README
        • Impersonation
        • Organizations
        • Resets
      • Announcements
      • Appeals
        • Appeal Contacts
          • Bulk
        • Excluded Appeal Contacts
          • Bulk
      • Background Batches
      • Batch
      • Coaching
        • Answer Sets
        • Answers
        • Questions
      • Constants
      • Contacts
        • Addresses
        • Alma Mater Names
        • Analytics
        • Bulk
        • Church Names
        • Duplicates
        • README
        • Exports
          • Mailing
        • Filters
        • Merges
        • Partner Giving Analysis Filters
        • People
          • Bulk
          • Email Addresses
          • Facebook Accounts
          • Linkedin Accounts
          • Merges
          • Phones
          • Relationships
          • Twitter Accounts
          • Websites
        • Referrals
        • Referrers
        • Tags
          • Bulk
      • Deleted Records
      • Organizations
        • Account Lists
          • Account List Coaches
          • Account List Users
          • Invites
        • Admins
        • Contacts
        • Impersonation
        • Invites
      • Public
        • Designation Accounts
          • Subscriptions
      • README
        • Activity Results
        • Appointment Results
        • Donation Histories
        • Donation Monthly Totals
        • Donor Currency Donations
        • Entry Histories
        • Expected Monthly Totals
        • Goal Progress
        • Monthly Giving Graph
        • Monthly Losses Graphs
        • Partner Giving Analysis
        • People With Anniversaries
        • People With Birthdays
        • Pledge Histories
        • Salary Currency Donations
        • Tag Histories
        • Year Donations
      • Tasks
        • Analytics
        • Comments
        • Filters
        • Tags
      • README
        • Analytics
      • User
        • Account List Coaches
        • Announcements
        • Authenticate
        • Devices
        • Google Accounts
          • Google Integrations
        • Key Accounts
        • Notifications
        • Options
        • Organization Accounts
Powered by GitBook
On this page
  • Google Account [LIST]
  • Request
  • Response
  • Fields
  • Google Account [POST]
  • Request
  • Parameters
  • Response
  • Fields
  • Google Account [GET]
  • Request
  • Response
  • Fields
  • Google Account [PUT]
  • Request
  • Parameters
  • Response
  • Fields
  • Google Account [DELETE]
  • Request
  • Response
  1. README
  2. README
  3. User

Google Accounts

Google Accounts Documentation

Google Account [LIST]

Google Account [LIST]

Request

Endpoint

GET /api/v2/user/google_accounts
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": [
    {
      "id": "c703e201-62c5-48e1-a750-7e70ece5ee6a",
      "type": "google_accounts",
      "attributes": {
        "created_at": "2022-01-12T17:18:54Z",
        "email": "foo13@example.com",
        "expires_at": "2022-01-12T18:18:54Z",
        "last_download": null,
        "last_email_sync": null,
        "primary": false,
        "remote_id": "MyString",
        "token_expired": false,
        "updated_at": "2022-01-12T17:18:54Z",
        "updated_in_db_at": "2022-01-12T17:18:54Z"
      },
      "relationships": {
        "contact_groups": {
          "data": [

          ]
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 1,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

Fields

data

Type [Google Account]

Description An array of Google Accounts

Google Account [POST]

Google Account [POST]

Request

Endpoint

POST /api/v2/user/google_accounts
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "google_accounts",
    "attributes": {
      "email": "foo11@example.com",
      "remote_id": "MyString",
      "updated_in_db_at": "2022-01-12 17:18:54 UTC"
    }
  }
}

Parameters

Attributes

created_at

Type date

Description The timestamp of when this resource was created

Required No

email

Type string

Description Primary email address for Google Account

Required No

expires_at

Type string

Description OAuth Access Token Expiration Time

Required No

last_download

Type string

Description Last Download

Required No

last_email_sync

Type string

Description Last Email Sync

Required No

primary

Type boolean

Description Primary

Required No

remote_id

Type number

Description Remote Id

Required No

token_expired

Type boolean

Description OAuth Access Token Expired

Required No

updated_at

Type date

Description The timestamp of when this resource was last updated

Required No

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Required No

Response

Headers

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

Body

{
  "data": {
    "id": "d41cbd0c-7ad1-4d33-b11f-2061f99730d0",
    "type": "google_accounts",
    "attributes": {
      "created_at": "2022-01-12T17:18:54Z",
      "email": "foo11@example.com",
      "expires_at": null,
      "last_download": null,
      "last_email_sync": null,
      "primary": false,
      "remote_id": "MyString",
      "token_expired": true,
      "updated_at": "2022-01-12T17:18:54Z",
      "updated_in_db_at": "2022-01-12T17:18:54Z"
    },
    "relationships": {
      "contact_groups": {
        "data": [

        ]
      }
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

email

Type string

Description Primary email address for Google Account

expires_at

Type string

Description OAuth Access Token Expiration Time

last_download

Type string

Description Last Download

last_email_sync

Type string

Description Last Email Sync

primary

Type boolean

Description Primary

remote_id

Type number

Description Remote Id

token_expired

Type boolean

Description OAuth Access Token Expired

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Relationships

contact_groups.data

Type [Contact Group]

Description An array of Contact Groups from Google

Google Account [GET]

Google Account [GET]

Request

Endpoint

GET /api/v2/user/google_accounts/4e007877-6b11-4720-8716-29e287e6f5b2
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": {
    "id": "4e007877-6b11-4720-8716-29e287e6f5b2",
    "type": "google_accounts",
    "attributes": {
      "created_at": "2022-01-12T17:18:55Z",
      "email": "foo14@example.com",
      "expires_at": "2022-01-12T18:18:55Z",
      "last_download": null,
      "last_email_sync": null,
      "primary": false,
      "remote_id": "MyString",
      "token_expired": false,
      "updated_at": "2022-01-12T17:18:55Z",
      "updated_in_db_at": "2022-01-12T17:18:55Z"
    },
    "relationships": {
      "contact_groups": {
        "data": [

        ]
      }
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

email

Type string

Description Primary email address for Google Account

expires_at

Type string

Description OAuth Access Token Expiration Time

last_download

Type string

Description Last Download

last_email_sync

Type string

Description Last Email Sync

primary

Type boolean

Description Primary

remote_id

Type number

Description Remote Id

token_expired

Type boolean

Description OAuth Access Token Expired

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Relationships

contact_groups.data

Type [Contact Group]

Description An array of Contact Groups from Google

Google Account [PUT]

Google Account [PUT]

Request

Endpoint

PUT /api/v2/user/google_accounts/d7143a50-cca4-408c-8c9c-5f94f420ceae
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "google_accounts",
    "attributes": {
      "email": "foo17@example.com",
      "remote_id": "MyString",
      "updated_in_db_at": "2022-01-12 17:18:55 UTC"
    }
  }
}

Parameters

Attributes

created_at

Type date

Description The timestamp of when this resource was created

Required No

email

Type string

Description Primary email address for Google Account

Required No

expires_at

Type string

Description OAuth Access Token Expiration Time

Required No

last_download

Type string

Description Last Download

Required No

last_email_sync

Type string

Description Last Email Sync

Required No

overwrite

Type boolean

Description 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.

Required No

primary

Type boolean

Description Primary

Required No

remote_id

Type number

Description Remote Id

Required No

token_expired

Type boolean

Description OAuth Access Token Expired

Required No

updated_at

Type date

Description The timestamp of when this resource was last updated

Required No

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Required No

Response

Headers

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

Body

{
  "data": {
    "id": "d7143a50-cca4-408c-8c9c-5f94f420ceae",
    "type": "google_accounts",
    "attributes": {
      "created_at": "2022-01-12T17:18:55Z",
      "email": "foo17@example.com",
      "expires_at": "2022-01-12T18:18:55Z",
      "last_download": null,
      "last_email_sync": null,
      "primary": false,
      "remote_id": "MyString",
      "token_expired": false,
      "updated_at": "2022-01-12T17:18:55Z",
      "updated_in_db_at": "2022-01-12T17:18:55Z"
    },
    "relationships": {
      "contact_groups": {
        "data": [

        ]
      }
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

email

Type string

Description Primary email address for Google Account

expires_at

Type string

Description OAuth Access Token Expiration Time

last_download

Type string

Description Last Download

last_email_sync

Type string

Description Last Email Sync

primary

Type boolean

Description Primary

remote_id

Type number

Description Remote Id

token_expired

Type boolean

Description OAuth Access Token Expired

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Relationships

contact_groups.data

Type [Contact Group]

Description An array of Contact Groups from Google

Google Account [DELETE]

Google Account [DELETE]

Request

Endpoint

DELETE /api/v2/user/google_accounts/d08b4bec-3c71-46fe-b4e0-87dbe2de994e
Content-Type: application/vnd.api+json

Body

Response

Headers

204 No Content

Body

PreviousDevicesNextGoogle Integrations

Last updated 3 years ago