Filament Newsletter

Segments

Index

Retrieve a paginated list of segments (tags).

Usage

Endpoint

GET /api/v1/tags

Expected Response Code

200

Response Fields

  • data: array
  • id: int
  • name: string
  • created_at: datetime
  • updated_at: datetime

Sample Request

GET /api/v1/tags HTTP/1.1
Host: filaletter.test
Authorization: Bearer 9w2fN7d4F3Banyv7gihYOWJEH6MvtYyZ
Accept: application/json

Sample Response

{
        "data": [
                {
                        "id": 1,
                        "name": "Test Tag",
                        "created_at": "2020-03-23 12:44:14",
                        "updated_at": "2020-03-23 12:44:14"
                }
        ],
        "links": {
                "first": "https://filaletter.test/api/v1/tags?page=1",
                "last": "https://filaletter.test/api/v1/tags?page=1",
                "prev": null,
                "next": null
        },
        "meta": {
                "current_page": 1,
                "from": 1,
                "last_page": 1,
                "path": "https://filaletter.test/api/v1/tags",
                "per_page": 25,
                "to": 1,
                "total": 1
        }
}

Show

Get details of a single tag.

Usage

Endpoint

GET /api/v1/tags/{tagId}

Expected Response Code

200

Response Fields

  • data: object
    • id: int
    • name: string
    • created_at: datetime
    • updated_at: datetime

Sample Request

GET /api/v1/tags/1 HTTP/1.1
Host: filaletter.test
Authorization: Bearer 9w2fN7d4F3Banyv7gihYOWJEH6MvtYyZ
Accept: application/json

Sample Response

{
        "data": {
                "id": 1,
                "name": "Test Tag",
                "created_at": "2020-03-23 12:44:14",
                "updated_at": "2020-03-23 12:44:14"
        }
}

Store

Create a new tag, optionally including subscribers that should have it assigned to them.

Usage

Endpoint

POST /api/v1/tags

Expected Response Code

201

Request Fields

  • name: string
  • subscribers: array (optional)

Response Fields

  • data: object
    • id: int
    • name: string
    • subscribers: array
      • id: int
      • first_name: string
      • last_name: string
      • email: string
      • created_at: datetime
      • updated_at: datetime

      Sample Request

      POST /api/tags HTTP/1.1
Host: filaletter.test
Authorization: Bearer 9w2fN7d4F3Banyv7gihYOWJEH6MvtYyZ
Accept: application/json
Content-Type: application/json

{
        "name": "Test Tag Two",
        "subscribers": [1]
}

      Sample Response

      {
        "data": {
                "id": 2,
                "name": "Test Tag Two",
                "subscribers": [
                        {
                                "id": 1,
                                "first_name": "Test",
                                "last_name": "Subscriber",
                                "email": "[email protected]",
                                "created_at": "2020-03-23 13:44:09",
                                "updated_at": "2020-03-23 13:44:09"
                        }
                ],
                "created_at": "2020-03-24 08:45:55",
                "updated_at": "2020-03-24 08:45:55"
        }
}

      Update

      Update the details of the given tag. If you wish to adjust the subscribers associated with the tag, see the Tag Subscribers API.

      Usage

      Endpoint

      PUT /api/v1/tags/{tagId}

      Expected Response Code

      200

      Request Fields

      • name: string

      Response Fields

      • data: object
        • id: int
        • name: string
        • created_at: datetime
        • updated_at: datetime

      Sample Request

      PUT /api/v1/tags/2 HTTP/1.1
Host: filaletter.test
Authorization: Bearer 9w2fN7d4F3Banyv7gihYOWJEH6MvtYyZ
Accept: application/json
Content-Type: application/json

{
        "name": "Updated Tag"
}

      Sample Response

      {
        "data": {
                "id": 2,
                "name": "Updated Tag",
                "created_at": "2020-03-24 08:45:55",
                "updated_at": "2020-03-24 08:57:21"
        }
}

      Delete

      Delete the given tag.

      Endpoint

      DELETE /api/v1/tags/{tagId}

      Expected Response Code

      204

      Sample Request

      DELETE /api/v1/tags/2 HTTP/1.1
Host: filaletter.test
Authorization: Bearer 9w2fN7d4F3Banyv7gihYOWJEH6MvtYyZ
Accept: application/json