Announcements

Announcements Documentation

Announcement [POST]

Announcement [POST]

Request

Endpoint

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

Body

{
  "data": {
    "type": "user_announcements",
    "attributes": {
    },
    "relationships": {
      "announcement": {
        "data": {
          "type": "announcements",
          "id": "14d3448d-3a95-4e55-8536-0300fc86eb47"
        }
      },
      "action": {
        "data": {
          "type": "announcement_actions",
          "id": "6670ba19-39ec-4a3a-b10a-fffe9b5771fd"
        }
      }
    }
  }
}

Parameters

Attributes

created_at

Type date

Description The timestamp of when this resource was created

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

action.data

Type Announcement Action

Description The action that this user announcement belongs to

Required No

announcement.data

Type Announcement

Description The announcement that this user announcement belongs to

Required No

Response

Headers

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

Body

{
  "data": {
    "id": "2eb011f2-b938-4f8d-a345-6420e33773be",
    "type": "user_announcements",
    "attributes": {
      "created_at": "2021-11-23T14:38:25Z",
      "expires_after": null,
      "updated_at": "2021-11-23T14:38:25Z",
      "updated_in_db_at": "2021-11-23T14:38:25Z"
    },
    "relationships": {
      "action": {
        "data": {
          "id": "6670ba19-39ec-4a3a-b10a-fffe9b5771fd",
          "type": "announcement_actions"
        }
      },
      "announcement": {
        "data": {
          "id": "14d3448d-3a95-4e55-8536-0300fc86eb47",
          "type": "announcements"
        }
      }
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

expires_after

Type date string

Description The date this user announcement should be ignored

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

action.data

Type Announcement Action

Description The action that this user announcement belongs to

announcement.data

Type Announcement

Description The announcement that this user announcement belongs to