Create or update a catalogue item
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Post, RequestUri = new Uri("https://api.azimea.com/v1/items"), Headers = { { "Authorization", "Bearer <token>" }, }, Content = new StringContent("{ \"id\": \"plan-pro\", \"kind\": \"plan\", \"name\": \"Pro plan\", \"description\": \"Unlimited projects and priority support.\", \"url\": \"https://example.com/pricing#pro\", \"imageUrl\": \"https://example.com/img/pro.png\", \"price\": 49, \"comparePrice\": 59, \"currency\": \"EUR\", \"inStock\": true, \"stockQuantity\": null, \"categories\": [ \"plans\" ], \"attributes\": { \"billing\": \"monthly\", \"seats\": 5 }, \"active\": true }") { Headers = { ContentType = new MediaTypeHeaderValue("application/json") } }};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}const url = 'https://api.azimea.com/v1/items';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"id":"plan-pro","kind":"plan","name":"Pro plan","description":"Unlimited projects and priority support.","url":"https://example.com/pricing#pro","imageUrl":"https://example.com/img/pro.png","price":49,"comparePrice":59,"currency":"EUR","inStock":true,"stockQuantity":null,"categories":["plans"],"attributes":{"billing":"monthly","seats":5},"active":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.azimea.com/v1/items \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "id": "plan-pro", "kind": "plan", "name": "Pro plan", "description": "Unlimited projects and priority support.", "url": "https://example.com/pricing#pro", "imageUrl": "https://example.com/img/pro.png", "price": 49, "comparePrice": 59, "currency": "EUR", "inStock": true, "stockQuantity": null, "categories": [ "plans" ], "attributes": { "billing": "monthly", "seats": 5 }, "active": true }'Adds a product, plan or service from your own system to the catalogue Azimea recommends in emails, or updates it. id is your own id for the item: sending the same id again updates the same item, and a field left out keeps its value. A new item defaults to a product, in stock and active; kind is product, plan, service or other. To stop recommending an item but keep its history, send active: false instead of deleting it. Items synced from a connected store are not written here. Needs the items:write permission. Refusals come back as catalog.* codes on the field, for example catalog.item_name_missing, catalog.item_currency_invalid, or catalog.items_limit once the catalogue holds 100,000 items.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”object
Required. Your own id for the item, at most 100 characters. Sending the same id again updates the item.
Example
plan-proproduct, plan, service or other. A new item is a product unless you say otherwise.
Example
planRequired, at most 300 characters.
Example
Pro planAt most 5,000 characters.
Example
Unlimited projects and priority support.A full address starting with https://, at most 2,000 characters.
Example
https://example.com/pricing#proA full address starting with https://, at most 2,000 characters.
Example
https://example.com/img/pro.pngZero or more.
Example
49The price before a discount. Must be higher than price.
Example
59The three-letter currency code, such as EUR or GBP.
Example
EURA new item is in stock unless you say otherwise.
Example
trueA whole number of zero or more.
Example
nullAt most 20, each a short name.
Example
[ "plans"]At most 50 fields, each a short lowercase key with a text, number or yes/no value.
object
Example
{ "billing": "monthly", "seats": 5}A new item is active. false stops recommending it but keeps its history.
Example
trueExample
{ "id": "plan-pro", "kind": "plan", "name": "Pro plan", "description": "Unlimited projects and priority support.", "url": "https://example.com/pricing#pro", "imageUrl": "https://example.com/img/pro.png", "price": 49, "comparePrice": 59, "currency": "EUR", "inStock": true, "stockQuantity": null, "categories": [ "plans" ], "attributes": { "billing": "monthly", "seats": 5 }, "active": true}Responses
Section titled “Responses”The item as stored
object
true when the call worked, false when errors say why it did not.
The answer itself; null when the call failed.
object
Azimea’s id for the item.
Where the item comes from: store (synced from a connected shop, edited only there), file (an import) or api.
The connected store the item belongs to; null for items from a file or the API.
Your own id for the item, the one you sent as id.
product, plan, service or other.
The item’s name.
A description, up to 5,000 characters.
Where the item can be bought or read about: a full address starting with https://.
An image of the item: a full address starting with https://.
The current price, in currency.
The price before a discount. Higher than price when set.
The three-letter currency code, such as EUR or GBP.
true when the item can be bought.
How many are left; null when you do not track it.
The item’s categories. They drive the “one category” and “for each person” recommendations in emails.
Extra fields you attached, by key.
object
false stops recommending the item and keeps its history.
When the item was added.
When it last changed; null if it never did.
An internal result number. Rely on the HTTP status code instead.
What went wrong, one entry per problem; empty when the call worked.
object
A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.
An English sentence for your logs. Do not show it to end users: it can change.
The numbers the message mentions (a minimum, a maximum), when there are any.
object
The same problems grouped by the request field they belong to; null when none is tied to a field.
object
object
A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.
An English sentence for your logs. Do not show it to end users: it can change.
The numbers the message mentions (a minimum, a maximum), when there are any.
object
Example
{ "isSuccess": true, "value": { "id": "01a10900-0000-7000-8000-000000000001", "source": "api", "storeId": null, "externalId": "plan-pro", "kind": "plan", "name": "Pro plan", "description": "Unlimited projects and priority support.", "url": "https://example.com/pricing#pro", "imageUrl": "https://example.com/img/pro.png", "price": 49, "comparePrice": 59, "currency": "EUR", "inStock": true, "stockQuantity": null, "categories": [ "plans" ], "attributes": { "billing": "monthly", "seats": 5 }, "active": true, "createdAt": "2026-10-05T09:00:00+00:00", "updatedAt": null }, "status": 0, "errors": [], "fieldErrors": null}Validation failed: see errors[].code and fieldErrors
object
true when the call worked, false when errors say why it did not.
The answer itself; null when the call failed.
An internal result number. Rely on the HTTP status code instead.
What went wrong, one entry per problem; empty when the call worked.
object
A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.
An English sentence for your logs. Do not show it to end users: it can change.
The numbers the message mentions (a minimum, a maximum), when there are any.
object
The same problems grouped by the request field they belong to; null when none is tied to a field.
object
object
A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.
An English sentence for your logs. Do not show it to end users: it can change.
The numbers the message mentions (a minimum, a maximum), when there are any.
object
Example
{ "isSuccess": false, "value": null, "status": 5, "errors": [ { "code": "validation.required", "message": "Fill in this field.", "params": null } ], "fieldErrors": { "email": [ { "code": "validation.required", "message": "Fill in this field.", "params": null } ] }}Missing or invalid API key
The key lacks the items:write permission
Too many requests for this key