canonical: https://jentic.com/apis/goody.com/goody

# Goody API

Jentic publishes the only available OpenAPI specification for Goody API, keeping it validated and agent-ready. The Goody API provides 9 endpoints for sending personalised gifts at scale, covering orders, batches, recipients, and the Goody product catalog. It supports single-recipient gift orders, multi-recipient batch orders, order cancellation, and product browsing so businesses can run programmatic gifting for sales, recruiting, and customer success use cases. Authentication is a bearer token issued from the Goody dashboard.

## For AI agents

Send personalised gifts at scale by creating orders or batches, browsing the Goody product catalog, and managing recipients through 9 endpoints.

## Scope

Does not handle physical-good fulfilment outside the Goody catalog, gift card balance management, or marketing email campaigns - use for Goody single and batch gift orders, product browsing, and recipient lookup only.

## Capabilities

- Create a gift order for one recipient with a chosen Goody product
- Send a batch order to many recipients in one API call
- Cancel an order before it has been redeemed by the recipient
- List Goody products and read full product details before sending
- Look up recipient records and their order history
- Update an existing order's message or scheduling before send

## Use cases

### Sales Prospect Gifting

Sales teams trigger personalised gifts after discovery calls or stage changes. POST /orders creates a single-recipient order with a chosen product and message, and Goody handles redemption - recipients pick a swap if the gift does not suit them, which avoids delivery friction.

Example prompt: Create a gift order for prod_coffee_sampler to prospect@example.com after the deal stage moves to 'Discovery Complete'.

### Customer Retention Batch Gifting

Customer success teams send a single batch gift order to dozens or hundreds of customers around renewals, milestones, or apologies. POST /batches accepts the recipient list and one product so finance gets one charge and ops gets one job to monitor.

Example prompt: Create a batch gift order with prod_curated_box for the 200 enterprise customers whose renewal is in 90 days.

### Recruiting Welcome Gifts

People teams send welcome gifts to new hires on their start date by automating POST /orders from the HR system. Goody schedules delivery so the gift lands when the new hire is most likely to share it, which boosts day-one sentiment.

Example prompt: On a new hire's start date, create a Goody order with prod_welcome_kit to their personal email.

### AI Agent Gifting Step via Jentic

An AI agent that handles customer follow-up adds personalised gifting as a step by calling Goody through Jentic. The agent searches for the right operation, loads the order schema, and executes with the bearer token held in the vault - no manual REST plumbing or product-ID hunting in the docs.

Example prompt: When a CSAT score of 9+ comes in, search Goody for products under $40, pick one, and send the gift to the customer.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /orders | List orders |
| POST | /orders | Create an order |
| GET | /orders/{orderId} | Get an order |
| PATCH | /orders/{orderId} | Update an order |
| POST | /orders/{orderId}/cancel | Cancel an order |
| GET | /products | List products |
| POST | /batches | Create a batch order |

## Key resources

- **Orders** — Create, retrieve, update, and cancel single-recipient gift orders
- **Batches** — Create one batch order that fans out to many recipients
- **Products** — List and read details of Goody catalog products
- **Recipients** — Look up recipient records and order history

## Why Jentic

- **Setup:** Wiring Goody by hand means implementing its bearer auth against api.ongoody.com, scoping calls to a single workspace, and mapping the single and batch gift-order endpoints yourself. Through Jentic you install once, import Goody from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Goody creates orders through a top-level POST body and scopes the token to one workspace, so scope the agent to the operations it needs, such as placing an order or browsing products. You choose the operations it may call, so ones like cancelling an order are not included unless you add them.
- **Credential handling:** Your Goody token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'send a goody gift to a customer' or 'browse the gift catalog', and Jentic returns the matching Goody operation with its input schema so the agent calls the right endpoint without reading the reference.

## Related APIs

- **Giftogram** — Digital gift card platform aimed at the same incentive and recognition use cases.
- **Stripe** — Provides the underlying card or invoice payment that funds Goody orders at scale.
- **Salesforce REST API** — Source of the contact and stage-change events that drive sales gifting.

## FAQ

### Why is there no official OpenAPI spec for Goody API?

Goody does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Goody API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Goody API use?

Goody uses bearer token authentication on the Authorization header. Tokens are issued from the Goody dashboard and scoped to one workspace. Through Jentic the token is held in the encrypted vault and never enters the agent's context.

### Can I send gifts to many recipients in one call?

Yes. POST /batches accepts a list of recipients and a single product so finance is charged once and you only need to monitor one batch ID. POST /orders is the right choice when each recipient gets a different product or message.

### What are the rate limits for the Goody API?

Goody applies per-workspace rate limits documented at ongoody.com/help. The OpenAPI spec does not encode exact numbers, so check Goody support before running batch sends to thousands of recipients - for those, POST /batches is preferable to a loop of POST /orders.

### How do I send a personalised gift through Jentic?

Search Jentic for 'send a goody gift', load the schema for POST /orders, and execute with the recipient and product ID. Jentic injects the bearer token at execution so the agent only handles the gift contents and recipient details.

### Can I cancel a gift after sending it?

Yes, until the recipient redeems it. POST /orders/{orderId}/cancel cancels an unredeemed order and refunds the workspace, but once the recipient has accepted the gift the cancellation will fail and the order is final.

### Can I limit what my agent is allowed to do with the Goody API?

Yes. Because Jentic One is self-hosted, your own rules decide which Goody operations and credentials the agent may use, and the bearer token stays scoped to a single workspace. You can allow just the operations the agent needs, such as creating an order through POST /orders or browsing the catalog with GET /products, while leaving out others like cancelling an order via POST /orders/{orderId}/cancel unless you add them. The agent can only call the endpoints you have granted it.
