> ## Documentation Index > Fetch the complete documentation index at: https://docs.clipstake.com/llms.txt > Use this file to discover all available pages before exploring further. # Pause a submission ## OpenAPI ````yaml /openapi.json post /x/submissions/{submission_id}/pause openapi: 3.1.0 info: title: Clipstake API description: >- Instagram, X and YouTube media tracking, audience geography and demographics, as an API. version: 0.0.1 servers: - url: https://api.clipstake.com/v1 security: [] paths: /x/submissions/{submission_id}/pause: post: tags: - Submissions summary: Pause a submission operationId: x-submissions-pause parameters: - in: path name: submission_id schema: type: string description: >- Submission ID. Format: sub_ followed by 24 lowercase hexadecimal characters. example: sub_0899bdcb659c102e360005ec required: true description: >- Submission ID. Format: sub_ followed by 24 lowercase hexadecimal characters. responses: '200': description: Successful response content: application/json: schema: type: object properties: id: type: string pattern: ^sub_[0-9a-f]{24}$ platform: type: string description: 'Platform identifier. Known values: instagram, x, youtube.' url: type: string format: uri platform_media_id: type: string media_type: description: >- Known values: short_video, video, image, carousel, text. On YouTube, short_video means 180 seconds or less and video means longer than 180 seconds. type: - string - 'null' account: type: object properties: id: type: string pattern: ^acct_[0-9a-f]{24}$ username: type: string external_user_id: type: string required: - id - username - external_user_id additionalProperties: false posted_at: anyOf: - type: string format: date-time - type: 'null' status: type: string enum: - active - paused - unavailable - parked - stopped next_read_at: anyOf: - type: string format: date-time - type: 'null' unavailable_reason: description: >- Known values: post_not_found, posted_before_professional, token_invalid, no_linked_account, connection_removed. type: - string - 'null' parked_reason: description: >- Known values: token_invalid, insights_permission_missing, account_not_professional, read_failed. type: - string - 'null' latest: type: object properties: captured_at: anyOf: - type: string format: date-time - type: 'null' views: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' reach: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' likes: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' comments: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' shares: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' saves: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' total_interactions: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' extra: type: object propertyNames: type: string additionalProperties: type: number required: - captured_at - views - reach - likes - comments - shares - saves - total_interactions - extra additionalProperties: false metadata: type: object propertyNames: type: string minLength: 1 maxLength: 40 additionalProperties: type: string maxLength: 500 cadence_hours: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: How often this media is read, in hours. start_at: anyOf: - type: string format: date-time - type: 'null' description: When tracking starts. Null means it started at create. end_at: anyOf: - type: string format: date-time - type: 'null' description: >- When tracking ends. The media becomes stopped at this time. Null means no end date. geo: type: boolean description: >- True when audience data is collected for this media: its account's audience on Instagram, the media's own audience on YouTube. Instagram and YouTube only. created_at: type: string format: date-time required: - id - platform - url - platform_media_id - media_type - account - posted_at - status - next_read_at - unavailable_reason - parked_reason - metadata - cadence_hours - start_at - end_at - geo - created_at additionalProperties: false example: id: sub_8c3f5a7b9d1e2f4a6b8c0d2e platform: x url: https://x.com/i/status/1834567890123456789 platform_media_id: '1834567890123456789' media_type: video account: id: acct_7b2e4d6f8a0c1e3a5c7e9b1d username: acmestudio external_user_id: customer_8f3a2c19 posted_at: '2026-09-10T14:22:00.000Z' status: paused next_read_at: null unavailable_reason: null parked_reason: null latest: captured_at: '2026-09-14T10:00:00.000Z' views: 214300 reach: null likes: 5920 comments: 412 shares: 1036 saves: 880 total_interactions: null extra: quotes: 97 metadata: campaign: fall cadence_hours: 4 start_at: null end_at: null geo: false created_at: '2026-09-10T14:25:43.000Z' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/error.BAD_REQUEST' example: error: code: invalid_request message: The request body or parameters are invalid. request_id: req_01K5A7N8QY2M4C6V9X3J '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/error.UNAUTHORIZED' example: error: code: unauthorized message: Provide a valid API key. request_id: req_01K5A7P2CH8T6R4W9M1B '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/error.NOT_FOUND' example: error: code: not_found message: The requested resource was not found. request_id: req_01K5A7R4WM9C2N6B8X3D '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/error.CONFLICT' example: error: code: conflict message: The request conflicts with the resource state. request_id: req_01K5A7R9HD4K7P2X6N8Q '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR' example: error: code: internal_error message: An unexpected error occurred. request_id: req_01K5A7S6FQ3V8H2N9C4M security: - Authorization: [] components: schemas: error.BAD_REQUEST: type: object properties: message: type: string description: The error message example: Bad request code: type: string description: The error code example: BAD_REQUEST issues: description: An array of issues that were responsible for the error example: [] type: array items: type: object properties: message: type: string required: - message additionalProperties: false required: - message - code additionalProperties: false title: Bad request error (400) description: The error information example: code: BAD_REQUEST message: Bad request issues: [] error.UNAUTHORIZED: type: object properties: message: type: string description: The error message example: Unauthorized code: type: string description: The error code example: UNAUTHORIZED issues: description: An array of issues that were responsible for the error example: [] type: array items: type: object properties: message: type: string required: - message additionalProperties: false required: - message - code additionalProperties: false title: Unauthorized error (401) description: The error information example: code: UNAUTHORIZED message: Unauthorized issues: [] error.NOT_FOUND: type: object properties: message: type: string description: The error message example: Not found code: type: string description: The error code example: NOT_FOUND issues: description: An array of issues that were responsible for the error example: [] type: array items: type: object properties: message: type: string required: - message additionalProperties: false required: - message - code additionalProperties: false title: Not found error (404) description: The error information example: code: NOT_FOUND message: Not found issues: [] error.CONFLICT: type: object properties: message: type: string description: The error message example: Conflict code: type: string description: The error code example: CONFLICT issues: description: An array of issues that were responsible for the error example: [] type: array items: type: object properties: message: type: string required: - message additionalProperties: false required: - message - code additionalProperties: false title: Conflict error (409) description: The error information example: code: CONFLICT message: Conflict issues: [] error.INTERNAL_SERVER_ERROR: type: object properties: message: type: string description: The error message example: Internal server error code: type: string description: The error code example: INTERNAL_SERVER_ERROR issues: description: An array of issues that were responsible for the error example: [] type: array items: type: object properties: message: type: string required: - message additionalProperties: false required: - message - code additionalProperties: false title: Internal server error error (500) description: The error information example: code: INTERNAL_SERVER_ERROR message: Internal server error issues: [] securitySchemes: Authorization: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.