A busca carrega apenas quando você a usa. Explore todas as categorias abaixo.

Agendamento e publicação

Cancelar post agendado

Cancele um post agendado ainda não publicado para que ele nunca seja enviado. Um post publicado é recusado, e um agente também não pode excluir conteúdo publicado: o usuário faz isso no app web. Exige expected_version.

POST /studio-api/scheduled-posts/cancel

Contrato revisado: · sha256:563d2d581da0ad29

Visão geral

Cancele um post agendado ainda não publicado para que ele nunca seja enviado. Um post publicado é recusado, e um agente também não pode excluir conteúdo publicado: o usuário faz isso no app web. Exige expected_version.

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.

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
terminal publication outcome

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

Obrigatório significa obrigatório dentro do objeto pai e da ramificação selecionada. Um filho obrigatório não torna obrigatório um pai opcional. As regras e nomes de campos abaixo são copiados do contrato.

Campos da requisição
Campo / ramificaçãoTipo / obrigatórioRestrições
$objectObrigatório no objeto pai
  • additionalProperties: false
idstringObrigatório no objeto pai
  • 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}$"
expected_versionintegerObrigatório no objeto pai
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
JSON Schema completo
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "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}$"
    },
    "expected_version": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "id",
    "expected_version"
  ],
  "additionalProperties": false
}

Resposta e conclusão

Códigos HTTP de sucesso: 200. Quando a operação estiver concluída: terminal publication outcome.

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.

Obrigatório significa obrigatório dentro do objeto pai e da ramificação selecionada. Um filho obrigatório não torna obrigatório um pai opcional. As regras e nomes de campos abaixo são copiados do contrato.

Resposta e conclusão
Campo / ramificaçãoTipo / obrigatórioRestrições
$objectObrigatório no objeto pai—
postobjectObrigatório no objeto pai—
post.idstringObrigatório no objeto pai
  • 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}$"
post.workspace_idstringObrigatório no objeto pai
  • 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)$"
post.social_account_idstring | nullObrigatório no objeto pai—
post.social_account_idanyOf 1stringObrigatório no objeto pai
  • 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)$"
post.social_account_idanyOf 2nullObrigatório no objeto pai—
post.platformstringObrigatório no objeto pai
  • enum: ["instagram","threads","facebook","youtube","x"]
post.destinationobjectObrigatório no objeto pai—
post.destination.social_account_idstring | nullObrigatório no objeto pai—
post.destination.social_account_idanyOf 1stringObrigatório no objeto pai
  • 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)$"
post.destination.social_account_idanyOf 2nullObrigatório no objeto pai—
post.destination.platformstringObrigatório no objeto pai
  • enum: ["instagram","threads","facebook","youtube","x"]
post.destination.platform_user_idstring | nullObrigatório no objeto pai—
post.destination.platform_user_idanyOf 1stringObrigatório no objeto pai—
post.destination.platform_user_idanyOf 2nullObrigatório no objeto pai—
post.destination.account_labelstring | nullObrigatório no objeto pai—
post.destination.account_labelanyOf 1stringObrigatório no objeto pai—
post.destination.account_labelanyOf 2nullObrigatório no objeto pai—
post.captionstring | nullObrigatório no objeto pai—
post.captionanyOf 1stringObrigatório no objeto pai—
post.captionanyOf 2nullObrigatório no objeto pai—
post.hashtagsarrayObrigatório no objeto pai—
post.hashtags[]stringOpcional / item—
post.mediaarrayObrigatório no objeto pai—
post.media[]objectOpcional / item—
post.media[].kindstringObrigatório no objeto pai
  • enum: ["image","video"]
post.media[].urlstringObrigatório no objeto pai
  • format: "uri"
post.media[].cover_urlstring | nullOpcional / item—
post.media[].cover_urlanyOf 1stringOpcional / item
  • format: "uri"
post.media[].cover_urlanyOf 2nullOpcional / item—
post.media[].cover_asset_idinteger | nullOpcional / item—
post.media[].cover_asset_idanyOf 1integerOpcional / item
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
post.media[].cover_asset_idanyOf 2nullOpcional / item—
post.media[].asset_idinteger | nullOpcional / item—
post.media[].asset_idanyOf 1integerOpcional / item
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
post.media[].asset_idanyOf 2nullOpcional / item—
post.media[].mime_typestring | nullOpcional / item—
post.media[].mime_typeanyOf 1stringOpcional / item
  • minLength: 1
  • maxLength: 160
post.media[].mime_typeanyOf 2nullOpcional / item—
post.media[].preview_urlstring | nullOpcional / item

URL temporária autorizada de leitura; mantenha url como identidade persistida da mídia do Scheduled Post.

—
post.media[].preview_urlanyOf 1stringOpcional / item
  • format: "uri"
post.media[].preview_urlanyOf 2nullOpcional / item—
post.media[].cover_preview_urlstring | nullOpcional / item

URL temporária autorizada de leitura de capa; mantenha cover_url como identidade persistida da mídia.

—
post.media[].cover_preview_urlanyOf 1stringOpcional / item
  • format: "uri"
post.media[].cover_preview_urlanyOf 2nullOpcional / item—
post.media[].preview_expires_atstring | nullOpcional / item—
post.media[].preview_expires_atanyOf 1stringOpcional / item
  • format: "date-time"
  • 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))$"
post.media[].preview_expires_atanyOf 2nullOpcional / item—
post.link_urlstring | nullOpcional / item—
post.link_urlanyOf 1stringOpcional / item
  • format: "uri"
post.link_urlanyOf 2nullOpcional / item—
post.publish_optionsobjectObrigatório no objeto pai—
post.publish_options.post_typestringOpcional / item
  • enum: ["TEXT","LINK","IMAGE","MULTI_IMAGE","VIDEO","CAROUSEL","REELS","STORY_IMAGE","STORY_VIDEO","REPOST","SHORT"]
post.publish_options.location_idstringOpcional / item
  • minLength: 1
post.publish_options.share_to_feedbooleanOpcional / item—
post.publish_options.collaboratorsarrayOpcional / item
  • maxItems: 3
post.publish_options.collaborators[]stringOpcional / item
  • minLength: 1
post.publish_options.first_commentstringOpcional / item
  • minLength: 1
  • maxLength: 2200
post.publish_options.topic_tagstringOpcional / item
  • minLength: 1
post.publish_options.thumb_offset_msintegerOpcional / item
  • minimum: 0
  • maximum: 9007199254740991
post.publish_options.titlestringOpcional / item
  • maxLength: 255
post.publish_options.youtube_privacy_statusstringOpcional / item
  • enum: ["private","unlisted","public"]
post.publish_options.youtube_category_idstringOpcional / item
  • pattern: "^\\d+$"
post.publish_options.youtube_contains_synthetic_mediabooleanOpcional / item—
post.publish_options.descriptionstringOpcional / item
  • maxLength: 5000
post.publish_options.category_idstringOpcional / item
  • pattern: "^\\d+$"
post.publish_options.privacy_statusstringOpcional / item
  • enum: ["private","unlisted","public"]
post.publish_options.cancellation_modestringOpcional / item
  • enum: ["DELETE","UNSCHEDULE_KEEP_PRIVATE"]
post.publish_options.tagsarrayOpcional / item—
post.publish_options.tags[]stringOpcional / item—
post.publish_options.default_languagestringOpcional / item—
post.publish_options.localizationsobjectOpcional / item
  • additionalProperties: {}
post.publish_options.localizations.*any JSON valueOpcional / item—
post.publish_options.licensestringOpcional / item
  • enum: ["youtube","creativeCommon"]
post.publish_options.embeddablebooleanOpcional / item—
post.publish_options.public_stats_viewablebooleanOpcional / item—
post.publish_options.self_declared_made_for_kidsbooleanOpcional / item—
post.publish_options.contains_synthetic_mediabooleanOpcional / item—
post.publish_options.has_paid_product_placementbooleanOpcional / item—
post.publish_options.recording_datestringOpcional / item—
post.publish_options.notify_subscribersbooleanOpcional / item—
post.publish_options.thumbnail_asset_idintegerOpcional / item
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
post.publish_options.surface_expectationstringOpcional / item
  • const: "SHORT"
post.publish_options.brand_partnerobjectOpcional / item
  • additionalProperties: {}
post.publish_options.brand_partner.*any JSON valueOpcional / item—
post.publish_options.cover_asset_idintegerOpcional / item
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
post.publish_options.audio_namestringOpcional / item—
post.publish_options.trial_paramsobjectOpcional / item
  • additionalProperties: {}
post.publish_options.trial_params.*any JSON valueOpcional / item—
post.publish_options.is_ai_generatedbooleanOpcional / item—
post.publish_options.branded_content_sponsor_idsarrayOpcional / item—
post.publish_options.branded_content_sponsor_ids[]stringOpcional / item—
post.publish_options.is_paid_partnershipbooleanOpcional / item—
post.publish_options.media_optionsarrayOpcional / item—
post.publish_options.media_options[]objectOpcional / item
  • additionalProperties: {}
post.publish_options.media_options[].*any JSON valueOpcional / item—
post.publish_options.reply_to_idstringOpcional / item—
post.publish_options.quote_post_idstringOpcional / item—
post.publish_options.repost_target_idstringOpcional / item—
post.publish_options.reply_controlstringOpcional / item—
post.publish_options.enable_reply_approvalsbooleanOpcional / item—
post.publish_options.link_attachmentstringOpcional / item
  • format: "uri"
post.publish_options.poll_attachmentobjectOpcional / item
  • additionalProperties: {}
post.publish_options.poll_attachment.*any JSON valueOpcional / item—
post.publish_options.gif_attachmentobjectOpcional / item
  • additionalProperties: {}
post.publish_options.gif_attachment.*any JSON valueOpcional / item—
post.publish_options.text_attachmentobjectOpcional / item
  • additionalProperties: {}
post.publish_options.text_attachment.*any JSON valueOpcional / item—
post.publish_options.text_entitiesarrayOpcional / item—
post.publish_options.text_entities[]objectOpcional / item
  • additionalProperties: {}
post.publish_options.text_entities[].*any JSON valueOpcional / item—
post.publish_options.is_spoiler_mediabooleanOpcional / item—
post.publish_options.is_ghost_postbooleanOpcional / item—
post.publish_options.allowlisted_country_codesarrayOpcional / item—
post.publish_options.allowlisted_country_codes[]stringOpcional / item—
post.publish_options.crossreshare_to_igbooleanOpcional / item—
post.publish_options.crossreshare_to_ig_dark_modebooleanOpcional / item—
post.publish_options.auto_publish_textbooleanOpcional / item—
post.publish_options.publication_modestringOpcional / item
  • enum: ["PUBLISH","DRAFT"]
post.publish_options.backdated_timenumberOpcional / item—
post.publish_options.backdated_time_granularitystringOpcional / item
  • enum: ["year","month","day","hour","minute"]
post.publish_options.placestringOpcional / item—
post.publish_options.feed_targetingobjectOpcional / item
  • additionalProperties: {}
post.publish_options.feed_targeting.*any JSON valueOpcional / item—
post.publish_options.targetingobjectOpcional / item
  • additionalProperties: {}
post.publish_options.targeting.*any JSON valueOpcional / item—
post.publish_options.child_attachmentsarrayOpcional / item—
post.publish_options.child_attachments[]objectOpcional / item
  • additionalProperties: {}
post.publish_options.child_attachments[].*any JSON valueOpcional / item—
post.publish_options.multi_share_end_cardbooleanOpcional / item—
post.publish_options.multi_share_optimizedbooleanOpcional / item—
post.publish_options.unpublished_content_typestringOpcional / item—
post.publish_options.no_storybooleanOpcional / item—
post.publish_options.crossposted_video_idstringOpcional / item—
post.publish_options.sphericalbooleanOpcional / item—
post.scheduled_atstringObrigatório no objeto pai—
post.display_timezonestringObrigatório no objeto pai
  • minLength: 1
  • maxLength: 80
post.local_scheduled_atstring | nullOpcional / item—
post.local_scheduled_atanyOf 1stringOpcional / item
  • pattern: "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,6})?)?$"
post.local_scheduled_atanyOf 2nullOpcional / item—
post.schedule_timezonestring | nullOpcional / item—
post.schedule_timezoneanyOf 1stringOpcional / item
  • minLength: 1
  • maxLength: 80
post.schedule_timezoneanyOf 2nullOpcional / item—
post.schedule_dst_disambiguationstring | nullOpcional / item—
post.schedule_dst_disambiguationanyOf 1stringOpcional / item
  • enum: ["exact","earlier","later"]
post.schedule_dst_disambiguationanyOf 2nullOpcional / item—
post.schedule_intent_statestringOpcional / item
  • enum: ["verified","legacy_unverified"]
post.expires_atstring | nullObrigatório no objeto pai—
post.expires_atanyOf 1stringObrigatório no objeto pai—
post.expires_atanyOf 2nullObrigatório no objeto pai—
post.statusstringObrigatório no objeto pai
  • enum: ["scheduled","publishing","published","failed","expired","needs_reschedule","cancelled","deleted"]
post.versionintegerObrigatório no objeto pai
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
post.automatic_retry_enabledbooleanObrigatório no objeto pai—
post.delete_requested_atstring | nullObrigatório no objeto pai—
post.delete_requested_atanyOf 1stringObrigatório no objeto pai—
post.delete_requested_atanyOf 2nullObrigatório no objeto pai—
post.published_atstring | nullObrigatório no objeto pai—
post.published_atanyOf 1stringObrigatório no objeto pai—
post.published_atanyOf 2nullObrigatório no objeto pai—
post.deleted_atstring | nullObrigatório no objeto pai—
post.deleted_atanyOf 1stringObrigatório no objeto pai—
post.deleted_atanyOf 2nullObrigatório no objeto pai—
post.provider_post_idstring | nullObrigatório no objeto pai—
post.provider_post_idanyOf 1stringObrigatório no objeto pai—
post.provider_post_idanyOf 2nullObrigatório no objeto pai—
post.permalinkstring | nullObrigatório no objeto pai—
post.permalinkanyOf 1stringObrigatório no objeto pai
  • format: "uri"
post.permalinkanyOf 2nullObrigatório no objeto pai—
post.created_atstringObrigatório no objeto pai—
post.updated_atstringObrigatório no objeto pai—
post.project_idstring | nullObrigatório no objeto pai—
post.project_idanyOf 1stringObrigatório no objeto pai
  • 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)$"
post.project_idanyOf 2nullObrigatório no objeto pai—
post.batch_idstring | nullObrigatório no objeto pai—
post.batch_idanyOf 1stringObrigatório no objeto pai
  • 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)$"
post.batch_idanyOf 2nullObrigatório no objeto pai—
post.source_refobject | nullObrigatório no objeto pai—
post.source_refanyOf 1objectObrigatório no objeto pai
  • additionalProperties: {}
post.source_ref.*anyOf 1any JSON valueOpcional / item—
post.source_refanyOf 2nullObrigatório no objeto pai—
JSON Schema completo
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "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": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "account_label": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          "required": [
            "social_account_id",
            "platform",
            "platform_user_id",
            "account_label"
          ]
        },
        "caption": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "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",
                    "format": "date-time",
                    "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))$"
                  },
                  {
                    "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": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "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": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "published_at": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "deleted_at": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "provider_post_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "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"
      ]
    }
  },
  "required": [
    "post"
  ]
}

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.

Guia de solução de problemas

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

{
  "id": "11111111-1111-4111-8111-111111111111",
  "expected_version": 1
}

cURL

curl --request POST \
  "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/studio-api/scheduled-posts/cancel" \
  -H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  --data-binary @request.json

JavaScript

// 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/scheduled-posts/cancel", {
  method: "POST",
  headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
  body: JSON.stringify({
  "id": "11111111-1111-4111-8111-111111111111",
  "expected_version": 1
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.

CLI

npx sosoapi api post /studio-api/scheduled-posts/cancel < request.json

Exemplo de resposta sintética

{
  "post": {
    "id": "11111111-1111-4111-8111-111111111111",
    "workspace_id": "11111111-1111-4111-8111-111111111111",
    "social_account_id": null,
    "platform": "instagram",
    "destination": {
      "social_account_id": null,
      "platform": "instagram",
      "platform_user_id": null,
      "account_label": null
    },
    "caption": null,
    "hashtags": [],
    "media": [],
    "publish_options": {},
    "scheduled_at": "example",
    "display_timezone": "UTC",
    "expires_at": null,
    "status": "scheduled",
    "version": 1,
    "automatic_retry_enabled": false,
    "delete_requested_at": null,
    "published_at": null,
    "deleted_at": null,
    "provider_post_id": null,
    "permalink": null,
    "created_at": "example",
    "updated_at": "example",
    "project_id": null,
    "batch_id": null,
    "source_ref": null
  }
}

MCP: sosoapi_cancel_scheduled_post