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 70 operations below are available in production and use the same account audit.

Search operation

70 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→

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"
  }'