Notification Preferences

Notification Preferences Documentation

Notification Preference [LIST]

Notification Preference [LIST]

Request

Endpoint

GET /api/v2/account_lists/a04b43b9-32c6-423a-a3ec-8cd68087bce7/notification_preferences
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": [
    {
      "id": "3b9f8f43-9b1d-4b4a-99e3-50894e98da6f",
      "type": "notification_preferences",
      "attributes": {
        "app": true,
        "created_at": "2022-01-12T17:18:39Z",
        "email": true,
        "task": true,
        "updated_at": "2022-01-12T17:18:39Z",
        "updated_in_db_at": "2022-01-12T17:18:39Z"
      },
      "relationships": {
        "notification_type": {
          "data": {
            "id": "a0750706-dd57-4c7f-8b17-3b5aae3273d8",
            "type": "notification_type"
          }
        }
      }
    },
    {
      "id": "a42725b7-a9cf-47bd-9b72-b380c585253d",
      "type": "notification_preferences",
      "attributes": {
        "app": true,
        "created_at": "2022-01-12T17:18:39Z",
        "email": true,
        "task": true,
        "updated_at": "2022-01-12T17:18:39Z",
        "updated_in_db_at": "2022-01-12T17:18:39Z"
      },
      "relationships": {
        "notification_type": {
          "data": {
            "id": "3e240c14-b9da-4f03-ae20-49fe85d891d6",
            "type": "notification_type"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 2,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

Fields

data

Type [Notification Preference]

Description An array of Notification Preferences

Notification Preference [POST]

Notification Preference [POST]

Request

Endpoint

POST /api/v2/account_lists/e3628068-48af-487c-88b0-f0495a105645/notification_preferences
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "notification_preferences",
    "attributes": {
      "app": true,
      "email": true,
      "updated_in_db_at": "2022-01-12 17:18:38 UTC"
    },
    "relationships": {
      "notification_type": {
        "data": {
          "type": "notification_types",
          "id": "84972c7c-0996-4415-b3a8-ac23ededead4"
        }
      }
    }
  }
}

Parameters

Attributes

app

Type boolean

Description Indicates when a notification is created with the related notification type if it should send an in app notification to the user

Required No

created_at

Type date

Description The timestamp of when this resource was created

Required No

email

Type boolean

Description Indicates when a notification is created with the related notification type if it should send an email to the user

Required No

task

Type boolean

Description Indicates when a notification is created with the related notification type if it should create a task

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

Relationships

notification_type.data

Type Notification Type

Description The notification type this preference is for

Required No

Response

Headers

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

Body

{
  "data": {
    "id": "9a1538fa-dc22-4fdd-99ef-e2a9bb28d9f2",
    "type": "notification_preferences",
    "attributes": {
      "app": true,
      "created_at": "2022-01-12T17:18:39Z",
      "email": true,
      "task": true,
      "updated_at": "2022-01-12T17:18:39Z",
      "updated_in_db_at": "2022-01-12T17:18:39Z"
    },
    "relationships": {
      "notification_type": {
        "data": {
          "id": "84972c7c-0996-4415-b3a8-ac23ededead4",
          "type": "notification_type"
        }
      }
    }
  }
}

Fields

Attributes

app

Type boolean

Description Indicates when a notification is created with the related notification type if it should send an in app notification to the user

created_at

Type date

Description The timestamp of when this resource was created

email

Type boolean

Description Indicates when a notification is created with the related notification type if it should send an email to the user

task

Type boolean

Description Indicates when a notification is created with the related notification type if it should create a task

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

notification_type.data

Type Notification Type

Description The notification type this preference is for

Notification Preference [GET]

Notification Preference [GET]

Request

Endpoint

GET /api/v2/account_lists/a240bf93-a987-4886-a731-5db60988b29a/notification_preferences/6eb87da1-606f-4541-8395-d3f601850d95
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": {
    "id": "6eb87da1-606f-4541-8395-d3f601850d95",
    "type": "notification_preferences",
    "attributes": {
      "app": true,
      "created_at": "2022-01-12T17:18:39Z",
      "email": true,
      "task": true,
      "updated_at": "2022-01-12T17:18:39Z",
      "updated_in_db_at": "2022-01-12T17:18:39Z"
    },
    "relationships": {
      "notification_type": {
        "data": {
          "id": "bd4351e7-859c-4d1c-9a65-9ca8654eb0f9",
          "type": "notification_type"
        }
      }
    }
  }
}

Fields

Attributes

app

Type boolean

Description Indicates when a notification is created with the related notification type if it should send an in app notification to the user

created_at

Type date

Description The timestamp of when this resource was created

email

Type boolean

Description Indicates when a notification is created with the related notification type if it should send an email to the user

task

Type boolean

Description Indicates when a notification is created with the related notification type if it should create a task

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

notification_type.data

Type Notification Type

Description The notification type this preference is for

Notification Preference [PUT]

Notification Preference [PUT]

Request

Endpoint

PUT /api/v2/account_lists/a83ec276-68de-47ae-ab2b-ac989f7bad28/notification_preferences/b06a5f04-709a-441c-924f-e291dd915da6
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "notification_preferences",
    "attributes": {
      "app": true,
      "email": true,
      "updated_in_db_at": "2022-01-12 17:18:38 UTC"
    },
    "relationships": {
      "notification_type": {
        "data": {
          "type": "notification_types",
          "id": "179a8ffd-c22c-425f-a1f3-d492477111b5"
        }
      }
    }
  }
}

Parameters

Attributes

app

Type boolean

Description Indicates when a notification is created with the related notification type if it should send an in app notification to the user

Required No

created_at

Type date

Description The timestamp of when this resource was created

Required No

email

Type boolean

Description Indicates when a notification is created with the related notification type if it should send an email to the user

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

task

Type boolean

Description Indicates when a notification is created with the related notification type if it should create a task

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

Relationships

notification_type.data

Type Notification Type

Description The notification type this preference is for

Required No

Response

Headers

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

Body

{
  "data": {
    "id": "b06a5f04-709a-441c-924f-e291dd915da6",
    "type": "notification_preferences",
    "attributes": {
      "app": true,
      "created_at": "2022-01-12T17:18:38Z",
      "email": true,
      "task": true,
      "updated_at": "2022-01-12T17:18:38Z",
      "updated_in_db_at": "2022-01-12T17:18:38Z"
    },
    "relationships": {
      "notification_type": {
        "data": {
          "id": "179a8ffd-c22c-425f-a1f3-d492477111b5",
          "type": "notification_type"
        }
      }
    }
  }
}

Fields

Attributes

app

Type boolean

Description Indicates when a notification is created with the related notification type if it should send an in app notification to the user

created_at

Type date

Description The timestamp of when this resource was created

email

Type boolean

Description Indicates when a notification is created with the related notification type if it should send an email to the user

task

Type boolean

Description Indicates when a notification is created with the related notification type if it should create a task

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

notification_type.data

Type Notification Type

Description The notification type this preference is for

Notification Preference [DELETE]

Notification Preference [DELETE]

Request

Endpoint

DELETE /api/v2/account_lists/a35c31fd-2f0b-426e-a26f-1e80f997520d/notification_preferences/08e21af6-e6d2-430d-ad6f-5924533cd06e
Content-Type: application/vnd.api+json

Body

Response

Headers

204 No Content

Body