# Aplicar ação publicitária URL canônica: https://sosoapi.ai/pt-br/docs/api/advertising-api-actions-apply Contrato: sha256:9aedef8d43dd4514 Consuma o token publicitário exato, revisado e de uso único. Após uma resposta incerta, reutilize o ID de ação retornado para consultar o estado; nunca crie uma alteração substituta. POST /advertising-api/actions/apply ## Autenticação e permissões - **Classes de credenciais aceitas:** user_session, delegated_oauth, personal_access_token - **Capacidade delegada:** agent:advertising_manage - **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:** comprovante terminal do provedor 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)$" }, "prepare_token": { "type": "string", "minLength": 32, "maxLength": 128 }, "reviewed_digest": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "workspace_id", "prepare_token", "reviewed_digest" ], "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": { "contract_version": { "type": "string", "const": "advertising/v1" }, "action": { "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)$" }, "advertising_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)$" }, "mutation_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)$" }, "status": { "type": "string", "enum": [ "prepared", "queued", "processing", "succeeded", "failed", "unknown", "cancelled" ] }, "command": { "oneOf": [ { "type": "object", "properties": { "operation": { "type": "string", "const": "create_campaign" }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "budget": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "daily", "lifetime" ] }, "amount_minor": { "type": "string", "pattern": "^[1-9]\\d{0,11}$" } }, "required": [ "kind", "amount_minor" ] }, "objective": { "type": "string", "enum": [ "OUTCOME_AWARENESS", "OUTCOME_ENGAGEMENT", "OUTCOME_LEADS", "OUTCOME_SALES", "OUTCOME_TRAFFIC", "OUTCOME_APP_PROMOTION" ] }, "special_ad_categories": { "default": [], "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "CREDIT", "EMPLOYMENT", "HOUSING", "ISSUES_ELECTIONS_POLITICS" ] } }, "status": { "default": "PAUSED", "type": "string", "const": "PAUSED" } }, "required": [ "operation", "name", "objective", "special_ad_categories", "status" ] }, { "type": "object", "properties": { "operation": { "type": "string", "const": "update_campaign" }, "object_id": { "type": "string", "pattern": "^[1-9]\\d{1,24}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "budget": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "daily", "lifetime" ] }, "amount_minor": { "type": "string", "pattern": "^[1-9]\\d{0,11}$" } }, "required": [ "kind", "amount_minor" ] }, "status": { "type": "string", "enum": [ "ACTIVE", "PAUSED", "ARCHIVED" ] } }, "required": [ "operation", "object_id" ] }, { "type": "object", "properties": { "operation": { "type": "string", "const": "create_adset" }, "campaign_id": { "type": "string", "pattern": "^[1-9]\\d{1,24}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "budget": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "daily", "lifetime" ] }, "amount_minor": { "type": "string", "pattern": "^[1-9]\\d{0,11}$" } }, "required": [ "kind", "amount_minor" ] }, "targeting": { "type": "object", "properties": { "geo_locations": { "type": "object", "properties": { "countries": { "minItems": 1, "maxItems": 25, "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" } } }, "required": [ "countries" ] }, "age_min": { "default": 18, "type": "integer", "minimum": 18, "maximum": 65 }, "age_max": { "default": 65, "type": "integer", "minimum": 18, "maximum": 65 }, "genders": { "minItems": 1, "maxItems": 2, "type": "array", "items": { "anyOf": [ { "type": "number", "const": 1 }, { "type": "number", "const": 2 } ] } }, "locales": { "maxItems": 25, "type": "array", "items": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "publisher_platforms": { "minItems": 1, "maxItems": 3, "type": "array", "items": { "type": "string", "enum": [ "facebook", "instagram", "threads" ] } }, "facebook_positions": { "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "feed", "story", "facebook_reels", "video_feeds" ] } }, "instagram_positions": { "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "stream", "story", "reels", "explore" ] } }, "threads_positions": { "maxItems": 1, "type": "array", "items": { "type": "string", "const": "threads_stream" } }, "custom_audience_ids": { "maxItems": 4, "type": "array", "items": { "type": "string", "pattern": "^[1-9]\\d{1,24}$" } }, "excluded_custom_audience_ids": { "maxItems": 4, "type": "array", "items": { "type": "string", "pattern": "^[1-9]\\d{1,24}$" } } }, "required": [ "geo_locations", "age_min", "age_max", "publisher_platforms" ] }, "billing_event": { "type": "string", "enum": [ "IMPRESSIONS", "LINK_CLICKS" ] }, "optimization_goal": { "type": "string", "enum": [ "REACH", "IMPRESSIONS", "LINK_CLICKS", "LANDING_PAGE_VIEWS", "OFFSITE_CONVERSIONS", "LEAD_GENERATION" ] }, "bid_strategy": { "default": "LOWEST_COST_WITHOUT_CAP", "type": "string", "const": "LOWEST_COST_WITHOUT_CAP" }, "start_time": { "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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "end_time": { "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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "promoted_object": { "type": "object", "properties": { "page_id": { "type": "string", "pattern": "^[1-9]\\d{1,24}$" }, "pixel_id": { "type": "string", "pattern": "^[1-9]\\d{1,24}$" }, "custom_event_type": { "type": "string", "enum": [ "PURCHASE", "LEAD", "COMPLETE_REGISTRATION", "ADD_TO_CART" ] } } }, "status": { "default": "PAUSED", "type": "string", "const": "PAUSED" } }, "required": [ "operation", "campaign_id", "name", "targeting", "billing_event", "optimization_goal", "bid_strategy", "status" ] }, { "type": "object", "properties": { "operation": { "type": "string", "const": "update_adset" }, "object_id": { "type": "string", "pattern": "^[1-9]\\d{1,24}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "budget": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "daily", "lifetime" ] }, "amount_minor": { "type": "string", "pattern": "^[1-9]\\d{0,11}$" } }, "required": [ "kind", "amount_minor" ] }, "status": { "type": "string", "enum": [ "ACTIVE", "PAUSED", "ARCHIVED" ] }, "targeting": { "type": "object", "properties": { "geo_locations": { "type": "object", "properties": { "countries": { "minItems": 1, "maxItems": 25, "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" } } }, "required": [ "countries" ] }, "age_min": { "default": 18, "type": "integer", "minimum": 18, "maximum": 65 }, "age_max": { "default": 65, "type": "integer", "minimum": 18, "maximum": 65 }, "genders": { "minItems": 1, "maxItems": 2, "type": "array", "items": { "anyOf": [ { "type": "number", "const": 1 }, { "type": "number", "const": 2 } ] } }, "locales": { "maxItems": 25, "type": "array", "items": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "publisher_platforms": { "minItems": 1, "maxItems": 3, "type": "array", "items": { "type": "string", "enum": [ "facebook", "instagram", "threads" ] } }, "facebook_positions": { "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "feed", "story", "facebook_reels", "video_feeds" ] } }, "instagram_positions": { "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "stream", "story", "reels", "explore" ] } }, "threads_positions": { "maxItems": 1, "type": "array", "items": { "type": "string", "const": "threads_stream" } }, "custom_audience_ids": { "maxItems": 4, "type": "array", "items": { "type": "string", "pattern": "^[1-9]\\d{1,24}$" } }, "excluded_custom_audience_ids": { "maxItems": 4, "type": "array", "items": { "type": "string", "pattern": "^[1-9]\\d{1,24}$" } } }, "required": [ "geo_locations", "age_min", "age_max", "publisher_platforms" ] }, "start_time": { "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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "end_time": { "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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" } }, "required": [ "operation", "object_id" ] }, { "type": "object", "properties": { "operation": { "type": "string", "const": "create_ad" }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "adset_id": { "type": "string", "pattern": "^[1-9]\\d{1,24}$" }, "creative_id": { "type": "string", "pattern": "^[1-9]\\d{1,24}$" }, "status": { "default": "PAUSED", "type": "string", "const": "PAUSED" } }, "required": [ "operation", "name", "adset_id", "creative_id", "status" ] }, { "type": "object", "properties": { "operation": { "type": "string", "const": "update_ad" }, "object_id": { "type": "string", "pattern": "^[1-9]\\d{1,24}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "creative_id": { "type": "string", "pattern": "^[1-9]\\d{1,24}$" }, "status": { "type": "string", "enum": [ "ACTIVE", "PAUSED", "ARCHIVED" ] } }, "required": [ "operation", "object_id" ] }, { "type": "object", "properties": { "operation": { "type": "string", "const": "create_creative" }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "object_story_spec": { "type": "object", "properties": { "page_id": { "type": "string", "pattern": "^[1-9]\\d{1,24}$" }, "instagram_user_id": { "type": "string", "pattern": "^[1-9]\\d{1,24}$" }, "link_data": { "type": "object", "properties": { "link": { "type": "string", "maxLength": 2048, "format": "uri" }, "message": { "type": "string", "maxLength": 5000 }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "image_hash": { "type": "string", "pattern": "^[a-fA-F0-9]{16,128}$" }, "call_to_action": { "type": "string", "enum": [ "LEARN_MORE", "SHOP_NOW", "SIGN_UP", "CONTACT_US" ] } }, "required": [ "link", "message", "image_hash" ] } }, "required": [ "page_id", "link_data" ] }, "object_story_id": { "type": "string", "pattern": "^[1-9]\\d{1,24}_[1-9]\\d{1,24}$" } }, "required": [ "operation", "name" ] }, { "type": "object", "properties": { "operation": { "type": "string", "const": "create_saved_audience" }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "targeting": { "type": "object", "properties": { "geo_locations": { "type": "object", "properties": { "countries": { "minItems": 1, "maxItems": 25, "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" } } }, "required": [ "countries" ] }, "age_min": { "default": 18, "type": "integer", "minimum": 18, "maximum": 65 }, "age_max": { "default": 65, "type": "integer", "minimum": 18, "maximum": 65 }, "genders": { "minItems": 1, "maxItems": 2, "type": "array", "items": { "anyOf": [ { "type": "number", "const": 1 }, { "type": "number", "const": 2 } ] } }, "locales": { "maxItems": 25, "type": "array", "items": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "publisher_platforms": { "minItems": 1, "maxItems": 3, "type": "array", "items": { "type": "string", "enum": [ "facebook", "instagram", "threads" ] } }, "facebook_positions": { "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "feed", "story", "facebook_reels", "video_feeds" ] } }, "instagram_positions": { "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "stream", "story", "reels", "explore" ] } }, "threads_positions": { "maxItems": 1, "type": "array", "items": { "type": "string", "const": "threads_stream" } }, "custom_audience_ids": { "maxItems": 4, "type": "array", "items": { "type": "string", "pattern": "^[1-9]\\d{1,24}$" } }, "excluded_custom_audience_ids": { "maxItems": 4, "type": "array", "items": { "type": "string", "pattern": "^[1-9]\\d{1,24}$" } } }, "required": [ "geo_locations", "age_min", "age_max", "publisher_platforms" ] } }, "required": [ "operation", "name", "targeting" ] }, { "type": "object", "properties": { "operation": { "type": "string", "const": "update_saved_audience" }, "object_id": { "type": "string", "pattern": "^[1-9]\\d{1,24}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "targeting": { "type": "object", "properties": { "geo_locations": { "type": "object", "properties": { "countries": { "minItems": 1, "maxItems": 25, "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" } } }, "required": [ "countries" ] }, "age_min": { "default": 18, "type": "integer", "minimum": 18, "maximum": 65 }, "age_max": { "default": 65, "type": "integer", "minimum": 18, "maximum": 65 }, "genders": { "minItems": 1, "maxItems": 2, "type": "array", "items": { "anyOf": [ { "type": "number", "const": 1 }, { "type": "number", "const": 2 } ] } }, "locales": { "maxItems": 25, "type": "array", "items": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "publisher_platforms": { "minItems": 1, "maxItems": 3, "type": "array", "items": { "type": "string", "enum": [ "facebook", "instagram", "threads" ] } }, "facebook_positions": { "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "feed", "story", "facebook_reels", "video_feeds" ] } }, "instagram_positions": { "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "stream", "story", "reels", "explore" ] } }, "threads_positions": { "maxItems": 1, "type": "array", "items": { "type": "string", "const": "threads_stream" } }, "custom_audience_ids": { "maxItems": 4, "type": "array", "items": { "type": "string", "pattern": "^[1-9]\\d{1,24}$" } }, "excluded_custom_audience_ids": { "maxItems": 4, "type": "array", "items": { "type": "string", "pattern": "^[1-9]\\d{1,24}$" } } }, "required": [ "geo_locations", "age_min", "age_max", "publisher_platforms" ] } }, "required": [ "operation", "object_id" ] } ] }, "reviewed_digest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "effects": { "type": "object", "properties": { "creates_object": { "type": "boolean" }, "initial_status": { "anyOf": [ { "type": "string", "const": "PAUSED" }, { "type": "null" } ] }, "activates_delivery": { "type": "boolean" }, "changes_budget": { "type": "boolean" }, "changes_audience": { "type": "boolean" }, "changes_creative": { "type": "boolean" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "budget": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "daily", "lifetime" ] }, "amount_minor": { "type": "string", "pattern": "^[1-9]\\d{0,11}$" } }, "required": [ "kind", "amount_minor" ] }, { "type": "null" } ] } }, "required": [ "creates_object", "initial_status", "activates_delivery", "changes_budget", "changes_audience", "changes_creative", "currency", "timezone", "budget" ] }, "live_approval": { "type": "object", "properties": { "required": { "type": "boolean" }, "state": { "type": "string", "enum": [ "not_required", "missing", "approved", "expired", "revoked", "invalid" ] }, "reason": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] }, "approved_by": { "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" } ] } }, "required": [ "required", "state", "reason", "expires_at", "approved_by" ] }, "provider_object_id": { "anyOf": [ { "type": "string", "pattern": "^[1-9]\\d{1,24}$" }, { "type": "null" } ] }, "failure_code": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "created_at": { "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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "completed_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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] } }, "required": [ "id", "workspace_id", "advertising_account_id", "mutation_id", "status", "command", "reviewed_digest", "effects", "live_approval", "provider_object_id", "failure_code", "created_at", "completed_at" ] }, "replayed": { "type": "boolean" } }, "required": [ "contract_version", "action", "replayed" ] } ``` ## 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 de IA, 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", "prepare_token": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa", "reviewed_digest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ``` cURL ```bash curl --request POST \ "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/advertising-api/actions/apply" \ -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/advertising-api/actions/apply", { method: "POST", headers: { "Content-Type": "application/json", Authorization: "Bearer " + token }, body: JSON.stringify({ "workspace_id": "11111111-1111-4111-8111-111111111111", "prepare_token": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa", "reviewed_digest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }) }); const result = await response.json(); // Check response.ok, the operation-specific body and completion state before continuing. ``` CLI ```bash npx sosoapi api post /advertising-api/actions/apply < request.json ``` Exemplo de resposta sintética ```json { "contract_version": "advertising/v1", "action": { "id": "11111111-1111-4111-8111-111111111111", "workspace_id": "11111111-1111-4111-8111-111111111111", "advertising_account_id": "11111111-1111-4111-8111-111111111111", "mutation_id": "11111111-1111-4111-8111-111111111111", "status": "prepared", "command": { "operation": "create_campaign", "name": "example", "objective": "OUTCOME_AWARENESS", "special_ad_categories": [], "status": "PAUSED" }, "reviewed_digest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "effects": { "creates_object": false, "initial_status": null, "activates_delivery": false, "changes_budget": false, "changes_audience": false, "changes_creative": false, "currency": "USD", "timezone": "UTC", "budget": null }, "live_approval": { "required": false, "state": "not_required", "reason": null, "expires_at": null, "approved_by": null }, "provider_object_id": null, "failure_code": null, "created_at": "2099-01-15T09:00:00Z", "completed_at": null }, "replayed": false } ``` ## Ferramentas e guias relacionados MCP: sosoapi_ads_actions_apply [Referência da API](https://sosoapi.ai/pt-br/docs/api)