# Cancelar thread ordenada no X URL canônica: https://sosoapi.ai/pt-br/docs/api/studio-api-x-post-threads-cancel Contrato: sha256:304f090f3c014931 Cancele apenas a parte final ainda não enviada de uma thread existente no X, usando suas ações permitidas mais recentes e as expected_versions completas. Os Posts publicados permanecem no lugar. POST /studio-api/x-post-threads/cancel ## Autenticação e permissões - **Classes de credenciais aceitas:** user_session, delegated_oauth, personal_access_token - **Capacidade delegada:** agent:publish - **Função mínima no workspace:** editor - **Escopo de acesso:** Recursos que este usuário tem autorização para acessar - **Consentimento para todos os workspaces obrigatório:** Não - **Altera o estado:** Sim - **Quando a operação estiver concluída:** resultados finais canônicos de publicação por Post; a aceitação da thread não é publicação Um token só pode usar os direitos do seu proprietário. Cada requisição verifica participação no workspace, propriedade de recursos, workspaces selecionados e capacidades concedidas. Os perfis core e full mudam as ferramentas exibidas; não concedem acesso. ## Campos da requisição ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expected_versions": { "type": "object", "propertyNames": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "additionalProperties": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } } }, "required": [ "workspace_id", "id", "expected_versions" ], "additionalProperties": false } ``` ## Resposta e conclusão Códigos HTTP de sucesso: 200 Uma resposta HTTP bem-sucedida pode significar que uma requisição foi aceita, não concluída. Para trabalho em segundo plano, salve o ID retornado e consulte a mesma operação até terminar. Um post agendado ou aceito só está publicado quando a plataforma confirma; um timeout do cliente não comprova o resultado. ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "thread": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workspace_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "social_account_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "idempotency_key": { "type": "string", "minLength": 1, "maxLength": 128 }, "item_count": { "type": "integer", "minimum": 2, "maximum": 25 }, "created_at": { "type": "string" }, "items": { "minItems": 2, "maxItems": 25, "type": "array", "items": { "type": "object", "properties": { "item_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "ordinal": { "type": "integer", "minimum": 1, "maximum": 25 }, "predecessor_post_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, { "type": "null" } ] }, "post": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "workspace_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "social_account_id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "platform": { "type": "string", "enum": [ "instagram", "threads", "facebook", "youtube", "x" ] }, "destination": { "type": "object", "properties": { "social_account_id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "platform": { "type": "string", "enum": [ "instagram", "threads", "facebook", "youtube", "x" ] }, "platform_user_id": { "type": [ "string", "null" ] }, "account_label": { "type": [ "string", "null" ] } }, "required": [ "social_account_id", "platform", "platform_user_id", "account_label" ] }, "caption": { "type": [ "string", "null" ] }, "hashtags": { "type": "array", "items": { "type": "string" } }, "media": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "image", "video" ] }, "url": { "type": "string", "format": "uri" }, "cover_url": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "null" } ] }, "cover_asset_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "asset_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "mime_type": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 160 }, { "type": "null" } ] }, "preview_url": { "description": "Temporary authorized read URL; keep url as persisted Scheduled Post media identity.", "anyOf": [ { "type": "string", "format": "uri" }, { "type": "null" } ] }, "cover_preview_url": { "description": "Temporary authorized cover read URL; keep cover_url as persisted media identity.", "anyOf": [ { "type": "string", "format": "uri" }, { "type": "null" } ] }, "preview_expires_at": { "anyOf": [ { "type": "string", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "format": "date-time" }, { "type": "null" } ] } }, "required": [ "kind", "url" ] } }, "link_url": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "null" } ] }, "publish_options": { "type": "object", "properties": { "post_type": { "type": "string", "enum": [ "TEXT", "LINK", "IMAGE", "MULTI_IMAGE", "VIDEO", "CAROUSEL", "REELS", "STORY_IMAGE", "STORY_VIDEO", "REPOST", "SHORT" ] }, "location_id": { "type": "string", "minLength": 1 }, "share_to_feed": { "type": "boolean" }, "collaborators": { "maxItems": 3, "type": "array", "items": { "type": "string", "minLength": 1 } }, "first_comment": { "type": "string", "minLength": 1, "maxLength": 2200 }, "topic_tag": { "type": "string", "minLength": 1 }, "thumb_offset_ms": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "title": { "type": "string", "maxLength": 255 }, "youtube_privacy_status": { "type": "string", "enum": [ "private", "unlisted", "public" ] }, "youtube_category_id": { "type": "string", "pattern": "^\\d+$" }, "youtube_contains_synthetic_media": { "type": "boolean" }, "description": { "type": "string", "maxLength": 5000 }, "category_id": { "type": "string", "pattern": "^\\d+$" }, "privacy_status": { "type": "string", "enum": [ "private", "unlisted", "public" ] }, "cancellation_mode": { "type": "string", "enum": [ "DELETE", "UNSCHEDULE_KEEP_PRIVATE" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "default_language": { "type": "string" }, "localizations": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "license": { "type": "string", "enum": [ "youtube", "creativeCommon" ] }, "embeddable": { "type": "boolean" }, "public_stats_viewable": { "type": "boolean" }, "self_declared_made_for_kids": { "type": "boolean" }, "contains_synthetic_media": { "type": "boolean" }, "has_paid_product_placement": { "type": "boolean" }, "recording_date": { "type": "string" }, "notify_subscribers": { "type": "boolean" }, "thumbnail_asset_id": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "surface_expectation": { "type": "string", "const": "SHORT" }, "brand_partner": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "cover_asset_id": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "audio_name": { "type": "string" }, "trial_params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "is_ai_generated": { "type": "boolean" }, "branded_content_sponsor_ids": { "type": "array", "items": { "type": "string" } }, "is_paid_partnership": { "type": "boolean" }, "media_options": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "reply_to_id": { "type": "string" }, "quote_post_id": { "type": "string" }, "repost_target_id": { "type": "string" }, "reply_control": { "type": "string" }, "enable_reply_approvals": { "type": "boolean" }, "link_attachment": { "type": "string", "format": "uri" }, "poll_attachment": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "gif_attachment": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "text_attachment": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "text_entities": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "is_spoiler_media": { "type": "boolean" }, "is_ghost_post": { "type": "boolean" }, "allowlisted_country_codes": { "type": "array", "items": { "type": "string" } }, "crossreshare_to_ig": { "type": "boolean" }, "crossreshare_to_ig_dark_mode": { "type": "boolean" }, "auto_publish_text": { "type": "boolean" }, "publication_mode": { "type": "string", "enum": [ "PUBLISH", "DRAFT" ] }, "backdated_time": { "type": "number" }, "backdated_time_granularity": { "type": "string", "enum": [ "year", "month", "day", "hour", "minute" ] }, "place": { "type": "string" }, "feed_targeting": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "targeting": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "child_attachments": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "multi_share_end_card": { "type": "boolean" }, "multi_share_optimized": { "type": "boolean" }, "unpublished_content_type": { "type": "string" }, "no_story": { "type": "boolean" }, "crossposted_video_id": { "type": "string" }, "spherical": { "type": "boolean" } } }, "scheduled_at": { "type": "string" }, "display_timezone": { "type": "string", "minLength": 1, "maxLength": 80 }, "local_scheduled_at": { "anyOf": [ { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,6})?)?$" }, { "type": "null" } ] }, "schedule_timezone": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 80 }, { "type": "null" } ] }, "schedule_dst_disambiguation": { "anyOf": [ { "type": "string", "enum": [ "exact", "earlier", "later" ] }, { "type": "null" } ] }, "schedule_intent_state": { "type": "string", "enum": [ "verified", "legacy_unverified" ] }, "expires_at": { "type": [ "string", "null" ] }, "status": { "type": "string", "enum": [ "scheduled", "publishing", "published", "failed", "expired", "needs_reschedule", "cancelled", "deleted" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "automatic_retry_enabled": { "type": "boolean" }, "delete_requested_at": { "type": [ "string", "null" ] }, "published_at": { "type": [ "string", "null" ] }, "deleted_at": { "type": [ "string", "null" ] }, "provider_post_id": { "type": [ "string", "null" ] }, "permalink": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "null" } ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "project_id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "batch_id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "source_ref": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] } }, "required": [ "id", "workspace_id", "social_account_id", "platform", "destination", "caption", "hashtags", "media", "publish_options", "scheduled_at", "display_timezone", "expires_at", "status", "version", "automatic_retry_enabled", "delete_requested_at", "published_at", "deleted_at", "provider_post_id", "permalink", "created_at", "updated_at", "project_id", "batch_id", "source_ref" ] }, "retry_allowed": { "type": "boolean" } }, "required": [ "item_id", "ordinal", "predecessor_post_id", "post", "retry_allowed" ] } }, "expected_versions": { "type": "object", "propertyNames": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "additionalProperties": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "actions": { "minItems": 2, "maxItems": 2, "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "resume", "cancel" ] }, "allowed": { "type": "boolean" }, "reason_code": { "type": "string", "enum": [ "allowed", "no_failed_items", "resolution_required", "retry_unavailable", "terminal_state" ] }, "message": { "type": "string" } }, "required": [ "action", "allowed", "reason_code", "message" ] } } }, "required": [ "id", "workspace_id", "social_account_id", "idempotency_key", "item_count", "created_at", "items", "expected_versions", "actions" ] }, "deduped": { "type": "boolean" } }, "required": [ "thread" ] } ``` ## Erros e repetições seguras Confira o status HTTP e o corpo da resposta. Um erro de validação 400 pode conter ZodError; erros do handler usam os campos error, message e code. Guarde request_id ou x-request-id para diagnóstico, sem credenciais. Corrija erros de acesso 401/403 antes de tentar novamente e siga Retry-After para 429. Se uma gravação for incerta ou retornar 5xx, consulte primeiro o resultado existente. Reutilize uma chave de idempotência somente quando houver suporte; o comportamento de repetição varia por operação e não garante entrega exatamente uma vez. ## Exemplos Estes exemplos usam valores fictícios verificados conforme os schemas. Substitua os IDs por aqueles que você tem autorização para usar, a mídia por ativos prontos e as datas pelo horário de publicação confirmado. Confira a elegibilidade da conta antes de enviar uma gravação. Esta página não envia requisições de API. Defina SOSOAPI_ACCESS_TOKEN no servidor como uma credencial aceita por esta operação e mantenha-a fora do código do navegador. Para agentes, use sosoapi auth login para entrar pelo navegador e deixe a CLI renovar suas credenciais. request.json ```json { "workspace_id": "11111111-1111-4111-8111-111111111111", "id": "88888888-8888-4888-8888-888888888888", "expected_versions": { "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaa1": 2, "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaa2": 2 } } ``` cURL ```bash curl --request POST \ "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/studio-api/x-post-threads/cancel" \ -H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \ -H "Content-Type: application/json" \ --data-binary @request.json ``` JavaScript ```js // Server-side JavaScript. Do not print tokens or credential-bearing responses. const token = process.env.SOSOAPI_ACCESS_TOKEN; if (!token) throw new Error("Set an accepted credential for this operation"); const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/studio-api/x-post-threads/cancel", { method: "POST", headers: { "Content-Type": "application/json", Authorization: "Bearer " + token }, body: JSON.stringify({ "workspace_id": "11111111-1111-4111-8111-111111111111", "id": "88888888-8888-4888-8888-888888888888", "expected_versions": { "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaa1": 2, "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaa2": 2 } }) }); const result = await response.json(); // Check response.ok, the operation-specific body and completion state before continuing. ``` CLI ```bash npx sosoapi api post /studio-api/x-post-threads/cancel < request.json ``` Exemplo de resposta sintética ```json { "thread": { "workspace_id": "11111111-1111-4111-8111-111111111111", "id": "88888888-8888-4888-8888-888888888888", "social_account_id": "22222222-2222-4222-8222-222222222222", "idempotency_key": "example-x-thread-0001", "item_count": 2, "created_at": "2099-01-15T08:00:00Z", "items": [ { "item_id": "99999999-9999-4999-8999-999999999991", "ordinal": 1, "predecessor_post_id": null, "retry_allowed": false, "post": { "id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaa1", "workspace_id": "11111111-1111-4111-8111-111111111111", "social_account_id": "22222222-2222-4222-8222-222222222222", "platform": "x", "destination": { "social_account_id": "22222222-2222-4222-8222-222222222222", "platform": "x", "platform_user_id": "fictional-x-account", "account_label": "Fictional X account" }, "caption": "A fictional two-part announcement.", "hashtags": [], "media": [], "publish_options": { "post_type": "TEXT" }, "scheduled_at": "2099-01-15T09:00:00Z", "display_timezone": "UTC", "expires_at": null, "status": "cancelled", "version": 3, "automatic_retry_enabled": false, "delete_requested_at": null, "published_at": null, "deleted_at": null, "provider_post_id": null, "permalink": null, "project_id": null, "batch_id": null, "source_ref": null, "created_at": "2099-01-15T08:00:00Z", "updated_at": "2099-01-15T08:30:00Z" } }, { "item_id": "99999999-9999-4999-8999-999999999992", "ordinal": 2, "predecessor_post_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaa1", "retry_allowed": false, "post": { "id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaa2", "workspace_id": "11111111-1111-4111-8111-111111111111", "social_account_id": "22222222-2222-4222-8222-222222222222", "platform": "x", "destination": { "social_account_id": "22222222-2222-4222-8222-222222222222", "platform": "x", "platform_user_id": "fictional-x-account", "account_label": "Fictional X account" }, "caption": "The second part of this fictional announcement.", "hashtags": [], "media": [], "publish_options": { "post_type": "TEXT" }, "scheduled_at": "2099-01-15T09:00:00Z", "display_timezone": "UTC", "expires_at": null, "status": "cancelled", "version": 3, "automatic_retry_enabled": false, "delete_requested_at": null, "published_at": null, "deleted_at": null, "provider_post_id": null, "permalink": null, "project_id": null, "batch_id": null, "source_ref": null, "created_at": "2099-01-15T08:00:00Z", "updated_at": "2099-01-15T08:30:00Z" } } ], "expected_versions": { "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaa1": 3, "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaa2": 3 }, "actions": [ { "action": "resume", "allowed": false, "reason_code": "resolution_required", "message": "This example has no retryable failed items." }, { "action": "cancel", "allowed": false, "reason_code": "terminal_state", "message": "This fictional thread is already cancelled." } ] } } ``` ## Ferramentas e guias relacionados MCP: sosoapi_cancel_x_post_thread [Referência da API](https://sosoapi.ai/pt-br/docs/api)