Skip to content

Atomic Operations Endpoint

POST
/v1/operations

Perform multiple resource-level operations in a single, ordered request using the JSON:API Atomic Operations extension. Only supported operations documented by the server should be used.

object
atomic:operations
required
Array<object>
object
op
required
string
Allowed values: add
Example
add
data
required
object
type
required
string
Allowed values: subscription
Example
subscription
id
string format: uuid
Example
b80719b3-1485-57c0-9e55-fda2b8f7472b
attributes
required
object
feedUrl
required
string format: uri
Example
https://example.com/rss2

Atomic operations executed. Each result is reported positionally.

object
atomic:results
required
Array
One of:
object
data
required
object
type
required
string
Allowed values: subscription
Example
subscription
id
required
string format: uuid
Example
ce510f4d-9046-5590-846e-58619ab8b353
attributes
required
object
feedUrl
string format: uri
Example
https://example.com/rss1
userSubscribedAt
string format: date-time
Example
2025-08-24T16:00:00Z
links
required
object
self
string
Example
/v1/subscriptions/ce510f4d-9046-5590-846e-58619ab8b353
unsubscribe
object
href
required
string
Example
/v1/subscriptions/ce510f4d-9046-5590-846e-58619ab8b353
method
required
string
Allowed values: DELETE
Example
DELETE
Example
{
"atomic:results": [
{
"data": {
"type": "subscription",
"id": "b80719b3-1485-57c0-9e55-fda2b8f7472b",
"attributes": {
"feedUrl": "https://example.com/rss2",
"userSubscribedAt": "2025-08-27T12:00:00Z"
},
"links": {
"self": "/v1/subscriptions/b80719b3-1485-57c0-9e55-fda2b8f7472b",
"unsubscribe": {
"href": "/v1/subscriptions/b80719b3-1485-57c0-9e55-fda2b8f7472b",
"method": "DELETE"
}
}
}
}
]
}