Subscribe to or leave a Public List
/account/lists/{id}/subscriptionSubscribes the user to another User's Public List, or ends the subscription.
changed is false when the user was already in the requested state. A user can't subscribe to their own Public List (409 list.subscriptionInvalid); a private or unknown List is 404 list.notFound. A user can follow 500 Lists (409 list.limit.subscriptions). Subscriber counts on the public routes refresh hourly.
Authorization
OAuth 2 bearer token in the Authorization header. Required scope: lists:write
Path parameters
idstring requiredThe List's ID (a lowercase UUID). A List the user neither owns nor subscribes to, or a malformed ID, is
404list.notFound.pattern
Request body required
true to subscribe, false to leave.
Content type:application/json
subscribedboolean required
Responses
200 The subscription now in place.application/json
Headers
Cache-ControlstringBrowser caching policy.
"private, no-store"
dataobjectShow child attributes
subscribedbooleanchangedbooleansubscriberCountintegermin 0
400 The request is malformed or failed validation. Inspect error.code and error.issues.application/json
Headers
Cache-ControlstringBrowser caching policy.
"private, no-store"
dataany | nullAlways null on an error.
errorobjectWhy the request failed.
Show child attributes
codestringStable dotted camelCase code such as
resource.gone. Branch on this, not onmessage.messagestringShort explanation for people. Wording can change.
min length 1max length 256requestIdstringThe Cloudflare ray ID. Absent on Snippet and WAF errors and on cached
404,410and503responses, which carry it only incf-ray.min length 1docsstring (uri)Link to this code's entry in the error catalogue.
detailsmap of string | number | boolean | array of string | nullConstraints that apply to the failure, such as byte limits, dimensions or allowed types.
issuesarray of objectPer-field validation failures, when any.
max 50 itemsShow item attributes
codestringStable code for this field failure. Branch on this.
min length 1messagestringShort human-readable description of this field failure.
min length 1patharray of stringPath to the failing field, for example
["items", 2, "slot"].detailsmap of string | number | boolean | array of string | nullConstraints that apply to the failure, such as byte limits, dimensions or allowed types.
401 The access token is missing (auth.required), or invalid, expired or revoked (auth.invalidToken).application/json
Headers
Cache-ControlstringBrowser caching policy.
"private, no-store"WWW-AuthenticatestringRFC 6750 challenge:
Bearer realm="mediux", pluserror="invalid_token"for a bad or expired token.
dataany | nullAlways null on an error.
errorobjectWhy the request failed.
Show child attributes
codestringStable dotted camelCase code such as
resource.gone. Branch on this, not onmessage.messagestringShort explanation for people. Wording can change.
min length 1max length 256requestIdstringThe Cloudflare ray ID. Absent on Snippet and WAF errors and on cached
404,410and503responses, which carry it only incf-ray.min length 1docsstring (uri)Link to this code's entry in the error catalogue.
detailsmap of string | number | boolean | array of string | nullConstraints that apply to the failure, such as byte limits, dimensions or allowed types.
issuesarray of objectPer-field validation failures, when any.
max 50 itemsShow item attributes
codestringStable code for this field failure. Branch on this.
min length 1messagestringShort human-readable description of this field failure.
min length 1patharray of stringPath to the failing field, for example
["items", 2, "slot"].detailsmap of string | number | boolean | array of string | nullConstraints that apply to the failure, such as byte limits, dimensions or allowed types.
403 The token lacks the required App Permission (auth.insufficientScope, with details.required), or the account or connection may not do this (auth.forbidden).application/json
Headers
Cache-ControlstringBrowser caching policy.
"private, no-store"
dataany | nullAlways null on an error.
errorobjectWhy the request failed.
Show child attributes
codestringStable dotted camelCase code such as
resource.gone. Branch on this, not onmessage.messagestringShort explanation for people. Wording can change.
min length 1max length 256requestIdstringThe Cloudflare ray ID. Absent on Snippet and WAF errors and on cached
404,410and503responses, which carry it only incf-ray.min length 1docsstring (uri)Link to this code's entry in the error catalogue.
detailsmap of string | number | boolean | array of string | nullConstraints that apply to the failure, such as byte limits, dimensions or allowed types.
issuesarray of objectPer-field validation failures, when any.
max 50 itemsShow item attributes
codestringStable code for this field failure. Branch on this.
min length 1messagestringShort human-readable description of this field failure.
min length 1patharray of stringPath to the failing field, for example
["items", 2, "slot"].detailsmap of string | number | boolean | array of string | nullConstraints that apply to the failure, such as byte limits, dimensions or allowed types.
404 The resource does not exist or is not the user's.application/json
Headers
Cache-ControlstringBrowser caching policy.
"private, no-store"
dataany | nullAlways null on an error.
errorobjectWhy the request failed.
Show child attributes
codestringStable dotted camelCase code such as
resource.gone. Branch on this, not onmessage.messagestringShort explanation for people. Wording can change.
min length 1max length 256requestIdstringThe Cloudflare ray ID. Absent on Snippet and WAF errors and on cached
404,410and503responses, which carry it only incf-ray.min length 1docsstring (uri)Link to this code's entry in the error catalogue.
detailsmap of string | number | boolean | array of string | nullConstraints that apply to the failure, such as byte limits, dimensions or allowed types.
issuesarray of objectPer-field validation failures, when any.
max 50 itemsShow item attributes
codestringStable code for this field failure. Branch on this.
min length 1messagestringShort human-readable description of this field failure.
min length 1patharray of stringPath to the failing field, for example
["items", 2, "slot"].detailsmap of string | number | boolean | array of string | nullConstraints that apply to the failure, such as byte limits, dimensions or allowed types.
409 The request conflicts with current state or a limit. Inspect error.code and error.details.application/json
Headers
Cache-ControlstringBrowser caching policy.
"private, no-store"
dataany | nullAlways null on an error.
errorobjectWhy the request failed.
Show child attributes
codestringStable dotted camelCase code such as
resource.gone. Branch on this, not onmessage.messagestringShort explanation for people. Wording can change.
min length 1max length 256requestIdstringThe Cloudflare ray ID. Absent on Snippet and WAF errors and on cached
404,410and503responses, which carry it only incf-ray.min length 1docsstring (uri)Link to this code's entry in the error catalogue.
detailsmap of string | number | boolean | array of string | nullConstraints that apply to the failure, such as byte limits, dimensions or allowed types.
issuesarray of objectPer-field validation failures, when any.
max 50 itemsShow item attributes
codestringStable code for this field failure. Branch on this.
min length 1messagestringShort human-readable description of this field failure.
min length 1patharray of stringPath to the failing field, for example
["items", 2, "slot"].detailsmap of string | number | boolean | array of string | nullConstraints that apply to the failure, such as byte limits, dimensions or allowed types.
413 The body exceeds the allowed size.application/json
Headers
Cache-ControlstringBrowser caching policy.
"private, no-store"
dataany | nullAlways null on an error.
errorobjectWhy the request failed.
Show child attributes
codestringStable dotted camelCase code such as
resource.gone. Branch on this, not onmessage.messagestringShort explanation for people. Wording can change.
min length 1max length 256requestIdstringThe Cloudflare ray ID. Absent on Snippet and WAF errors and on cached
404,410and503responses, which carry it only incf-ray.min length 1docsstring (uri)Link to this code's entry in the error catalogue.
detailsmap of string | number | boolean | array of string | nullConstraints that apply to the failure, such as byte limits, dimensions or allowed types.
issuesarray of objectPer-field validation failures, when any.
max 50 itemsShow item attributes
codestringStable code for this field failure. Branch on this.
min length 1messagestringShort human-readable description of this field failure.
min length 1patharray of stringPath to the failing field, for example
["items", 2, "slot"].detailsmap of string | number | boolean | array of string | nullConstraints that apply to the failure, such as byte limits, dimensions or allowed types.
415 The Content-Type is not application/json.application/json
Headers
Cache-ControlstringBrowser caching policy.
"private, no-store"
dataany | nullAlways null on an error.
errorobjectWhy the request failed.
Show child attributes
codestringStable dotted camelCase code such as
resource.gone. Branch on this, not onmessage.messagestringShort explanation for people. Wording can change.
min length 1max length 256requestIdstringThe Cloudflare ray ID. Absent on Snippet and WAF errors and on cached
404,410and503responses, which carry it only incf-ray.min length 1docsstring (uri)Link to this code's entry in the error catalogue.
detailsmap of string | number | boolean | array of string | nullConstraints that apply to the failure, such as byte limits, dimensions or allowed types.
issuesarray of objectPer-field validation failures, when any.
max 50 itemsShow item attributes
codestringStable code for this field failure. Branch on this.
min length 1messagestringShort human-readable description of this field failure.
min length 1patharray of stringPath to the failing field, for example
["items", 2, "slot"].detailsmap of string | number | boolean | array of string | nullConstraints that apply to the failure, such as byte limits, dimensions or allowed types.
429 Too many requests. Wait the Retry-After seconds before trying again.application/json
Headers
Cache-ControlstringBrowser caching policy.
"private, no-store"Retry-AfterstringSeconds to wait before trying again.
pattern ^\d+$
dataany | nullAlways null on an error.
errorobjectWhy the request failed.
Show child attributes
codestringStable dotted camelCase code such as
resource.gone. Branch on this, not onmessage.messagestringShort explanation for people. Wording can change.
min length 1max length 256requestIdstringThe Cloudflare ray ID. Absent on Snippet and WAF errors and on cached
404,410and503responses, which carry it only incf-ray.min length 1docsstring (uri)Link to this code's entry in the error catalogue.
detailsmap of string | number | boolean | array of string | nullConstraints that apply to the failure, such as byte limits, dimensions or allowed types.
issuesarray of objectPer-field validation failures, when any.
max 50 itemsShow item attributes
codestringStable code for this field failure. Branch on this.
min length 1messagestringShort human-readable description of this field failure.
min length 1patharray of stringPath to the failing field, for example
["items", 2, "slot"].detailsmap of string | number | boolean | array of string | nullConstraints that apply to the failure, such as byte limits, dimensions or allowed types.
503 Temporarily unavailable. Check the outcome before retrying a write.application/json
Headers
Cache-ControlstringBrowser caching policy.
"private, no-store"
dataany | nullAlways null on an error.
errorobjectWhy the request failed.
Show child attributes
codestringStable dotted camelCase code such as
resource.gone. Branch on this, not onmessage.messagestringShort explanation for people. Wording can change.
min length 1max length 256requestIdstringThe Cloudflare ray ID. Absent on Snippet and WAF errors and on cached
404,410and503responses, which carry it only incf-ray.min length 1docsstring (uri)Link to this code's entry in the error catalogue.
detailsmap of string | number | boolean | array of string | nullConstraints that apply to the failure, such as byte limits, dimensions or allowed types.
issuesarray of objectPer-field validation failures, when any.
max 50 itemsShow item attributes
codestringStable code for this field failure. Branch on this.
min length 1messagestringShort human-readable description of this field failure.
min length 1patharray of stringPath to the failing field, for example
["items", 2, "slot"].detailsmap of string | number | boolean | array of string | nullConstraints that apply to the failure, such as byte limits, dimensions or allowed types.