NiftyImages API

Name: NiftyImages API
Brand: NiftyImages API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentMarketingEmail MarketingapiKey, basic27 EndpointsREST

For Agents

Manage NiftyImages personalised email images, data stores, countdown timers, maps, and end users across 27 endpoints under api.niftyimages.com.

Install Jentic One Beta

Connect the NiftyImages API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the NiftyImages API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with NiftyImages API.

Page through and inspect personalised images on the account through /v1/Images

Pull aggregated open and click stats through /v1/Images/stats

Add or delete records in a personalisation data store through /v1/DataStores/{storeKey}/records

GET STARTED

Start building with NiftyImages API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for NiftyImages API, keeping it validated and agent-ready. NiftyImages is an email-marketing service that generates personalised images, countdown timers, dynamic maps, and Photoshop-driven graphics rendered at open time inside an email. The REST API lets developers list and delete images, manage data store records that drive personalisation, update countdown timers, edit map locations, suspend Bee Plugin and Widget end users, and pull aggregated stats. Authentication is by ApiKey (header or query) or HTTP Basic, the same key issued from a NiftyImages account.

Use Cases

Patterns agents use NiftyImages API for, with concrete tasks.

★ Personalisation data store sync

Email marketers can keep a NiftyImages data store in sync with their CRM by pushing new or updated rows whenever a contact changes. POST /v1/DataStores/{storeKey}/records adds a record, DELETE /v1/DataStores/{storeKey}/records/{recordId} removes one, and GET /v1/DataStores/{storeKey}/fields returns the field schema so the agent always sends the right column names.

POST a record to /v1/DataStores/customers/records with fields {first_name: 'Sam', tier: 'gold'} and confirm it appears in GET /v1/DataStores/customers/records.

Countdown timer scheduling

Promotional emails often use NiftyImages countdown timers that render a fresh image at open time. PUT /v1/Timers/{timerKey} updates the target date, so an agent can roll the same timer asset forward through a sequence of campaigns instead of creating a new one each time.

PUT /v1/Timers/black-friday-2026 with the new target date 2026-11-27T05:00:00Z and verify the response confirms the update.

Dynamic store-locator maps in email

Brands with physical stores can render a personalised map in each recipient's email by maintaining a NiftyImages map of locations. POST /v1/Maps/{mapKey}/locations adds a store, PUT updates one, DELETE retires a closure, and GET /v1/Maps/{mapKey}/locations/search returns nearest matches for a given postcode at send time.

POST a new location with name 'Brighton Pier Cafe' and lat/lng coordinates to /v1/Maps/cafes/locations.

AI agent email personalisation operations

An AI agent running an email marketing playbook can push fresh personalisation data, swap in a new countdown timer, and pull image performance stats across an entire campaign. Through Jentic, the agent searches by intent and Jentic returns the right NiftyImages endpoint with its schema. The ApiKey header value is held in the vault and never enters the agent's chat context.

Search Jentic for 'add a record to a data store', load POST /v1/DataStores/{storeKey}/records, and execute it for storeKey=loyalty with fields email and points.

Key Endpoints

27 endpoints — jentic publishes the only available openapi specification for niftyimages api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/v1/Images

Page through images on the account

GET

/v1/Images/stats

Get aggregated image stats

POST

/v1/DataStores/{storeKey}/records

Add a record to a personalisation data store

DELETE

/v1/DataStores/{storeKey}/records/{recordId}

Delete a single data store record

PUT

/v1/Timers/{timerKey}

Update a countdown timer's target date

POST

/v1/Maps/{mapKey}/locations

Add a location to a map

GET

/v1/Maps/{mapKey}/locations/search

Search a map for nearby locations

PUT

/v1/BeePlugin/users/{userId}/suspend

Suspend a Bee Plugin user

GET

/v1/Images

Page through images on the account

GET

/v1/Images/stats

Get aggregated image stats

POST

/v1/DataStores/{storeKey}/records

Add a record to a personalisation data store

DELETE

/v1/DataStores/{storeKey}/records/{recordId}

Delete a single data store record

PUT

/v1/Timers/{timerKey}

Update a countdown timer's target date

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

NiftyImages ApiKey values (and Basic auth credentials) are stored encrypted in the Jentic vault. Agents call NiftyImages via Jentic, which attaches the ApiKey header server-side; raw keys never enter the agent's chat context.

Intent-based discovery

Agents search Jentic by intent (e.g. 'add a record to a data store' or 'update a countdown timer') and Jentic returns the matching NiftyImages endpoint with its input schema.

Time to first call

Direct NiftyImages integration: 1-2 days to wire data store sync, timer updates, and map management. Through Jentic: under 1 hour — search, load schema, execute.

FAQs

Specific to using NiftyImages API through Jentic.

Why is there no official OpenAPI spec for NiftyImages API?

NiftyImages does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call NiftyImages API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the NiftyImages API use?

NiftyImages supports an ApiKey passed in the ApiKey header, the same key in a query parameter, or HTTP Basic auth using the account credentials. Through Jentic, the ApiKey value is stored encrypted in the vault and attached to each request server-side.

Can I update the target date on a countdown timer?

Yes. PUT /v1/Timers/{timerKey} accepts a new target date and updates the timer in place, so the same timer asset can be reused across campaigns by rolling the date forward.

What are the rate limits for the NiftyImages API?

NiftyImages applies usage limits per account plan but does not publish numeric limits in the OpenAPI spec. Heavy data store sync jobs should batch writes and back off on HTTP 429 responses.

How do I add a personalisation data store record through Jentic?

Run pip install jentic, search Jentic for 'add a record to a data store', and load POST /v1/DataStores/{storeKey}/records. Provide the storeKey and a fields object matching the schema returned by GET /v1/DataStores/{storeKey}/fields.

Is the NiftyImages API free?

API access is bundled with paid NiftyImages plans. There is a free trial tier; commercial usage requires a paid subscription, the price of which depends on monthly image opens.

NiftyImages API

Connect the NiftyImages API to your agent

Capabilities

Start building with NiftyImages API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs