{"info":{"_postman_id":"achadu-developer-api-v1","name":"Achadu Developer API v1","description":"Official collection generated from the same catalog of 121 REST, MCP, and CLI operations.","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"auth":{"type":"bearer","bearer":[{"key":"token","value":"{{api_key}}","type":"string"}]},"variable":[{"key":"base_url","value":"https://achadu.com/api/v1","type":"string"},{"key":"api_key","value":"ach_live_...","type":"string"}],"item":[{"name":"Account","item":[{"name":"View account","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/me","host":["{{base_url}}"],"path":["me"],"query":[]},"description":"Returns the operation and actor linked to the key.\n\nRequired scope: `account:read`."},"response":[]}]},{"name":"Offers","item":[{"name":"List offers","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/offers","host":["{{base_url}}"],"path":["offers"],"query":[{"key":"limit","value":"30","disabled":true,"description":"Quantidade por página."},{"key":"offset","value":"0","disabled":true,"description":"Deslocamento da paginação."},{"key":"status","value":"string","disabled":true,"description":"Estado de curadoria."},{"key":"marketplace","value":"string","disabled":true,"description":"Marketplace."},{"key":"query","value":"string","disabled":true,"description":"Busca por título ou loja."}]},"description":"List offers with status, marketplace and text filters.\n\nRequired scope: `offers:read`."},"response":[]},{"name":"Create offer","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/offers","host":["{{base_url}}"],"path":["offers"],"query":[]},"description":"Creates a pending offer without publishing it.\n\nRequired scope: `offers:write`.","body":{"mode":"raw","raw":"{\n  \"url\": \"https://example.com/product\",\n  \"title\": \"Air fryer 5L\",\n  \"marketplace\": \"string\",\n  \"price\": 329.9,\n  \"original_price\": 329.9,\n  \"currency\": \"BRL\",\n  \"image\": \"https://cdn.example.com/image.jpg\",\n  \"store\": \"string\",\n  \"category\": \"string\",\n  \"coupon\": \"string\",\n  \"copy\": \"string\",\n  \"status\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"View offer","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/offers/:id","host":["{{base_url}}"],"path":["offers",":id"],"query":[]},"description":"Returns the editorial and commercial details of an offer.\n\nRequired scope: `offers:read`."},"response":[]},{"name":"Update offer","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/offers/:id","host":["{{base_url}}"],"path":["offers",":id"],"query":[]},"description":"Updates only the submitted fields.\n\nRequired scope: `offers:write`.","body":{"mode":"raw","raw":"{\n  \"url\": \"https://example.com/product\",\n  \"title\": \"Air fryer 5L\",\n  \"marketplace\": \"string\",\n  \"price\": 329.9,\n  \"original_price\": 329.9,\n  \"currency\": \"BRL\",\n  \"image\": \"https://cdn.example.com/image.jpg\",\n  \"store\": \"string\",\n  \"category\": \"string\",\n  \"coupon\": \"string\",\n  \"copy\": \"string\",\n  \"status\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Archive offer","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/offers/:id","host":["{{base_url}}"],"path":["offers",":id"],"query":[]},"description":"Removes the offer from the active flow without deleting the history.\n\nRequired scope: `offers:write`."},"response":[]},{"name":"Preview post","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/offers/:id/preview","host":["{{base_url}}"],"path":["offers",":id","preview"],"query":[]},"description":"Assemble the final message without sending it to any channel.\n\nRequired scope: `offers:read`.","body":{"mode":"raw","raw":"{\n  \"segment_id\": \"segment_id\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Post offer","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/offers/:id/publish","host":["{{base_url}}"],"path":["offers",":id","publish"],"query":[]},"description":"Queues the offer's publication to an authorized group or thread.\n\nRequired scope: `publications:write`.","body":{"mode":"raw","raw":"{\n  \"segment_id\": \"segment_id\",\n  \"group_id\": \"group_id\",\n  \"with_image\": true\n}","options":{"raw":{"language":"json"}}}},"response":[]}]},{"name":"Groups","item":[{"name":"List groups","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/groups","host":["{{base_url}}"],"path":["groups"],"query":[{"key":"limit","value":"30","disabled":true,"description":"Quantidade por página."},{"key":"offset","value":"0","disabled":true,"description":"Deslocamento da paginação."}]},"description":"Lists groups without exposing JIDs, sessions, or credentials.\n\nRequired scope: `groups:read`."},"response":[]},{"name":"View group","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/groups/:id","host":["{{base_url}}"],"path":["groups",":id"],"query":[]},"description":"Returns secure operational configuration of the group.\n\nRequired scope: `groups:read`."},"response":[]},{"name":"Update group","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/groups/:id","host":["{{base_url}}"],"path":["groups",":id"],"query":[]},"description":"Updates name, segment, capacity and automation.\n\nRequired scope: `groups:write`.","body":{"mode":"raw","raw":"{\n  \"name\": \"My integration\",\n  \"role\": \"string\",\n  \"segment_id\": \"segment_id\",\n  \"capacity\": 1,\n  \"automation\": true,\n  \"active\": true\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Create group destination","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/groups","host":["{{base_url}}"],"path":["groups"],"query":[]},"description":"Registers a group already authorized by the account connector.\n\nRequired scope: `groups:write`.","body":{"mode":"raw","raw":"{\n  \"name\": \"My integration\",\n  \"external_id\": \"external_id\",\n  \"connection_id\": \"connection_id\",\n  \"segment_id\": \"segment_id\",\n  \"role\": \"string\",\n  \"capacity\": 1,\n  \"automation\": true\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Archive group","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/groups/:id","host":["{{base_url}}"],"path":["groups",":id"],"query":[]},"description":"Deactivate the destination without deleting the publication history.\n\nRequired scope: `groups:write`."},"response":[]},{"name":"Check group activity","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/groups/:id/activity","host":["{{base_url}}"],"path":["groups",":id","activity"],"query":[{"key":"days","value":"30","disabled":true,"description":"Janela de análise em dias."}]},"description":"Summarize entries, exits and publications without revealing participants.\n\nRequired scope: `groups:read`."},"response":[]}]},{"name":"Segments","item":[{"name":"List segments","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/segments","host":["{{base_url}}"],"path":["segments"],"query":[{"key":"limit","value":"30","disabled":true,"description":"Quantidade por página."},{"key":"offset","value":"0","disabled":true,"description":"Deslocamento da paginação."}]},"description":"List niches and storefront configurations.\n\nRequired scope: `segments:read`."},"response":[]},{"name":"Create segment","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/segments","host":["{{base_url}}"],"path":["segments"],"query":[]},"description":"Create a niche with your storefront setup.\n\nRequired scope: `segments:write`.","body":{"mode":"raw","raw":"{\n  \"name\": \"My integration\",\n  \"slug\": \"string\",\n  \"description\": \"string\",\n  \"store_name\": \"string\",\n  \"store_tagline\": \"string\",\n  \"store_color\": \"string\",\n  \"auto_expand\": true,\n  \"distribution\": \"string\",\n  \"waitlist\": true\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"View segment","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/segments/:id","host":["{{base_url}}"],"path":["segments",":id"],"query":[]},"description":"Returns a segment of the operation.\n\nRequired scope: `segments:read`."},"response":[]},{"name":"Update segment","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/segments/:id","host":["{{base_url}}"],"path":["segments",":id"],"query":[]},"description":"Updates the segment's identity, distribution and showcase.\n\nRequired scope: `segments:write`.","body":{"mode":"raw","raw":"{\n  \"name\": \"My integration\",\n  \"slug\": \"string\",\n  \"description\": \"string\",\n  \"store_name\": \"string\",\n  \"store_tagline\": \"string\",\n  \"store_color\": \"string\",\n  \"auto_expand\": true,\n  \"distribution\": \"string\",\n  \"waitlist\": true\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Delete segment","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/segments/:id","host":["{{base_url}}"],"path":["segments",":id"],"query":[]},"description":"Deletes only when there are no linked groups or calendars.\n\nRequired scope: `segments:write`."},"response":[]}]},{"name":"Coupons","item":[{"name":"List coupons","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/coupons","host":["{{base_url}}"],"path":["coupons"],"query":[{"key":"limit","value":"30","disabled":true,"description":"Quantidade por página."},{"key":"offset","value":"0","disabled":true,"description":"Deslocamento da paginação."}]},"description":"Lists active and verified coupons for the operation.\n\nRequired scope: `coupons:read`."},"response":[]},{"name":"Create coupon","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/coupons","host":["{{base_url}}"],"path":["coupons"],"query":[]},"description":"Register a coupon to use in offers.\n\nRequired scope: `coupons:write`.","body":{"mode":"raw","raw":"{\n  \"marketplace\": \"string\",\n  \"code\": \"string\",\n  \"description\": \"string\",\n  \"value\": \"string\",\n  \"minimum\": 10,\n  \"valid_until\": \"string\",\n  \"type\": \"string\",\n  \"discount\": 10,\n  \"cap\": 10,\n  \"categories\": [],\n  \"verified\": true,\n  \"active\": true\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"View coupon","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/coupons/:id","host":["{{base_url}}"],"path":["coupons",":id"],"query":[]},"description":"Returns rules and validity of a coupon.\n\nRequired scope: `coupons:read`."},"response":[]},{"name":"Update coupon","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/coupons/:id","host":["{{base_url}}"],"path":["coupons",":id"],"query":[]},"description":"Updates validity, discount and eligibility.\n\nRequired scope: `coupons:write`.","body":{"mode":"raw","raw":"{\n  \"marketplace\": \"string\",\n  \"code\": \"string\",\n  \"description\": \"string\",\n  \"value\": \"string\",\n  \"minimum\": 10,\n  \"valid_until\": \"string\",\n  \"type\": \"string\",\n  \"discount\": 10,\n  \"cap\": 10,\n  \"categories\": [],\n  \"verified\": true,\n  \"active\": true\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Archive coupon","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/coupons/:id","host":["{{base_url}}"],"path":["coupons",":id"],"query":[]},"description":"Deactivate the coupon while preserving its history.\n\nRequired scope: `coupons:write`."},"response":[]}]},{"name":"Commissions","item":[{"name":"List commissions","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/commissions","host":["{{base_url}}"],"path":["commissions"],"query":[{"key":"limit","value":"30","disabled":true,"description":"Quantidade por página."},{"key":"offset","value":"0","disabled":true,"description":"Deslocamento da paginação."}]},"description":"Lists commissions assigned to the account.\n\nRequired scope: `commissions:read`."},"response":[]},{"name":"Summarize commissions","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/commissions/summary","host":["{{base_url}}"],"path":["commissions","summary"],"query":[{"key":"days","value":"30","disabled":true,"description":"Janela de análise em dias."}]},"description":"Groups amounts by currency and payment status.\n\nRequired scope: `commissions:read`."},"response":[]},{"name":"See commission","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/commissions/:id","host":["{{base_url}}"],"path":["commissions",":id"],"query":[]},"description":"Returns assignment and reconciliation of a commission.\n\nRequired scope: `commissions:read`."},"response":[]},{"name":"Import commissions in CSV","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/commissions/imports","host":["{{base_url}}"],"path":["commissions","imports"],"query":[]},"description":"Normalizes a CSV, deduplicates transactions, and produces an auditable receipt.\n\nRequired scope: `commissions:write`.","body":{"mode":"raw","raw":"{\n  \"marketplace\": \"string\",\n  \"filename\": \"string\",\n  \"content\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"List commission imports","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/commissions/imports","host":["{{base_url}}"],"path":["commissions","imports"],"query":[{"key":"limit","value":"30","disabled":true,"description":"Quantidade por página."},{"key":"offset","value":"0","disabled":true,"description":"Deslocamento da paginação."}]},"description":"List import receipts without including credentials.\n\nRequired scope: `commissions:read`."},"response":[]},{"name":"See commission import","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/commissions/imports/:id","host":["{{base_url}}"],"path":["commissions","imports",":id"],"query":[]},"description":"Returns counts, normalized errors, and origin of an import.\n\nRequired scope: `commissions:read`."},"response":[]},{"name":"Sync commissions","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/commissions/sync","host":["{{base_url}}"],"path":["commissions","sync"],"query":[]},"description":"Query only authorized connectors and record one receipt per source.\n\nRequired scope: `commissions:write`.","body":{"mode":"raw","raw":"{\n  \"sources\": [],\n  \"from\": \"2026-09-01T15:00:00Z\",\n  \"to\": \"2026-09-01T15:00:00Z\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"List receipts","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/commissions/receipts","host":["{{base_url}}"],"path":["commissions","receipts"],"query":[{"key":"limit","value":"30","disabled":true,"description":"Quantidade por página."},{"key":"offset","value":"0","disabled":true,"description":"Deslocamento da paginação."}]},"description":"Lists financial credits and reconciliation status.\n\nRequired scope: `commissions:read`."},"response":[]},{"name":"Register receipt","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/commissions/receipts","host":["{{base_url}}"],"path":["commissions","receipts"],"query":[]},"description":"Registers a credit received without automatically treating it as a commission.\n\nRequired scope: `commissions:write`.","body":{"mode":"raw","raw":"{\n  \"source\": \"string\",\n  \"amount\": 329.9,\n  \"currency\": \"BRL\",\n  \"reference\": \"string\",\n  \"period_start\": \"2026-09-01T15:00:00Z\",\n  \"period_end\": \"2026-09-01T15:00:00Z\",\n  \"paid_at\": \"2026-09-01T15:00:00Z\",\n  \"notes\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"View receipt","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/commissions/receipts/:id","host":["{{base_url}}"],"path":["commissions","receipts",":id"],"query":[]},"description":"Returns the receipt and reconciled commissions.\n\nRequired scope: `commissions:read`."},"response":[]},{"name":"Reconcile receipt","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/commissions/receipts/:id/reconcile","host":["{{base_url}}"],"path":["commissions","receipts",":id","reconcile"],"query":[]},"description":"Automatically select or receive the commissions that form the credit.\n\nRequired scope: `commissions:write`.","body":{"mode":"raw","raw":"{\n  \"commission_ids\": []\n}","options":{"raw":{"language":"json"}}}},"response":[]}]},{"name":"Publications","item":[{"name":"List publications","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/publications","host":["{{base_url}}"],"path":["publications"],"query":[{"key":"limit","value":"30","disabled":true,"description":"Quantidade por página."},{"key":"offset","value":"0","disabled":true,"description":"Deslocamento da paginação."},{"key":"status","value":"string","disabled":true,"description":"Estado do envio."},{"key":"group_id","value":"group_id","disabled":true,"description":"Grupo."},{"key":"offer_id","value":"offer_id","disabled":true,"description":"Oferta."}]},"description":"List shipments with filters by state, group and offer.\n\nRequired scope: `publications:read`."},"response":[]},{"name":"View publication","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/publications/:id","host":["{{base_url}}"],"path":["publications",":id"],"query":[]},"description":"Returns the result of a publication without exposing the channel session.\n\nRequired scope: `publications:read`."},"response":[]},{"name":"Retry publishing","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/publications/:id/retry","host":["{{base_url}}"],"path":["publications",":id","retry"],"query":[]},"description":"Creates a retry for a failed post.\n\nRequired scope: `publications:write`."},"response":[]},{"name":"Unpublish","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/publications/:id/cancel","host":["{{base_url}}"],"path":["publications",":id","cancel"],"query":[]},"description":"Cancels a pending publication without removing the history.\n\nRequired scope: `publications:write`.","body":{"mode":"raw","raw":"{\n  \"reason\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"List publication attempts","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/publications/:id/attempts","host":["{{base_url}}"],"path":["publications",":id","attempts"],"query":[{"key":"limit","value":"30","disabled":true,"description":"Quantidade por página."},{"key":"offset","value":"0","disabled":true,"description":"Deslocamento da paginação."}]},"description":"Lists the safe timeline of creation, failure, retry, and cancellation.\n\nRequired scope: `publications:read`."},"response":[]}]},{"name":"Templates","item":[{"name":"List templates","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/templates","host":["{{base_url}}"],"path":["templates"],"query":[{"key":"limit","value":"30","disabled":true,"description":"Quantidade por página."},{"key":"offset","value":"0","disabled":true,"description":"Deslocamento da paginação."}]},"description":"List editorial templates for the account.\n\nRequired scope: `templates:read`."},"response":[]},{"name":"Create template","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/templates","host":["{{base_url}}"],"path":["templates"],"query":[]},"description":"Creates a reusable publishing template.\n\nRequired scope: `templates:write`.","body":{"mode":"raw","raw":"{\n  \"name\": \"My integration\",\n  \"body\": \"string\",\n  \"marketplace\": \"string\",\n  \"with_preview\": true\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"View template","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/templates/:id","host":["{{base_url}}"],"path":["templates",":id"],"query":[]},"description":"Returns the body and configuration of a template.\n\nRequired scope: `templates:read`."},"response":[]},{"name":"Update template","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/templates/:id","host":["{{base_url}}"],"path":["templates",":id"],"query":[]},"description":"Updates the fields sent from the template.\n\nRequired scope: `templates:write`.","body":{"mode":"raw","raw":"{\n  \"name\": \"My integration\",\n  \"body\": \"string\",\n  \"marketplace\": \"string\",\n  \"with_preview\": true\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Delete template","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/templates/:id","host":["{{base_url}}"],"path":["templates",":id"],"query":[]},"description":"Deletes a template not used by schedules.\n\nRequired scope: `templates:write`."},"response":[]}]},{"name":"Schedules","item":[{"name":"List appointments","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/schedules","host":["{{base_url}}"],"path":["schedules"],"query":[{"key":"limit","value":"30","disabled":true,"description":"Quantidade por página."},{"key":"offset","value":"0","disabled":true,"description":"Deslocamento da paginação."}]},"description":"Lists future and recurring publications.\n\nRequired scope: `schedules:read`."},"response":[]},{"name":"Create schedule","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/schedules","host":["{{base_url}}"],"path":["schedules"],"query":[]},"description":"Program offer or text for an ISO date.\n\nRequired scope: `schedules:write`.","body":{"mode":"raw","raw":"{\n  \"type\": \"string\",\n  \"at\": \"2026-09-01T15:00:00Z\",\n  \"segment_id\": \"segment_id\",\n  \"group_id\": \"group_id\",\n  \"offer_id\": \"offer_id\",\n  \"text\": \"string\",\n  \"image\": \"https://cdn.example.com/image.jpg\",\n  \"recurrence\": \"string\",\n  \"active\": true\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"View schedule","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/schedules/:id","host":["{{base_url}}"],"path":["schedules",":id"],"query":[]},"description":"Returns destination, content and recurrence.\n\nRequired scope: `schedules:read`."},"response":[]},{"name":"Update schedule","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/schedules/:id","host":["{{base_url}}"],"path":["schedules",":id"],"query":[]},"description":"Change time, destination, recurrence or status.\n\nRequired scope: `schedules:write`.","body":{"mode":"raw","raw":"{\n  \"type\": \"string\",\n  \"at\": \"2026-09-01T15:00:00Z\",\n  \"segment_id\": \"segment_id\",\n  \"group_id\": \"group_id\",\n  \"offer_id\": \"offer_id\",\n  \"text\": \"string\",\n  \"image\": \"https://cdn.example.com/image.jpg\",\n  \"recurrence\": \"string\",\n  \"active\": true\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Delete schedule","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/schedules/:id","host":["{{base_url}}"],"path":["schedules",":id"],"query":[]},"description":"Cancels and removes a future schedule.\n\nRequired scope: `schedules:write`."},"response":[]},{"name":"Run schedule","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/schedules/:id/run","host":["{{base_url}}"],"path":["schedules",":id","run"],"query":[]},"description":"It now runs the same safe routine as the scheduler.\n\nRequired scope: `publications:write`."},"response":[]}]},{"name":"Monitors","item":[{"name":"List radars","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/monitors","host":["{{base_url}}"],"path":["monitors"],"query":[{"key":"limit","value":"30","disabled":true,"description":"Quantidade por página."},{"key":"offset","value":"0","disabled":true,"description":"Deslocamento da paginação."}]},"description":"Lists automatic offer discovery rules.\n\nRequired scope: `monitors:read`."},"response":[]},{"name":"Create radar","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/monitors","host":["{{base_url}}"],"path":["monitors"],"query":[]},"description":"Create a recurring search with commercial criteria.\n\nRequired scope: `monitors:write`.","body":{"mode":"raw","raw":"{\n  \"name\": \"My integration\",\n  \"query\": \"string\",\n  \"source\": \"string\",\n  \"segment_id\": \"segment_id\",\n  \"min_price\": 329.9,\n  \"max_price\": 329.9,\n  \"min_commission\": 10,\n  \"min_discount\": 10,\n  \"order\": \"string\",\n  \"limit\": 30,\n  \"interval_minutes\": 1,\n  \"auto_approve\": true,\n  \"active\": true\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"View radar","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/monitors/:id","host":["{{base_url}}"],"path":["monitors",":id"],"query":[]},"description":"Returns criteria and last result of a rule.\n\nRequired scope: `monitors:read`."},"response":[]},{"name":"Update radar","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/monitors/:id","host":["{{base_url}}"],"path":["monitors",":id"],"query":[]},"description":"Updates criteria, frequency and automation.\n\nRequired scope: `monitors:write`.","body":{"mode":"raw","raw":"{\n  \"name\": \"My integration\",\n  \"query\": \"string\",\n  \"source\": \"string\",\n  \"segment_id\": \"segment_id\",\n  \"min_price\": 329.9,\n  \"max_price\": 329.9,\n  \"min_commission\": 10,\n  \"min_discount\": 10,\n  \"order\": \"string\",\n  \"limit\": 30,\n  \"interval_minutes\": 1,\n  \"auto_approve\": true,\n  \"active\": true\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Delete radar","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/monitors/:id","host":["{{base_url}}"],"path":["monitors",":id"],"query":[]},"description":"Removes a monitoring rule.\n\nRequired scope: `monitors:write`."},"response":[]},{"name":"Run radar now","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/monitors/:id/run","host":["{{base_url}}"],"path":["monitors",":id","run"],"query":[]},"description":"Executes a round of the radar and the observed result persists.\n\nRequired scope: `monitors:write`."},"response":[]},{"name":"Consult radar results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/monitors/:id/results","host":["{{base_url}}"],"path":["monitors",":id","results"],"query":[{"key":"limit","value":"30","disabled":true,"description":"Quantidade por página."},{"key":"offset","value":"0","disabled":true,"description":"Deslocamento da paginação."}]},"description":"Returns the last round and offers originated by this radar.\n\nRequired scope: `monitors:read`."},"response":[]}]},{"name":"Store","item":[{"name":"View store","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/store","host":["{{base_url}}"],"path":["store"],"query":[]},"description":"Returns only the public configuration of the store.\n\nRequired scope: `store:read`."},"response":[]},{"name":"Update store","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/store","host":["{{base_url}}"],"path":["store"],"query":[]},"description":"Updates store identity, theme, networks and privacy.\n\nRequired scope: `store:write`.","body":{"mode":"raw","raw":"{\n  \"name\": \"My integration\",\n  \"tagline\": \"string\",\n  \"logo\": \"https://cdn.example.com/image.jpg\",\n  \"cover\": \"https://cdn.example.com/image.jpg\",\n  \"favicon\": \"https://cdn.example.com/image.jpg\",\n  \"about\": \"string\",\n  \"theme\": \"string\",\n  \"social\": \"string\",\n  \"privacy\": \"string\",\n  \"badge\": true,\n  \"active\": true\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"List store collections","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/store/collections","host":["{{base_url}}"],"path":["store","collections"],"query":[{"key":"limit","value":"30","disabled":true,"description":"Quantidade por página."},{"key":"offset","value":"0","disabled":true,"description":"Deslocamento da paginação."}]},"description":"Lists editorial collections and their public order.\n\nRequired scope: `store:read`."},"response":[]},{"name":"Create store collection","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/store/collections","host":["{{base_url}}"],"path":["store","collections"],"query":[]},"description":"Creates a publishable collection of offers.\n\nRequired scope: `store:write`.","body":{"mode":"raw","raw":"{\n  \"name\": \"My integration\",\n  \"slug\": \"string\",\n  \"description\": \"string\",\n  \"image\": \"https://cdn.example.com/image.jpg\",\n  \"offer_ids\": [],\n  \"active\": true\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"View store collection","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/store/collections/:id","host":["{{base_url}}"],"path":["store","collections",":id"],"query":[]},"description":"Returns content and configuration of a collection.\n\nRequired scope: `store:read`."},"response":[]},{"name":"Update store collection","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/store/collections/:id","host":["{{base_url}}"],"path":["store","collections",":id"],"query":[]},"description":"Updates only sent fields from the collection.\n\nRequired scope: `store:write`.","body":{"mode":"raw","raw":"{\n  \"name\": \"My integration\",\n  \"slug\": \"string\",\n  \"description\": \"string\",\n  \"image\": \"https://cdn.example.com/image.jpg\",\n  \"offer_ids\": [],\n  \"active\": true\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Delete store collection","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/store/collections/:id","host":["{{base_url}}"],"path":["store","collections",":id"],"query":[]},"description":"Remove the collection without deleting the offers.\n\nRequired scope: `store:write`."},"response":[]},{"name":"List store pages","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/store/pages","host":["{{base_url}}"],"path":["store","pages"],"query":[{"key":"limit","value":"30","disabled":true,"description":"Quantidade por página."},{"key":"offset","value":"0","disabled":true,"description":"Deslocamento da paginação."}]},"description":"List landing pages and editorial content for the store.\n\nRequired scope: `store:read`."},"response":[]},{"name":"Create store page","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/store/pages","host":["{{base_url}}"],"path":["store","pages"],"query":[]},"description":"Create a page in Markdown with its own SEO.\n\nRequired scope: `store:write`.","body":{"mode":"raw","raw":"{\n  \"title\": \"Air fryer 5L\",\n  \"slug\": \"string\",\n  \"summary\": \"string\",\n  \"body\": \"string\",\n  \"cover\": \"https://cdn.example.com/image.jpg\",\n  \"seo_title\": \"string\",\n  \"seo_description\": \"string\",\n  \"published\": true\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"View store page","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/store/pages/:id","host":["{{base_url}}"],"path":["store","pages",":id"],"query":[]},"description":"Returns content, SEO and publishing status.\n\nRequired scope: `store:read`."},"response":[]},{"name":"Update store page","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/store/pages/:id","host":["{{base_url}}"],"path":["store","pages",":id"],"query":[]},"description":"Update content, slug, SEO or post.\n\nRequired scope: `store:write`.","body":{"mode":"raw","raw":"{\n  \"title\": \"Air fryer 5L\",\n  \"slug\": \"string\",\n  \"summary\": \"string\",\n  \"body\": \"string\",\n  \"cover\": \"https://cdn.example.com/image.jpg\",\n  \"seo_title\": \"string\",\n  \"seo_description\": \"string\",\n  \"published\": true\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Delete store page","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/store/pages/:id","host":["{{base_url}}"],"path":["store","pages",":id"],"query":[]},"description":"Removes a separate page from the store.\n\nRequired scope: `store:write`."},"response":[]}]},{"name":"Journeys","item":[{"name":"List journeys","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/journeys","host":["{{base_url}}"],"path":["journeys"],"query":[{"key":"limit","value":"30","disabled":true,"description":"Quantidade por página."},{"key":"offset","value":"0","disabled":true,"description":"Deslocamento da paginação."}]},"description":"Lists DU flows and aggregate performance.\n\nRequired scope: `journeys:read`."},"response":[]},{"name":"Create journey","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/journeys","host":["{{base_url}}"],"path":["journeys"],"query":[]},"description":"Creates initially safe visual automation.\n\nRequired scope: `journeys:write`.","body":{"mode":"raw","raw":"{\n  \"name\": \"My integration\",\n  \"description\": \"string\",\n  \"trigger\": \"string\",\n  \"blocks\": [],\n  \"channels\": [],\n  \"segment_id\": \"segment_id\",\n  \"active\": true\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"See journey","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/journeys/:id","host":["{{base_url}}"],"path":["journeys",":id"],"query":[]},"description":"Returns journey blocks, channels, and metrics.\n\nRequired scope: `journeys:read`."},"response":[]},{"name":"Update journey","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/journeys/:id","host":["{{base_url}}"],"path":["journeys",":id"],"query":[]},"description":"Updates the graph and journey rules.\n\nRequired scope: `journeys:write`.","body":{"mode":"raw","raw":"{\n  \"name\": \"My integration\",\n  \"description\": \"string\",\n  \"trigger\": \"string\",\n  \"blocks\": [],\n  \"channels\": [],\n  \"segment_id\": \"segment_id\",\n  \"active\": true\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Delete journey","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/journeys/:id","host":["{{base_url}}"],"path":["journeys",":id"],"query":[]},"description":"Excludes only journeys that have never been run.\n\nRequired scope: `journeys:write`."},"response":[]},{"name":"Activate journey","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/journeys/:id/activate","host":["{{base_url}}"],"path":["journeys",":id","activate"],"query":[]},"description":"Activate or pause an existing journey.\n\nRequired scope: `journeys:write`.","body":{"mode":"raw","raw":"{\n  \"active\": true\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Validate journey","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/journeys/:id/validate","host":["{{base_url}}"],"path":["journeys",":id","validate"],"query":[]},"description":"Checks trigger, blocks, channels and references without running the flow.\n\nRequired scope: `journeys:read`."},"response":[]},{"name":"Run journey","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/journeys/:id/execute","host":["{{base_url}}"],"path":["journeys",":id","execute"],"query":[]},"description":"Starts an explicit execution for authorized contact or conversation.\n\nRequired scope: `journeys:write`.","body":{"mode":"raw","raw":"{\n  \"contact_id\": \"contact_id\",\n  \"conversation_id\": \"conversation_id\",\n  \"context\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"List journey executions","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/journeys/:id/executions","host":["{{base_url}}"],"path":["journeys",":id","executions"],"query":[{"key":"limit","value":"30","disabled":true,"description":"Quantidade por página."},{"key":"offset","value":"0","disabled":true,"description":"Deslocamento da paginação."},{"key":"status","value":"string","disabled":true,"description":"Estado da execução."}]},"description":"List status, step and times of executions.\n\nRequired scope: `journeys:read`."},"response":[]},{"name":"View journey execution","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/journey-executions/:id","host":["{{base_url}}"],"path":["journey-executions",":id"],"query":[]},"description":"Returns the execution and its safe operating context.\n\nRequired scope: `journeys:read`."},"response":[]}]},{"name":"Inbox","item":[{"name":"List conversations","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/inbox/conversations","host":["{{base_url}}"],"path":["inbox","conversations"],"query":[{"key":"limit","value":"30","disabled":true,"description":"Quantidade por página."},{"key":"offset","value":"0","disabled":true,"description":"Deslocamento da paginação."},{"key":"status","value":"string","disabled":true,"description":"Estado da conversa."},{"key":"channel","value":"string","disabled":true,"description":"Canal de origem."}]},"description":"Lists DU Inbox operational metadata.\n\nRequired scope: `inbox:read`."},"response":[]},{"name":"View conversation","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/inbox/conversations/:id","host":["{{base_url}}"],"path":["inbox","conversations",":id"],"query":[]},"description":"Returns conversation context without direct contact data.\n\nRequired scope: `inbox:read`."},"response":[]},{"name":"Update conversation","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/inbox/conversations/:id","host":["{{base_url}}"],"path":["inbox","conversations",":id"],"query":[]},"description":"Assigns, prioritizes or changes the DU mode.\n\nRequired scope: `inbox:write`.","body":{"mode":"raw","raw":"{\n  \"status\": \"string\",\n  \"priority\": \"string\",\n  \"assignee_id\": \"assignee_id\",\n  \"ai_mode\": \"string\",\n  \"unread\": 1,\n  \"action\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"End conversation","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/inbox/conversations/:id/close","host":["{{base_url}}"],"path":["inbox","conversations",":id","close"],"query":[]},"description":"End the conversation and record the event.\n\nRequired scope: `inbox:write`."},"response":[]},{"name":"List messages","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/inbox/conversations/:id/messages","host":["{{base_url}}"],"path":["inbox","conversations",":id","messages"],"query":[{"key":"limit","value":"30","disabled":true,"description":"Quantidade por página."},{"key":"offset","value":"0","disabled":true,"description":"Deslocamento da paginação."}]},"description":"Lists the paginated history of a conversation.\n\nRequired scope: `inbox:read`."},"response":[]},{"name":"Prepare response","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/inbox/conversations/:id/reply","host":["{{base_url}}"],"path":["inbox","conversations",":id","reply"],"query":[]},"description":"Registers an output response for delivery by the channel connector.\n\nRequired scope: `inbox:write`.","body":{"mode":"raw","raw":"{\n  \"content\": \"string\",\n  \"type\": \"string\",\n  \"media_url\": \"https://cdn.example.com/image.jpg\",\n  \"offer_id\": \"offer_id\",\n  \"use_du\": true\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"List contacts","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/inbox/contacts","host":["{{base_url}}"],"path":["inbox","contacts"],"query":[{"key":"limit","value":"30","disabled":true,"description":"Quantidade por página."},{"key":"offset","value":"0","disabled":true,"description":"Deslocamento da paginação."},{"key":"query","value":"string","disabled":true,"description":"Busca textual."},{"key":"stage","value":"string","disabled":true,"description":"Estágio do CRM."}]},"description":"List your profile, internship and interest without revealing your phone number or email.\n\nRequired scope: `inbox:read`."},"response":[]},{"name":"See contact","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/inbox/contacts/:id","host":["{{base_url}}"],"path":["inbox","contacts",":id"],"query":[]},"description":"Returns profile, tags, and activity without direct identifiers.\n\nRequired scope: `inbox:read`."},"response":[]},{"name":"Update contact","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/inbox/contacts/:id","host":["{{base_url}}"],"path":["inbox","contacts",":id"],"query":[]},"description":"Updates name, stage, tags, and authorized preferences.\n\nRequired scope: `inbox:write`.","body":{"mode":"raw","raw":"{\n  \"name\": \"My integration\",\n  \"stage\": \"string\",\n  \"tags\": [],\n  \"preferences\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"List contact notes","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/inbox/contacts/:id/notes","host":["{{base_url}}"],"path":["inbox","contacts",":id","notes"],"query":[{"key":"limit","value":"30","disabled":true,"description":"Quantidade por página."},{"key":"offset","value":"0","disabled":true,"description":"Deslocamento da paginação."}]},"description":"Lists internal notes with author and date.\n\nRequired scope: `inbox:read`."},"response":[]},{"name":"Create note in contact","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/inbox/contacts/:id/notes","host":["{{base_url}}"],"path":["inbox","contacts",":id","notes"],"query":[]},"description":"Records an internal note that is never sent to the contact.\n\nRequired scope: `inbox:write`.","body":{"mode":"raw","raw":"{\n  \"content\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Assign conversation","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/inbox/conversations/:id/assign","host":["{{base_url}}"],"path":["inbox","conversations",":id","assign"],"query":[]},"description":"Assigns or removes the person responsible for the conversation.\n\nRequired scope: `inbox:write`.","body":{"mode":"raw","raw":"{\n  \"assignee_id\": \"assignee_id\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Reopen conversation","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/inbox/conversations/:id/reopen","host":["{{base_url}}"],"path":["inbox","conversations",":id","reopen"],"query":[]},"description":"Reopens a closed conversation and records the event.\n\nRequired scope: `inbox:write`."},"response":[]},{"name":"View message","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/inbox/messages/:id","host":["{{base_url}}"],"path":["inbox","messages",":id"],"query":[]},"description":"Returns content and operational state of a message.\n\nRequired scope: `inbox:read`."},"response":[]},{"name":"Check message delivery","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/inbox/messages/:id/status","host":["{{base_url}}"],"path":["inbox","messages",":id","status"],"query":[]},"description":"Distinguish prepared, queued, sent, delivered and failed.\n\nRequired scope: `inbox:read`."},"response":[]}]},{"name":"Analytics","item":[{"name":"Analytics summary","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/analytics/summary","host":["{{base_url}}"],"path":["analytics","summary"],"query":[{"key":"days","value":"30","disabled":true,"description":"Janela de análise em dias."}]},"description":"Consolidates offers, publications, clicks and commissions.\n\nRequired scope: `analytics:read`."},"response":[]},{"name":"Time series","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/analytics/timeseries","host":["{{base_url}}"],"path":["analytics","timeseries"],"query":[{"key":"days","value":"30","disabled":true,"description":"Janela de análise em dias."}]},"description":"Groups posts, failures and clicks by day.\n\nRequired scope: `analytics:read`."},"response":[]},{"name":"Performance by group","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/analytics/groups","host":["{{base_url}}"],"path":["analytics","groups"],"query":[{"key":"days","value":"30","disabled":true,"description":"Janela de análise em dias."}]},"description":"Compares volume, delivery and error between groups.\n\nRequired scope: `analytics:read`."},"response":[]},{"name":"Performance by offer","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/analytics/offers","host":["{{base_url}}"],"path":["analytics","offers"],"query":[{"key":"days","value":"30","disabled":true,"description":"Janela de análise em dias."},{"key":"limit","value":"30","disabled":true,"description":"Quantidade por página."}]},"description":"Sort offers by publication, click and commission.\n\nRequired scope: `analytics:read`."},"response":[]},{"name":"Performance by source","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/analytics/sources","host":["{{base_url}}"],"path":["analytics","sources"],"query":[{"key":"days","value":"30","disabled":true,"description":"Janela de análise em dias."}]},"description":"Groups catalogue, clicks and revenue by marketplace.\n\nRequired scope: `analytics:read`."},"response":[]},{"name":"Interaction heatmap","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/analytics/heatmap","host":["{{base_url}}"],"path":["analytics","heatmap"],"query":[{"key":"days","value":"30","disabled":true,"description":"Janela de análise em dias."}]},"description":"Aggregates clicks by page, element, day and time.\n\nRequired scope: `analytics:read`."},"response":[]},{"name":"Analyze funnel","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/analytics/funnel","host":["{{base_url}}"],"path":["analytics","funnel"],"query":[{"key":"days","value":"30","disabled":true,"description":"Janela de análise em dias."}]},"description":"Groups impression, click, intent, purchase and commission by period.\n\nRequired scope: `analytics:read`."},"response":[]},{"name":"Analyze recipe","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/analytics/revenue","host":["{{base_url}}"],"path":["analytics","revenue"],"query":[{"key":"days","value":"30","disabled":true,"description":"Janela de análise em dias."}]},"description":"Consolidates registered commission and receipts reconciled by currency.\n\nRequired scope: `analytics:read`."},"response":[]},{"name":"Analyze attribution","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/analytics/attribution","host":["{{base_url}}"],"path":["analytics","attribution"],"query":[{"key":"days","value":"30","disabled":true,"description":"Janela de análise em dias."},{"key":"model","value":"string","disabled":true,"description":"Modelo: last_touch ou recorded."}]},"description":"Compares source, group, segment and conversion window.\n\nRequired scope: `analytics:read`."},"response":[]}]},{"name":"Links","item":[{"name":"Convert link","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/links/convert","host":["{{base_url}}"],"path":["links","convert"],"query":[]},"description":"Converts a URL using only this account's integrations.\n\nRequired scope: `links:write`.","body":{"mode":"raw","raw":"{\n  \"url\": \"https://example.com/product\"\n}","options":{"raw":{"language":"json"}}}},"response":[]}]},{"name":"Webhooks","item":[{"name":"List webhooks","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/webhooks","host":["{{base_url}}"],"path":["webhooks"],"query":[{"key":"limit","value":"30","disabled":true,"description":"Quantidade por página."},{"key":"offset","value":"0","disabled":true,"description":"Deslocamento da paginação."}]},"description":"List destinations and events, never the secret.\n\nRequired scope: `webhooks:read`."},"response":[]},{"name":"Create webhook","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/webhooks","host":["{{base_url}}"],"path":["webhooks"],"query":[]},"description":"Creates an HTTPS destination and reveals the secret once.\n\nRequired scope: `webhooks:write`.","body":{"mode":"raw","raw":"{\n  \"name\": \"My integration\",\n  \"url\": \"https://example.com/product\",\n  \"events\": [\n    \"offer.created\"\n  ],\n  \"active\": true\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"View webhook","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/webhooks/:id","host":["{{base_url}}"],"path":["webhooks",":id"],"query":[]},"description":"Returns secure configuration of the target.\n\nRequired scope: `webhooks:read`."},"response":[]},{"name":"Update webhook","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/webhooks/:id","host":["{{base_url}}"],"path":["webhooks",":id"],"query":[]},"description":"Update URL, events or state without changing the secret.\n\nRequired scope: `webhooks:write`.","body":{"mode":"raw","raw":"{\n  \"name\": \"My integration\",\n  \"url\": \"https://example.com/product\",\n  \"events\": [\n    \"offer.created\"\n  ],\n  \"active\": true\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Delete webhook","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/webhooks/:id","host":["{{base_url}}"],"path":["webhooks",":id"],"query":[]},"description":"Removes destination and delivery history.\n\nRequired scope: `webhooks:write`."},"response":[]},{"name":"List deliveries","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/webhooks/:id/deliveries","host":["{{base_url}}"],"path":["webhooks",":id","deliveries"],"query":[{"key":"limit","value":"30","disabled":true,"description":"Quantidade por página."},{"key":"offset","value":"0","disabled":true,"description":"Deslocamento da paginação."}]},"description":"Lists attempts, HTTP status and delivery errors.\n\nRequired scope: `webhooks:read`."},"response":[]},{"name":"List webhook events","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/webhook-events","host":["{{base_url}}"],"path":["webhook-events"],"query":[]},"description":"Returns the versioned catalog of events and descriptions.\n\nRequired scope: `webhooks:read`."},"response":[]},{"name":"Get event schema","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/webhook-events/:event/schema","host":["{{base_url}}"],"path":["webhook-events",":event","schema"],"query":[]},"description":"Returns the JSON Schema and an example for the current event version.\n\nRequired scope: `webhooks:read`."},"response":[]},{"name":"Rotate webhook secret","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/webhooks/:id/rotate-secret","host":["{{base_url}}"],"path":["webhooks",":id","rotate-secret"],"query":[]},"description":"Invalidates the previous secret and reveals the new one only once.\n\nRequired scope: `webhooks:write`."},"response":[]},{"name":"Test webhook","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/webhooks/:id/test","host":["{{base_url}}"],"path":["webhooks",":id","test"],"query":[]},"description":"Queues a signed test event to the target.\n\nRequired scope: `webhooks:write`."},"response":[]},{"name":"Resend webhook delivery","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/webhook-deliveries/:id/redeliver","host":["{{base_url}}"],"path":["webhook-deliveries",":id","redeliver"],"query":[]},"description":"Creates an auditable retry for an existing deliverable.\n\nRequired scope: `webhooks:write`."},"response":[]}]},{"name":"Integrations","item":[{"name":"List integrations","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/integrations","host":["{{base_url}}"],"path":["integrations"],"query":[]},"description":"Lists connectors and secure state, without returning credentials.\n\nRequired scope: `integrations:read`."},"response":[]},{"name":"See integration","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/integrations/:provider","host":["{{base_url}}"],"path":["integrations",":provider"],"query":[]},"description":"Returns capacity, health, and last validation of a connector.\n\nRequired scope: `integrations:read`."},"response":[]},{"name":"Check integration health","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/integrations-health","host":["{{base_url}}"],"path":["integrations-health"],"query":[]},"description":"Summarizes connectors that are configured, healthy, and needing attention.\n\nRequired scope: `integrations:read`."},"response":[]},{"name":"Validate integration","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/integrations/:provider/test","host":["{{base_url}}"],"path":["integrations",":provider","test"],"query":[]},"description":"Validates the available configuration and records the diagnosis.\n\nRequired scope: `integrations:write`."},"response":[]},{"name":"Disconnect integration","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/integrations/:provider","host":["{{base_url}}"],"path":["integrations",":provider"],"query":[]},"description":"Removes the connector credentials for the key actor.\n\nRequired scope: `integrations:write`."},"response":[]}]}]}