> For the complete documentation index, see [llms.txt](https://docs.podplay.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.podplay.app/api/users/suspensions.md).
# Suspensions
User account suspensions and restrictions.
## GET /suspensions
>
```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Suspensions","description":"User account suspensions and restrictions."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"SuspensionPaginatedCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SuspensionDto"}},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_total":{"type":"number","readOnly":true},"_links":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items","_pagination","_total","_links"]},"SuspensionDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"nullable":true},"type":{"type":"string","enum":["PREVIEW","ORDER"]},"suspendedEvents":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/SuspendedEventCollectionDto"}]},"pod":{"$ref":"#/components/schemas/ItemRefDto"},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"},"status":{"type":"string","enum":["INVALID","CONFIRMED","DRAFT","ACTIVE","CANCELED"],"nullable":true,"readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object","readOnly":true}},"required":["type","pod","startTime","endTime","status","errors","_links"]},"SuspendedEventCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SuspendedEventDto"}},"_total":{"type":"number","readOnly":true},"_links":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items","_total","_links"]},"SuspendedEventDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"event":{"$ref":"#/components/schemas/ItemRefDto"},"action":{"type":"string","enum":["REFUND","NO_REFUND"]},"status":{"type":"string","enum":["INVALID","CONFIRMED","DRAFT"],"nullable":true,"readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object","readOnly":true}},"required":["id","event","action","status","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"PaginationDto":{"type":"object","properties":{"page":{"type":"number"},"ipp":{"type":"number"},"count":{"type":"number"},"total":{"type":"number"}},"required":["page","ipp","count","total"]}}},"paths":{"/suspensions":{"get":{"operationId":"SuspensionsController_findEventSuspensions","parameters":[{"name":"startDateTime","required":false,"in":"query","schema":{"format":"date-time","type":"string"}},{"name":"endDateTime","required":false,"in":"query","schema":{"format":"date-time","type":"string"}},{"name":"status","required":false,"in":"query","schema":{"enum":["DRAFT","CANCELED","ACTIVE"],"type":"string"}},{"name":"regionId","required":false,"in":"query","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"page","required":false,"in":"query","schema":{"type":"number"}},{"name":"ipp","required":false,"in":"query","schema":{"type":"number"}},{"name":"sort","required":false,"in":"query","description":"If not set, `sort` will be defaulted as `startTime` (ASC)","schema":{"type":"string"}},{"name":"podId","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Returns an `EventSuspensionPaginatedCollectionDto`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuspensionPaginatedCollectionDto"}}}}},"tags":["Suspensions"]}}}}
```
## POST /suspensions
>
```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Suspensions","description":"User account suspensions and restrictions."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"SuspensionDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"nullable":true},"type":{"type":"string","enum":["PREVIEW","ORDER"]},"suspendedEvents":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/SuspendedEventCollectionDto"}]},"pod":{"$ref":"#/components/schemas/ItemRefDto"},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"},"status":{"type":"string","enum":["INVALID","CONFIRMED","DRAFT","ACTIVE","CANCELED"],"nullable":true,"readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object","readOnly":true}},"required":["type","pod","startTime","endTime","status","errors","_links"]},"SuspendedEventCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SuspendedEventDto"}},"_total":{"type":"number","readOnly":true},"_links":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items","_total","_links"]},"SuspendedEventDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"event":{"$ref":"#/components/schemas/ItemRefDto"},"action":{"type":"string","enum":["REFUND","NO_REFUND"]},"status":{"type":"string","enum":["INVALID","CONFIRMED","DRAFT"],"nullable":true,"readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object","readOnly":true}},"required":["id","event","action","status","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"ErrorDto":{"type":"object","properties":{"statusCode":{"type":"number","readOnly":true},"message":{"type":"object","readOnly":true},"error":{"type":"string","readOnly":true}},"required":["statusCode","message","error"]}}},"paths":{"/suspensions":{"post":{"operationId":"SuspensionsController_createEventSuspension","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuspensionDto"}}}},"responses":{"201":{"description":"Returns an `SuspensionDto`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuspensionDto"}}}},"400":{"description":"Returns an error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDto"}}}},"422":{"description":"Returns an `ErrorDto` in case of validation errors or failures.
Possible error codes are:
`ES001`: Event suspension time range must include a start time and an end time, the end time should be greater than the start time.
`ES002`: Cannot cancel a suspension that happened in the past.
`ES003`: The suspension time window cannot overlap with pod's closing time
`ES004`: Cannot edit or create a suspension including events that happened in the past.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDto"}}}}},"tags":["Suspensions"]}}}}
```
## GET /suspensions/{suspensionId}
>
```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Suspensions","description":"User account suspensions and restrictions."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"SuspensionDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"nullable":true},"type":{"type":"string","enum":["PREVIEW","ORDER"]},"suspendedEvents":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/SuspendedEventCollectionDto"}]},"pod":{"$ref":"#/components/schemas/ItemRefDto"},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"},"status":{"type":"string","enum":["INVALID","CONFIRMED","DRAFT","ACTIVE","CANCELED"],"nullable":true,"readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object","readOnly":true}},"required":["type","pod","startTime","endTime","status","errors","_links"]},"SuspendedEventCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SuspendedEventDto"}},"_total":{"type":"number","readOnly":true},"_links":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items","_total","_links"]},"SuspendedEventDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"event":{"$ref":"#/components/schemas/ItemRefDto"},"action":{"type":"string","enum":["REFUND","NO_REFUND"]},"status":{"type":"string","enum":["INVALID","CONFIRMED","DRAFT"],"nullable":true,"readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object","readOnly":true}},"required":["id","event","action","status","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"ErrorDto":{"type":"object","properties":{"statusCode":{"type":"number","readOnly":true},"message":{"type":"object","readOnly":true},"error":{"type":"string","readOnly":true}},"required":["statusCode","message","error"]}}},"paths":{"/suspensions/{suspensionId}":{"get":{"operationId":"SuspensionsController_findEventSuspensionById","parameters":[{"name":"suspensionId","required":true,"in":"path","schema":{"type":"string"}},{"name":"expand","required":false,"in":"query","explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Returns an `SuspensionDto`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuspensionDto"}}}},"404":{"description":"Returns an error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDto"}}}}},"tags":["Suspensions"]}}}}
```
## PATCH /suspensions/{suspensionId}
>
```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Suspensions","description":"User account suspensions and restrictions."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"PatchableSuspensionDto":{"type":"object","properties":{"type":{"type":"string","enum":["PREVIEW","ORDER"]},"suspendedEvents":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/SuspendedEventCollectionDto"}]},"endTime":{"format":"date-time","type":"string"}},"required":["type","endTime"]},"SuspendedEventCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SuspendedEventDto"}},"_total":{"type":"number","readOnly":true},"_links":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items","_total","_links"]},"SuspendedEventDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"event":{"$ref":"#/components/schemas/ItemRefDto"},"action":{"type":"string","enum":["REFUND","NO_REFUND"]},"status":{"type":"string","enum":["INVALID","CONFIRMED","DRAFT"],"nullable":true,"readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object","readOnly":true}},"required":["id","event","action","status","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"SuspensionCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SuspensionDto"}},"_total":{"type":"number","readOnly":true},"_links":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items","_total","_links"]},"SuspensionDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"nullable":true},"type":{"type":"string","enum":["PREVIEW","ORDER"]},"suspendedEvents":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/SuspendedEventCollectionDto"}]},"pod":{"$ref":"#/components/schemas/ItemRefDto"},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"},"status":{"type":"string","enum":["INVALID","CONFIRMED","DRAFT","ACTIVE","CANCELED"],"nullable":true,"readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object","readOnly":true}},"required":["type","pod","startTime","endTime","status","errors","_links"]},"ErrorDto":{"type":"object","properties":{"statusCode":{"type":"number","readOnly":true},"message":{"type":"object","readOnly":true},"error":{"type":"string","readOnly":true}},"required":["statusCode","message","error"]}}},"paths":{"/suspensions/{suspensionId}":{"patch":{"operationId":"SuspensionsController_updateEventSuspensionById","parameters":[{"name":"suspensionId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchableSuspensionDto"}}}},"responses":{"200":{"description":"Returns an `EventSuspensionCollectionDto`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuspensionCollectionDto"}}}},"400":{"description":"Returns an error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDto"}}}},"404":{"description":"Returns an error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDto"}}}},"422":{"description":"Returns an error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDto"}}}}},"tags":["Suspensions"]}}}}
```
## GET /suspensions/{suspensionId}/events
>
```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Suspensions","description":"User account suspensions and restrictions."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"SuspendedEventPaginatedCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SuspendedEventDto"}},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_total":{"type":"number"},"_links":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items","_pagination","_total","_links"]},"SuspendedEventDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"event":{"$ref":"#/components/schemas/ItemRefDto"},"action":{"type":"string","enum":["REFUND","NO_REFUND"]},"status":{"type":"string","enum":["INVALID","CONFIRMED","DRAFT"],"nullable":true,"readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object","readOnly":true}},"required":["id","event","action","status","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]},"PaginationDto":{"type":"object","properties":{"page":{"type":"number"},"ipp":{"type":"number"},"count":{"type":"number"},"total":{"type":"number"}},"required":["page","ipp","count","total"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"ErrorDto":{"type":"object","properties":{"statusCode":{"type":"number","readOnly":true},"message":{"type":"object","readOnly":true},"error":{"type":"string","readOnly":true}},"required":["statusCode","message","error"]}}},"paths":{"/suspensions/{suspensionId}/events":{"get":{"operationId":"SuspensionsController_findEventSuspensionEventsById","parameters":[{"name":"page","required":false,"in":"query","schema":{"type":"number"}},{"name":"ipp","required":false,"in":"query","schema":{"type":"number"}},{"name":"suspensionId","required":true,"in":"path","schema":{"type":"string"}},{"name":"expand","required":false,"in":"query","explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Returns an `EventSuspensionCollectionDto`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuspendedEventPaginatedCollectionDto"}}}},"404":{"description":"Returns an error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDto"}}}}},"tags":["Suspensions"]}}}}
```
## POST /suspensions/{suspensionId}/cancellation
>
```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Suspensions","description":"User account suspensions and restrictions."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"SuspensionDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"nullable":true},"type":{"type":"string","enum":["PREVIEW","ORDER"]},"suspendedEvents":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/SuspendedEventCollectionDto"}]},"pod":{"$ref":"#/components/schemas/ItemRefDto"},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"},"status":{"type":"string","enum":["INVALID","CONFIRMED","DRAFT","ACTIVE","CANCELED"],"nullable":true,"readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object","readOnly":true}},"required":["type","pod","startTime","endTime","status","errors","_links"]},"SuspendedEventCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SuspendedEventDto"}},"_total":{"type":"number","readOnly":true},"_links":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items","_total","_links"]},"SuspendedEventDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"event":{"$ref":"#/components/schemas/ItemRefDto"},"action":{"type":"string","enum":["REFUND","NO_REFUND"]},"status":{"type":"string","enum":["INVALID","CONFIRMED","DRAFT"],"nullable":true,"readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object","readOnly":true}},"required":["id","event","action","status","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"ErrorDto":{"type":"object","properties":{"statusCode":{"type":"number","readOnly":true},"message":{"type":"object","readOnly":true},"error":{"type":"string","readOnly":true}},"required":["statusCode","message","error"]}}},"paths":{"/suspensions/{suspensionId}/cancellation":{"post":{"operationId":"SuspensionsController_createEventSuspensionCancellation","parameters":[{"name":"suspensionId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":"Returns an `SuspensionDto`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuspensionDto"}}}},"400":{"description":"Returns an error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDto"}}}},"404":{"description":"Returns an error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDto"}}}},"422":{"description":"Returns an error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDto"}}}}},"tags":["Suspensions"]}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.podplay.app/api/users/suspensions.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.