Skip to content

Operational APIGo to website ↗

Achadu/Developers/API reference

API REFERENCE

The entire public operation, endpoint by endpoint.

REST v1 contract with JSON, uniform pagination, predictable filters and OpenAPI ready to generate clients.

Base and format

BASE URLhttps://achadu.com/api/v1OpenAPI ↗

FormatJSON UTF-8

AuthenticationBearer token

Versionv1 na URL

Default limit30 itens

Maximum limit100 itens

ContractOpenAPI 3.1.2

All endpoints

The 121 operations below are available in production and use the same account audit.

Search operation

121 operations found

GET/meAccountView accountReturns the operation and actor linked to the key.account:read→GET/offersOffersList offersList offers with status, marketplace and text filters.offers:read→POST/offersOffersCreate offerCreates a pending offer without publishing it.offers:write→GET/offers/{id}OffersView offerReturns the editorial and commercial details of an offer.offers:read→PATCH/offers/{id}OffersUpdate offerUpdates only the submitted fields.offers:write→DELETE/offers/{id}OffersArchive offerRemoves the offer from the active flow without deleting the history.offers:write→POST/offers/{id}/previewOffersPreview postAssemble the final message without sending it to any channel.offers:read→POST/offers/{id}/publishOffersPost offerQueues the offer's publication to an authorized group or thread.publications:write→GET/groupsGroupsList groupsLists groups without exposing JIDs, sessions, or credentials.groups:read→GET/groups/{id}GroupsView groupReturns secure operational configuration of the group.groups:read→PATCH/groups/{id}GroupsUpdate groupUpdates name, segment, capacity and automation.groups:write→GET/segmentsSegmentsList segmentsList niches and storefront configurations.segments:read→POST/segmentsSegmentsCreate segmentCreate a niche with your storefront setup.segments:write→GET/segments/{id}SegmentsView segmentReturns a segment of the operation.segments:read→PATCH/segments/{id}SegmentsUpdate segmentUpdates the segment's identity, distribution and showcase.segments:write→DELETE/segments/{id}SegmentsDelete segmentDeletes only when there are no linked groups or calendars.segments:write→GET/couponsCouponsList couponsLists active and verified coupons for the operation.coupons:read→POST/couponsCouponsCreate couponRegister a coupon to use in offers.coupons:write→GET/coupons/{id}CouponsView couponReturns rules and validity of a coupon.coupons:read→PATCH/coupons/{id}CouponsUpdate couponUpdates validity, discount and eligibility.coupons:write→DELETE/coupons/{id}CouponsArchive couponDeactivate the coupon while preserving its history.coupons:write→GET/commissionsCommissionsList commissionsLists commissions assigned to the account.commissions:read→GET/commissions/summaryCommissionsSummarize commissionsGroups amounts by currency and payment status.commissions:read→GET/commissions/{id}CommissionsSee commissionReturns assignment and reconciliation of a commission.commissions:read→GET/publicationsPublicationsList publicationsList shipments with filters by state, group and offer.publications:read→GET/publications/{id}PublicationsView publicationReturns the result of a publication without exposing the channel session.publications:read→GET/templatesTemplatesList templatesList editorial templates for the account.templates:read→POST/templatesTemplatesCreate templateCreates a reusable publishing template.templates:write→GET/templates/{id}TemplatesView templateReturns the body and configuration of a template.templates:read→PATCH/templates/{id}TemplatesUpdate templateUpdates the fields sent from the template.templates:write→DELETE/templates/{id}TemplatesDelete templateDeletes a template not used by schedules.templates:write→GET/schedulesSchedulesList appointmentsLists future and recurring publications.schedules:read→POST/schedulesSchedulesCreate scheduleProgram offer or text for an ISO date.schedules:write→GET/schedules/{id}SchedulesView scheduleReturns destination, content and recurrence.schedules:read→PATCH/schedules/{id}SchedulesUpdate scheduleChange time, destination, recurrence or status.schedules:write→DELETE/schedules/{id}SchedulesDelete scheduleCancels and removes a future schedule.schedules:write→POST/schedules/{id}/runSchedulesRun scheduleIt now runs the same safe routine as the scheduler.publications:write→GET/monitorsMonitorsList radarsLists automatic offer discovery rules.monitors:read→POST/monitorsMonitorsCreate radarCreate a recurring search with commercial criteria.monitors:write→GET/monitors/{id}MonitorsView radarReturns criteria and last result of a rule.monitors:read→PATCH/monitors/{id}MonitorsUpdate radarUpdates criteria, frequency and automation.monitors:write→DELETE/monitors/{id}MonitorsDelete radarRemoves a monitoring rule.monitors:write→GET/storeStoreView storeReturns only the public configuration of the store.store:read→PATCH/storeStoreUpdate storeUpdates store identity, theme, networks and privacy.store:write→GET/journeysJourneysList journeysLists DU flows and aggregate performance.journeys:read→POST/journeysJourneysCreate journeyCreates initially safe visual automation.journeys:write→GET/journeys/{id}JourneysSee journeyReturns journey blocks, channels, and metrics.journeys:read→PATCH/journeys/{id}JourneysUpdate journeyUpdates the graph and journey rules.journeys:write→DELETE/journeys/{id}JourneysDelete journeyExcludes only journeys that have never been run.journeys:write→POST/journeys/{id}/activateJourneysActivate journeyActivate or pause an existing journey.journeys:write→GET/inbox/conversationsInboxList conversationsLists DU Inbox operational metadata.inbox:read→GET/inbox/conversations/{id}InboxView conversationReturns conversation context without direct contact data.inbox:read→PATCH/inbox/conversations/{id}InboxUpdate conversationAssigns, prioritizes or changes the DU mode.inbox:write→POST/inbox/conversations/{id}/closeInboxEnd conversationEnd the conversation and record the event.inbox:write→GET/inbox/conversations/{id}/messagesInboxList messagesLists the paginated history of a conversation.inbox:read→POST/inbox/conversations/{id}/replyInboxPrepare responseRegisters an output response for delivery by the channel connector.inbox:write→GET/inbox/contactsInboxList contactsList your profile, internship and interest without revealing your phone number or email.inbox:read→GET/analytics/summaryAnalyticsAnalytics summaryConsolidates offers, publications, clicks and commissions.analytics:read→GET/analytics/timeseriesAnalyticsTime seriesGroups posts, failures and clicks by day.analytics:read→GET/analytics/groupsAnalyticsPerformance by groupCompares volume, delivery and error between groups.analytics:read→GET/analytics/offersAnalyticsPerformance by offerSort offers by publication, click and commission.analytics:read→GET/analytics/sourcesAnalyticsPerformance by sourceGroups catalogue, clicks and revenue by marketplace.analytics:read→GET/analytics/heatmapAnalyticsInteraction heatmapAggregates clicks by page, element, day and time.analytics:read→POST/links/convertLinksConvert linkConverts a URL using only this account's integrations.links:write→GET/webhooksWebhooksList webhooksList destinations and events, never the secret.webhooks:read→POST/webhooksWebhooksCreate webhookCreates an HTTPS destination and reveals the secret once.webhooks:write→GET/webhooks/{id}WebhooksView webhookReturns secure configuration of the target.webhooks:read→PATCH/webhooks/{id}WebhooksUpdate webhookUpdate URL, events or state without changing the secret.webhooks:write→DELETE/webhooks/{id}WebhooksDelete webhookRemoves destination and delivery history.webhooks:write→GET/webhooks/{id}/deliveriesWebhooksList deliveriesLists attempts, HTTP status and delivery errors.webhooks:read→POST/groupsGroupsCreate group destinationRegisters a group already authorized by the account connector.groups:write→DELETE/groups/{id}GroupsArchive groupDeactivate the destination without deleting the publication history.groups:write→GET/groups/{id}/activityGroupsCheck group activitySummarize entries, exits and publications without revealing participants.groups:read→POST/publications/{id}/retryPublicationsRetry publishingCreates a retry for a failed post.publications:write→POST/publications/{id}/cancelPublicationsUnpublishCancels a pending publication without removing the history.publications:write→GET/publications/{id}/attemptsPublicationsList publication attemptsLists the safe timeline of creation, failure, retry, and cancellation.publications:read→POST/commissions/importsCommissionsImport commissions in CSVNormalizes a CSV, deduplicates transactions, and produces an auditable receipt.commissions:write→GET/commissions/importsCommissionsList commission importsList import receipts without including credentials.commissions:read→GET/commissions/imports/{id}CommissionsSee commission importReturns counts, normalized errors, and origin of an import.commissions:read→POST/commissions/syncCommissionsSync commissionsQuery only authorized connectors and record one receipt per source.commissions:write→GET/commissions/receiptsCommissionsList receiptsLists financial credits and reconciliation status.commissions:read→POST/commissions/receiptsCommissionsRegister receiptRegisters a credit received without automatically treating it as a commission.commissions:write→GET/commissions/receipts/{id}CommissionsView receiptReturns the receipt and reconciled commissions.commissions:read→POST/commissions/receipts/{id}/reconcileCommissionsReconcile receiptAutomatically select or receive the commissions that form the credit.commissions:write→POST/monitors/{id}/runMonitorsRun radar nowExecutes a round of the radar and the observed result persists.monitors:write→GET/monitors/{id}/resultsMonitorsConsult radar resultsReturns the last round and offers originated by this radar.monitors:read→GET/store/collectionsStoreList store collectionsLists editorial collections and their public order.store:read→POST/store/collectionsStoreCreate store collectionCreates a publishable collection of offers.store:write→GET/store/collections/{id}StoreView store collectionReturns content and configuration of a collection.store:read→PATCH/store/collections/{id}StoreUpdate store collectionUpdates only sent fields from the collection.store:write→DELETE/store/collections/{id}StoreDelete store collectionRemove the collection without deleting the offers.store:write→GET/store/pagesStoreList store pagesList landing pages and editorial content for the store.store:read→POST/store/pagesStoreCreate store pageCreate a page in Markdown with its own SEO.store:write→GET/store/pages/{id}StoreView store pageReturns content, SEO and publishing status.store:read→PATCH/store/pages/{id}StoreUpdate store pageUpdate content, slug, SEO or post.store:write→DELETE/store/pages/{id}StoreDelete store pageRemoves a separate page from the store.store:write→GET/inbox/contacts/{id}InboxSee contactReturns profile, tags, and activity without direct identifiers.inbox:read→PATCH/inbox/contacts/{id}InboxUpdate contactUpdates name, stage, tags, and authorized preferences.inbox:write→GET/inbox/contacts/{id}/notesInboxList contact notesLists internal notes with author and date.inbox:read→POST/inbox/contacts/{id}/notesInboxCreate note in contactRecords an internal note that is never sent to the contact.inbox:write→POST/inbox/conversations/{id}/assignInboxAssign conversationAssigns or removes the person responsible for the conversation.inbox:write→POST/inbox/conversations/{id}/reopenInboxReopen conversationReopens a closed conversation and records the event.inbox:write→GET/inbox/messages/{id}InboxView messageReturns content and operational state of a message.inbox:read→GET/inbox/messages/{id}/statusInboxCheck message deliveryDistinguish prepared, queued, sent, delivered and failed.inbox:read→POST/journeys/{id}/validateJourneysValidate journeyChecks trigger, blocks, channels and references without running the flow.journeys:read→POST/journeys/{id}/executeJourneysRun journeyStarts an explicit execution for authorized contact or conversation.journeys:write→GET/journeys/{id}/executionsJourneysList journey executionsList status, step and times of executions.journeys:read→GET/journey-executions/{id}JourneysView journey executionReturns the execution and its safe operating context.journeys:read→GET/webhook-eventsWebhooksList webhook eventsReturns the versioned catalog of events and descriptions.webhooks:read→GET/webhook-events/{event}/schemaWebhooksView event schemaReturns the JSON Schema and an example of the event in the current version.webhooks:read→POST/webhooks/{id}/rotate-secretWebhooksRotate webhook secretInvalidates the previous secret and reveals the new one only once.webhooks:write→POST/webhooks/{id}/testWebhooksTest webhookQueues a signed test event to the target.webhooks:write→POST/webhook-deliveries/{id}/redeliverWebhooksResend webhook deliveryCreates an auditable retry for an existing deliverable.webhooks:write→GET/integrationsIntegrationsList integrationsLists connectors and secure state, without returning credentials.integrations:read→GET/integrations/{provider}IntegrationsSee integrationReturns capacity, health, and last validation of a connector.integrations:read→GET/integrations-healthIntegrationsCheck integration healthSummarizes connectors that are configured, healthy, and needing attention.integrations:read→POST/integrations/{provider}/testIntegrationsValidate integrationValidates the available configuration and records the diagnosis.integrations:write→DELETE/integrations/{provider}IntegrationsDisconnect integrationRemoves the connector credentials for the key actor.integrations:write→GET/analytics/funnelAnalyticsAnalyze funnelGroups impression, click, intent, purchase and commission by period.analytics:read→GET/analytics/revenueAnalyticsAnalyze recipeConsolidates registered commission and receipts reconciled by currency.analytics:read→GET/analytics/attributionAnalyticsAnalyze attributionCompares source, group, segment and conversion window.analytics:read→

Filters and pagination

Collections accept limit and offset. Offers, publications, conversations and analytics have additional filters described in OpenAPI.

offersstatus, marketplace, query

publicationsstatus, group_id, offer_id

inbox/conversationsstatus, channel

analytics/*days: 1–365

Create a pending offer

Creation is URL-idempotent. An existing URL returns the current item; nothing is published automatically.

bash

curl -X POST https://achadu.com/api/v1/offers \
  -H "Authorization: Bearer ach_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://www.amazon.com.br/dp/...",
    "title": "Air fryer 5L",
    "price": 329.90,
    "currency": "BRL",
    "coupon": "CASA10"
  }'