Notifications

Index

get

List all notifications.

Authorizations

ApiKeyAuth

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/notifications

HTTPcURLJavaScriptPython

GET /api/v1/notifications HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "read": "example_read",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "type": "example_type",
      "read_at": "2025-01-15T10:30:00.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/notifications",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/notifications?page=1",
    "last": "https://api.example.com/api/v1/notifications?page=1",
    "prev": null,
    "next": null
  }
}

Read-Notifications

patch

Read-Notifications for notifications.

Authorizations

ApiKeyAuth

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

patch

/api/v1/notifications

HTTPcURLJavaScriptPython

PATCH /api/v1/notifications HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{}

Update

put

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field	Type	Required
read		☑

Authorizations

ApiKeyAuth

Path parameters

notificationstringRequired

The notification identifier.

Body

application/json

readstringRequired

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/notifications/{notification}

HTTPcURLJavaScriptPython

PUT /api/v1/notifications/{notification} HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "read": "example_read"
}

{
  "data": {
    "id": 1,
    "read": "example_read",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "type": "example_type",
    "read_at": "2025-01-15T10:30:00.000000Z"
  }
}

Destroy

delete

Delete a notification.

Authorizations

ApiKeyAuth

Path parameters

notificationstringRequired

The notification identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/notifications/{notification}

HTTPcURLJavaScriptPython

DELETE /api/v1/notifications/{notification} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "message": "Action completed successfully."
}