Notifications

Notifications Documentation

Notification [LIST]

Request

Endpoint

GET /api/v2/account_lists/80db9163-a845-4f0c-a57b-be7806edbdbe/notifications
Content-Type: application/vnd.api+json

Body

Parameters

Filters

cleared

Type boolean

Description Filter checks if cleared is either "true" or "false"

Required No

Response

Headers

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

Body

{
  "data": [
    {
      "id": "9701938b-9d44-4221-bae8-e20da06952c7",
      "type": "notifications",
      "attributes": {
        "cleared": false,
        "created_at": "2022-01-12T17:18:37Z",
        "event_date": "2012-10-23T17:03:15Z",
        "updated_at": "2022-01-12T17:18:37Z",
        "updated_in_db_at": "2022-01-12T17:18:37Z"
      },
      "relationships": {
        "contact": {
          "data": {
            "id": "438ec967-c878-4404-b33b-f33dcf6b8d48",
            "type": "contacts"
          }
        },
        "notification_type": {
          "data": {
            "id": "68eb2094-a5ef-4fe3-9b9e-b99cd15d8a92",
            "type": "notification_type"
          }
        },
        "donation": {
          "data": {
            "id": "dfaa42c4-d53b-48a0-ad8b-ee65d11234e5",
            "type": "donations"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 1,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

Fields

data

Type [Notification]

Description An array of Notifications

Notification [GET]

Request

Endpoint

GET /api/v2/account_lists/53308644-e075-4bc1-a2a6-cac62a605fa1/notifications/6e0908f5-14bd-4f05-98d3-11eb2200f14e
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": {
    "id": "6e0908f5-14bd-4f05-98d3-11eb2200f14e",
    "type": "notifications",
    "attributes": {
      "cleared": false,
      "created_at": "2022-01-12T17:18:37Z",
      "event_date": "2012-10-23T17:03:15Z",
      "updated_at": "2022-01-12T17:18:37Z",
      "updated_in_db_at": "2022-01-12T17:18:37Z"
    },
    "relationships": {
      "contact": {
        "data": {
          "id": "1ab664b4-6541-43ba-9e9c-49b9a6e9e278",
          "type": "contacts"
        }
      },
      "notification_type": {
        "data": {
          "id": "8c9387f4-6037-4177-a85a-135a4befd0c9",
          "type": "notification_type"
        }
      },
      "donation": {
        "data": {
          "id": "e512bd6c-df48-4d13-8774-770d6c95927e",
          "type": "donations"
        }
      }
    }
  }
}

Fields

Attributes

cleared

Type boolean

Description If this notification has been read by the user then cleared should be marked as true

created_at

Type date

Description The timestamp of when this resource was created

event_date

Type date

Description The date the event that triggered the notification occured

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

Type Contact

Description The Contact the notification applies to

donation.data

Type Donation

Description The Donation the notification applies to (Optional)

notification_type.data

Type NotificationType

Description The notification type indicating what event triggered the notification

Notification [PUT]

Request

Endpoint

PUT /api/v2/account_lists/dc8b192f-d721-4598-a1c8-638a7708ddb5/notifications/c16cc3e2-5739-4abb-b319-dd6499a93176
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "notifications",
    "attributes": {
      "cleared": false,
      "updated_in_db_at": "2022-01-12 17:18:37 UTC"
    }
  }
}

Parameters

Attributes

cleared

Type boolean

Description If this notification has been read by the user then cleared should be marked as true

Required No

created_at

Type date

Description The timestamp of when this resource was created

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

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": "c16cc3e2-5739-4abb-b319-dd6499a93176",
    "type": "notifications",
    "attributes": {
      "cleared": false,
      "created_at": "2022-01-12T17:18:37Z",
      "event_date": "2012-10-23T17:03:15Z",
      "updated_at": "2022-01-12T17:18:37Z",
      "updated_in_db_at": "2022-01-12T17:18:37Z"
    },
    "relationships": {
      "contact": {
        "data": {
          "id": "d92805bf-8d38-4073-8ef1-bc7aa780c96b",
          "type": "contacts"
        }
      },
      "notification_type": {
        "data": {
          "id": "0ba3fb61-e79f-43bf-b06d-aff474967070",
          "type": "notification_type"
        }
      },
      "donation": {
        "data": {
          "id": "a550465b-b25b-4cca-9143-a9b92155bca2",
          "type": "donations"
        }
      }
    }
  }
}

Fields

Attributes

cleared

Type boolean

Description If this notification has been read by the user then cleared should be marked as true

created_at

Type date

Description The timestamp of when this resource was created

event_date

Type date

Description The date the event that triggered the notification occured

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

Type Contact

Description The Contact the notification applies to

donation.data

Type Donation

Description The Donation the notification applies to (Optional)

notification_type.data

Type NotificationType

Description The notification type indicating what event triggered the notification

Notification [CLEAR]

Request

Endpoint

PUT /api/v2/account_lists/1fdbc5a0-d01a-4882-9003-d251a0fe6367/notifications/clear
Content-Type: application/vnd.api+json

Body

Response

Headers

Content-Type: text/html
200 OK

Body

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

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

PreviousBulk NextPledges

Last updated 2 years ago