API-Referenz
Die Reloadify API ist eine REST API für die Marketingdaten deines Shops: Profile, Produkte, Bestellungen, Warenkörbe und mehr. Sie nimmt JSON an und gibt JSON zurück, nutzt die üblichen HTTP-Methoden und Statuscodes und authentifiziert mit OAuth2.
Fast jede Ressource gehört zu einer Sprache (einem Shop oder Markt). Du fragst zuerst deine Sprachen ab und nutzt dann in jedem weiteren Aufruf eine language_id im Pfad.
# Pro Sprache
/v2/languages
/v2/languages/{language_id}/profiles
/v2/languages/{language_id}/products
/v2/languages/{language_id}/orders
/v2/languages/{language_id}/shopping_carts
/v2/languages/{language_id}/categories · brands · variants · reviews
# Auf Kontoebene
/v2/custom_attributes
/v2/batch_jobs/{batch_id}
Authentifizierung
Die API nutzt den OAuth2-Client-Credentials-Flow. Tausch deine Client-ID und dein Secret am Token-Endpoint gegen ein Access Token und sende es bei jeder Anfrage als Bearer Token mit.
Zugangsdaten erstellst du in deinem Reloadify-Konto. Tokens sind nur kurz gültig: Fordere ein neues an, sobald es abläuft (HTTP 401).
curl -X POST https://app.reloadify.com/oauth/token \
-H "Content-Type: application/json" \
-d '{
"grant_type": "client_credentials",
"client_id": "YOUR_CLIENT_ID",
"client_secret": "YOUR_CLIENT_SECRET"
}'
curl https://app.reloadify.com/api/v2/languages \
-H "Authorization: Bearer {access_token}"
Sprachen & Scope
Eine Sprache steht für einen Shop oder Markt. Alle Katalog- und Zielgruppendaten gehören zu einer Sprache, deshalb beginnt jeder Pfad für Produkte, Profile und Bestellungen mit /v2/languages/{language_id}/….
Ruf GET /v2/languages auf, um zu sehen, welche ids du mit deinen Zugangsdaten nutzen kannst.
curl https://app.reloadify.com/api/v2/languages \
-H "Authorization: Bearer {access_token}"
Paginierung & Filter
Listen-Endpoints arbeiten mit Seiten. Gib page (Standard 1) und per_page (Standard 10, höchstens 250) mit. Die meisten Listen akzeptieren auch Zeitfilter, created_after, created_before, updated_after und updated_before (ISO-8601-Datum und -Uhrzeit), damit du nur synchronisierst, was sich geändert hat.
Manche Listen lassen sich nach id oder E-Mail-Adresse filtern, zum Beispiel mit emails[]; bei jeder Ressource steht, welche Parameter sie unterstützt.
curl "https://app.reloadify.com/api/v2/languages/{language_id}/profiles?per_page=250&updated_after=2026-06-01T00:00:00Z" \
-H "Authorization: Bearer {access_token}"
Asynchrone Batch-Jobs
Für Schreibvorgänge in großen Mengen hat jede wichtige Ressource einen POST …/batch_jobs-Endpoint. Er nimmt ein Array mit Datensätzen an und gibt sofort eine batch_id zurück; die Verarbeitung läuft asynchron.
Über GET /v2/batch_jobs/{batch_id} fragst du status, success_count und error_count ab. Ist der Job fertig, holst du das Ergebnis pro Datensatz über GET /v2/batch_jobs/{batch_id}/results.
{
"batch_id": "123",
"status": "…",
"resource_type": "…",
"language_id": "123",
"total_count": "…",
"success_count": "…",
"error_count": "…",
"submitted_at": "…",
"started_at": "…",
"completed_at": "…",
"status_url": "…",
"error_code": "…",
"error_message": "…",
"results_url": "…",
"poll_after_at": "…"
}
Fehler
Die API nutzt die üblichen HTTP-Statuscodes. 2xx heißt, dass es geklappt hat, 4xx weist auf ein Problem mit der Anfrage hin (ein fehlendes Feld, ein ungültiges Token oder eine Ressource, die nicht existiert), und 5xx bedeutet, dass auf unserer Seite etwas schiefging.
| Status | Bedeutung |
|---|---|
| 200 / 201 / 202 | Erfolgreich. Ein Batch gibt 202 mit einer batch_id zurück. |
| 401 | Access Token fehlt oder ist abgelaufen: Fordere ein neues an. |
| 404 | Ressource (oder Sprache) nicht gefunden. |
| 422 | Validierung fehlgeschlagen: Der Body nennt das fehlerhafte Feld. |
| 429 | Rate Limit erreicht. Warte kurz und versuch es erneut. |
| 5xx | Serverfehler: Du kannst es gefahrlos erneut versuchen, mit wachsender Wartezeit. |
{
"error": "validation_failed",
"message": "email is invalid"
}
Sprachen
Jede Ressource gehört zu einer Sprache (Shop/Markt). Frag zuerst deine Sprachen ab: Ihre ids brauchst du in jedem anderen Pfad.
- idstring
- namestring
- codestring
- activestring
- pageinteger · int32
- Abzurufende Seite. Standard
1. - per_pageinteger · int32
- Anzahl der Einträge pro Seite. Höchstens 250. Standard
10.
{
"id": "123",
"name": "Example",
"code": "en",
"active": "…"
}
curl https://app.reloadify.com/api/v2/languages \
-H "Authorization: Bearer {access_token}"
| Methode | Pfad | Beschreibung |
|---|---|---|
| GET | /v2/languages | Gibt eine Liste der Sprachen zurück |
| PUT | /v2/languages | Aktualisierte Sprache |
| GET | /v2/languages/{language_id} | Gibt eine Sprache anhand der ID zurück |
| DELETE | /v2/languages/{language_id} |
Profile
Die Menschen in deiner Zielgruppe: Kontaktdaten, Einwilligungsstatus, eigene Attribute und Adresse.
- custom_attributesstring
- idstring
- activestring
- unsubscribedstring
- emailstring
- subscribed_to_newsletterstring
- subscribed_to_newsletter_atstring
- double_opt_instring
- first_namestring
- middle_namestring
- last_namestring
- genderstring
- company_namestring
- telephonestring
- streetstring
- housenumberstring
- citystring
- provincestring
- zipcodestring
- country_codestring
- tagsstring
- is_registeredstring
- is_companystring
- birthdatestring
- created_afterstring · date-time
- created_beforestring · date-time
- updated_afterstring · date-time
- updated_beforestring · date-time
- pageinteger · int32
- Abzurufende Seite. Standard
1. - per_pageinteger · int32
- Anzahl der Einträge pro Seite. Höchstens 250. Standard
10. - emails[]array
{
"custom_attributes": "…",
"id": "123",
"active": "…",
"unsubscribed": "…",
"email": "profile@example.com",
"subscribed_to_newsletter": "…",
"subscribed_to_newsletter_at": "…",
"double_opt_in": "…",
"first_name": "…",
"middle_name": "…",
"last_name": "…",
"gender": "…",
"company_name": "…",
"telephone": "…",
"street": "…",
"housenumber": "…",
"city": "…",
"province": "…",
"zipcode": "…",
"country_code": "…",
"tags": "…",
"is_registered": "…",
"is_company": "…",
"birthdate": "…"
}
curl https://app.reloadify.com/api/v2/languages/{language_id}/profiles \
-H "Authorization: Bearer {access_token}"
| Methode | Pfad | Beschreibung |
|---|---|---|
| GET | /v2/languages/{language_id}/profiles | Gibt eine Liste der Profile einer Sprache zurück. |
| PUT | /v2/languages/{language_id}/profiles | Legt ein Profil anhand der E-Mail-Adresse in einer Sprache an oder aktualisiert es |
| POST | /v2/languages/{language_id}/profiles/batch_jobs | Sendet einen asynchronen Batch mit Profilen. Gibt 202 mit einer batch_id zurück; den Status fragst du über /v2/batch_jobs/:batch_id ab. |
| GET | /v2/languages/{language_id}/profiles/{profile_id} | Sucht Profile anhand der ID in einer Sprache |
| DELETE | /v2/languages/{language_id}/profiles/{profile_id} | |
| GET | /v2/languages/{language_id}/profile_streams | Gibt einen Keyset-paginierten Stream der Profile einer Sprache zurück, aufsteigend nach id sortiert. Eine Gesamtzahl wird nicht berechnet; die nächste Seite holst du über den Header X-Next-After-Id (oder den Header Link rel="next"). |
Produkte
Dein Katalog. Produkte haben Varianten, Kategorien, Marken und Links zu relevanten Produkten.
- custom_attributesstring
- idstring
- namestring
- visiblestring
- main_imagestring
- urlstring
- pricenumber · double
- short_descriptionstring
- brand_idstring
- category_idsstring
- relevant_product_idsstring
- created_afterstring · date-time
- created_beforestring · date-time
- updated_afterstring · date-time
- updated_beforestring · date-time
- pageinteger · int32
- Abzurufende Seite. Standard
1. - per_pageinteger · int32
- Anzahl der Einträge pro Seite. Höchstens 250. Standard
10.
{
"custom_attributes": "…",
"id": "123",
"name": "Example",
"visible": "…",
"main_image": "…",
"url": "…",
"price": 0,
"short_description": "…",
"brand_id": "123",
"category_ids": "…",
"relevant_product_ids": "…"
}
curl https://app.reloadify.com/api/v2/languages/{language_id}/products \
-H "Authorization: Bearer {access_token}"
| Methode | Pfad | Beschreibung |
|---|---|---|
| GET | /v2/languages/{language_id}/products | Gibt eine Liste der Produkte einer Sprache zurück |
| PUT | /v2/languages/{language_id}/products | Legt ein Produkt in einer Sprache an oder aktualisiert es |
| POST | /v2/languages/{language_id}/products/batch_jobs | Sendet einen asynchronen Batch mit Produkten. Gibt 202 mit einer batch_id zurück; den Status fragst du über /v2/batch_jobs/:batch_id ab. Eine referenzierte Marke wird automatisch angelegt, falls sie noch nicht existiert, sodass du Produkte vor ihren Marken hochladen kannst. Jedes Produkt kann seine Varianten direkt über variants[] mitliefern. |
| GET | /v2/languages/{language_id}/products/{product_id} | Sucht ein Produkt anhand der ID in einer Sprache |
| DELETE | /v2/languages/{language_id}/products/{product_id} | |
| GET | /v2/languages/{language_id}/products/{product_id}/variants | Gibt eine Liste der Varianten eines Produkts zurück |
| GET | /v2/languages/{language_id}/products/{product_id}/categories | Gibt eine Liste der Kategorien eines Produkts zurück |
| PUT | /v2/languages/{language_id}/products/{product_id}/categories/{category_id} | Fügt ein Produkt zu einer Kategorie hinzu |
| DELETE | /v2/languages/{language_id}/products/{product_id}/categories/{category_id} | |
| GET | /v2/languages/{language_id}/products/{product_id}/relevant_products | Gibt eine Liste der relevanten Produkte zu einem Produkt zurück |
| PUT | /v2/languages/{language_id}/products/{product_id}/relevant_products/{relevant_product_id} | Fügt einem Produkt ein relevantes Produkt hinzu |
| DELETE | /v2/languages/{language_id}/products/{product_id}/relevant_products/{relevant_product_id} |
Varianten
Verkaufbare Varianten eines Produkts (Größe, Farbe) mit eigener SKU, eigenem Preis und Bestand.
- custom_attributesstring
- idstring
- product_idstring
- article_codestring
- defaultstring
- titlestring
- eanstring
- main_imagestring
- skustring
- price_coststring
- price_inclstring
- price_exclstring
- old_price_inclstring
- old_price_exclstring
- stock_levelstring
- created_atstring
- updated_atstring
- created_afterstring · date-time
- created_beforestring · date-time
- updated_afterstring · date-time
- updated_beforestring · date-time
- pageinteger · int32
- Abzurufende Seite. Standard
1. - per_pageinteger · int32
- Anzahl der Einträge pro Seite. Höchstens 250. Standard
10.
{
"custom_attributes": "…",
"id": "123",
"product_id": "123",
"article_code": "…",
"default": "…",
"title": "…",
"ean": "…",
"main_image": "…",
"sku": "…",
"price_cost": "…",
"price_incl": "…",
"price_excl": "…",
"old_price_incl": "…",
"old_price_excl": "…",
"stock_level": "…",
"created_at": "…",
"updated_at": "…"
}
curl https://app.reloadify.com/api/v2/languages/{language_id}/variants \
-H "Authorization: Bearer {access_token}"
| Methode | Pfad | Beschreibung |
|---|---|---|
| GET | /v2/languages/{language_id}/variants | Gibt eine Liste der Varianten einer Sprache zurück |
| PUT | /v2/languages/{language_id}/variants | Legt eine Variante in einer Sprache an oder aktualisiert sie |
| POST | /v2/languages/{language_id}/variants/batch_jobs | Sendet einen asynchronen Batch mit Varianten. Gibt 202 mit einer batch_id zurück; den Status fragst du über /v2/batch_jobs/:batch_id ab. Ein referenziertes Produkt wird automatisch angelegt, falls es noch nicht existiert, sodass du Varianten vor ihren Produkten hochladen kannst. |
| GET | /v2/languages/{language_id}/variants/{variant_id} | Sucht eine Variante anhand der ID in einer Sprache |
| DELETE | /v2/languages/{language_id}/variants/{variant_id} |
Kategorien
Der Kategoriebaum des Katalogs; ein Produkt kann in mehreren Kategorien sein.
- custom_attributesstring
- idstring
- parent_category_idstring
- product_idsstring
- namestring
- urlstring
- created_atstring
- updated_atstring
- created_afterstring · date-time
- created_beforestring · date-time
- updated_afterstring · date-time
- updated_beforestring · date-time
- pageinteger · int32
- Abzurufende Seite. Standard
1. - per_pageinteger · int32
- Anzahl der Einträge pro Seite. Höchstens 250. Standard
10.
{
"custom_attributes": "…",
"id": "123",
"parent_category_id": "123",
"product_ids": "…",
"name": "Example",
"url": "…",
"created_at": "…",
"updated_at": "…"
}
curl https://app.reloadify.com/api/v2/languages/{language_id}/categories \
-H "Authorization: Bearer {access_token}"
| Methode | Pfad | Beschreibung |
|---|---|---|
| GET | /v2/languages/{language_id}/categories | Gibt eine Liste der Kategorien einer Sprache zurück |
| PUT | /v2/languages/{language_id}/categories | Legt eine Kategorie in einer Sprache an oder aktualisiert sie |
| POST | /v2/languages/{language_id}/categories/batch_jobs | Sendet einen asynchronen Batch mit Kategorien. Gibt 202 mit einer batch_id zurück; den Status fragst du über /v2/batch_jobs/:batch_id ab. Eine referenzierte übergeordnete Kategorie wird automatisch angelegt, falls sie noch nicht existiert, sodass du Kategorien in beliebiger Reihenfolge hochladen kannst. |
| GET | /v2/languages/{language_id}/categories/{category_id} | Sucht eine Kategorie anhand der ID in einer Sprache |
| DELETE | /v2/languages/{language_id}/categories/{category_id} | |
| GET | /v2/languages/{language_id}/categories/{category_id}/products | Gibt eine Liste der Produkte einer Kategorie zurück |
Marken
Marken, die mit Produkten verknüpft sind; die Produkte einer Marke fragst du über die Sub-Ressource ab.
- custom_attributesstring
- idstring
- product_idsstring
- namestring
- urlstring
- contentstring
- created_atstring
- updated_atstring
- created_afterstring · date-time
- created_beforestring · date-time
- updated_afterstring · date-time
- updated_beforestring · date-time
- pageinteger · int32
- Abzurufende Seite. Standard
1. - per_pageinteger · int32
- Anzahl der Einträge pro Seite. Höchstens 250. Standard
10.
{
"custom_attributes": "…",
"id": "123",
"product_ids": "…",
"name": "Example",
"url": "…",
"content": "…",
"created_at": "…",
"updated_at": "…"
}
curl https://app.reloadify.com/api/v2/languages/{language_id}/brands \
-H "Authorization: Bearer {access_token}"
| Methode | Pfad | Beschreibung |
|---|---|---|
| GET | /v2/languages/{language_id}/brands | Gibt eine Liste der Marken einer Sprache zurück |
| PUT | /v2/languages/{language_id}/brands | Legt eine Marke in einer Sprache an oder aktualisiert sie |
| POST | /v2/languages/{language_id}/brands/batch_jobs | Sendet einen asynchronen Batch mit Marken. Gibt 202 mit einer batch_id zurück; den Status fragst du über /v2/batch_jobs/:batch_id ab. |
| GET | /v2/languages/{language_id}/brands/{brand_id} | Sucht eine Marke anhand der ID in einer Sprache |
| DELETE | /v2/languages/{language_id}/brands/{brand_id} | |
| GET | /v2/languages/{language_id}/brands/{brand_id}/products | Gibt eine Liste der Produkte einer Marke zurück |
Bestellungen
Abgeschlossene Bestellungen und ihre Positionen, genutzt für Segmentierung und Umsatz.
- custom_attributesstring
- idstring
- ordered_atstring
- profile_idstring
- product_idsstring
- currencystring
- created_atstring
- checkout_idstring
- numberstring
- pricenumber · double
- statusstring
- refunded_atstring
- total_refundednumber · double
- discount_codestring
- is_discount_appliedstring
- paidstring
- created_afterstring · date-time
- created_beforestring · date-time
- updated_afterstring · date-time
- updated_beforestring · date-time
- pageinteger · int32
- Abzurufende Seite. Standard
1. - per_pageinteger · int32
- Anzahl der Einträge pro Seite. Höchstens 250. Standard
10.
{
"custom_attributes": "…",
"id": "123",
"ordered_at": "…",
"profile_id": "123",
"product_ids": "…",
"currency": "…",
"created_at": "…",
"checkout_id": "123",
"number": "…",
"price": 0,
"status": "…",
"refunded_at": "…",
"total_refunded": 0,
"discount_code": "…",
"is_discount_applied": "…",
"paid": "…"
}
curl https://app.reloadify.com/api/v2/languages/{language_id}/orders \
-H "Authorization: Bearer {access_token}"
| Methode | Pfad | Beschreibung |
|---|---|---|
| GET | /v2/languages/{language_id}/orders | Gibt eine Liste der Bestellungen einer Sprache zurück |
| PUT | /v2/languages/{language_id}/orders | Legt eine Bestellung in einer Sprache an oder aktualisiert sie |
| POST | /v2/languages/{language_id}/orders/batch_jobs | Sendet einen asynchronen Batch mit Bestellungen. Gibt 202 mit einer batch_id zurück; den Status fragst du über /v2/batch_jobs/:batch_id ab. Ein referenziertes Profil wird automatisch als Stub angelegt, falls es noch nicht existiert (nur platform_id, keine E-Mail); aktualisiere das Profil separat über /v2/profiles, um die Attribute zu ergänzen. Jede Bestellung kann ihre Positionen direkt über order_products[] mitliefern. |
| GET | /v2/languages/{language_id}/orders/{order_id} | Sucht eine Bestellung anhand der ID in einer Sprache |
| DELETE | /v2/languages/{language_id}/orders/{order_id} | |
| GET | /v2/languages/{language_id}/orders/{order_id}/products | Listet alle Produkte einer Bestellung auf |
| PUT | /v2/languages/{language_id}/orders/{order_id}/products/{product_id} | Fügt einer Bestellung ein Produkt hinzu |
| DELETE | /v2/languages/{language_id}/orders/{order_id}/products/{product_id} | Entfernt ein Produkt aus einer Bestellung |
Bestellte Produkte
Verknüpfung von Produkten mit Bestellungen, nur in großen Mengen (asynchroner Batch).
- custom_attributesstring
- order_idstring
- product_idstring
- variant_idstring
- quantitystring
- quantity_refundedstring
- total_refundednumber · double
{
"custom_attributes": "…",
"order_id": "123",
"product_id": "123",
"variant_id": "123",
"quantity": "…",
"quantity_refunded": "…",
"total_refunded": 0
}
| Methode | Pfad | Beschreibung |
|---|---|---|
| POST | /v2/languages/{language_id}/order_products/batch_jobs | Sendet einen asynchronen Batch mit order_products. Gibt 202 mit einer batch_id zurück; den Status fragst du über /v2/batch_jobs/:batch_id ab. Referenzierte Bestellungen, Produkte und Varianten werden automatisch als Stubs angelegt, falls sie noch nicht existieren, sodass du order_products vor diesen Ressourcen hochladen kannst. Eine Stub-Bestellung hat noch kein Profil und wird ergänzt, sobald die vollständige Bestellung über den orders-Endpoint eingeht (beide Wege treffen sich bei derselben order-id). |
Warenkörbe
Aktive und abgebrochene Warenkörbe mit ihren Produkten: der Auslöser für Warenkorb-Flows.
- custom_attributesstring
- idstring
- profile_idstring
- product_idsstring
- currencystring
- pricestring
- recovery_urlstring
- recovery_tokenstring
- deletedstring
- created_atstring
- updated_atstring
- created_afterstring · date-time
- created_beforestring · date-time
- updated_afterstring · date-time
- updated_beforestring · date-time
- pageinteger · int32
- Abzurufende Seite. Standard
1. - per_pageinteger · int32
- Anzahl der Einträge pro Seite. Höchstens 250. Standard
10.
{
"custom_attributes": "…",
"id": "123",
"profile_id": "123",
"product_ids": "…",
"currency": "…",
"price": "…",
"recovery_url": "…",
"recovery_token": "…",
"deleted": "…",
"created_at": "…",
"updated_at": "…"
}
curl https://app.reloadify.com/api/v2/languages/{language_id}/shopping_carts \
-H "Authorization: Bearer {access_token}"
| Methode | Pfad | Beschreibung |
|---|---|---|
| GET | /v2/languages/{language_id}/shopping_carts | Gibt eine Liste der Warenkörbe einer Sprache zurück |
| PUT | /v2/languages/{language_id}/shopping_carts | Legt einen Warenkorb in einer Sprache an oder aktualisiert ihn |
| POST | /v2/languages/{language_id}/shopping_carts/batch_jobs | Sendet einen asynchronen Batch mit Warenkörben. Gibt 202 mit einer batch_id zurück; den Status fragst du über /v2/batch_jobs/:batch_id ab. Ein referenziertes Profil wird automatisch als Stub angelegt, falls es noch nicht existiert (nur platform_id, keine E-Mail); aktualisiere das Profil separat über /v2/profiles, um die Attribute zu ergänzen. Jeder Warenkorb kann seine Produkte direkt über products[] mitliefern. |
| GET | /v2/languages/{language_id}/shopping_carts/{shopping_cart_id} | Sucht einen Warenkorb anhand der ID in einer Sprache |
| DELETE | /v2/languages/{language_id}/shopping_carts/{shopping_cart_id} | |
| GET | /v2/languages/{language_id}/shopping_carts/{shopping_cart_id}/products | Listet alle Produkte eines Warenkorbs auf |
| PUT | /v2/languages/{language_id}/shopping_carts/{shopping_cart_id}/products/{product_id} | Fügt einem Warenkorb ein Produkt hinzu |
| DELETE | /v2/languages/{language_id}/shopping_carts/{shopping_cart_id}/products/{product_id} |
Bewertungen
Produktbewertungen von Kunden.
- custom_attributesstring
- idstring
- product_idstring
- profile_idstring
- descriptionstring
- namestring
- visiblestring
- scorestring
- created_atstring
- updated_atstring
- created_afterstring · date-time
- created_beforestring · date-time
- updated_afterstring · date-time
- updated_beforestring · date-time
- pageinteger · int32
- Abzurufende Seite. Standard
1. - per_pageinteger · int32
- Anzahl der Einträge pro Seite. Höchstens 250. Standard
10.
{
"custom_attributes": "…",
"id": "123",
"product_id": "123",
"profile_id": "123",
"description": "…",
"name": "Example",
"visible": "…",
"score": "…",
"created_at": "…",
"updated_at": "…"
}
curl https://app.reloadify.com/api/v2/languages/{language_id}/reviews \
-H "Authorization: Bearer {access_token}"
| Methode | Pfad | Beschreibung |
|---|---|---|
| GET | /v2/languages/{language_id}/reviews | Gibt eine Liste der Bewertungen einer Sprache zurück |
| PUT | /v2/languages/{language_id}/reviews | Legt eine Bewertung in einer Sprache an oder aktualisiert sie |
| POST | /v2/languages/{language_id}/reviews/batch_jobs | Sendet einen asynchronen Batch mit Bewertungen. Gibt 202 mit einer batch_id zurück; den Status fragst du über /v2/batch_jobs/:batch_id ab. Referenzierte Produkte und Profile werden automatisch als Stubs angelegt, falls sie noch nicht existieren (nur platform_id); aktualisiere sie separat, um die Attribute zu ergänzen. |
| GET | /v2/languages/{language_id}/reviews/{review_id} | Sucht eine Bewertung anhand der ID in einer Sprache |
| DELETE | /v2/languages/{language_id}/reviews/{review_id} |
Kauf-Events
Kaufsignale, die Flows und Empfehlungen steuern (nur schreiben / Batch).
| Methode | Pfad | Beschreibung |
|---|---|---|
| PUT | /v2/languages/{language_id}/purchase_events | Legt ein serverseitiges Kauf-Event an |
| POST | /v2/languages/{language_id}/purchase_events/batch_jobs | Sendet einen asynchronen Batch mit Kauf-Events. Gibt 202 mit einer batch_id zurück; den Status fragst du über /v2/batch_jobs/:batch_id ab. Das referenzierte Profil und der Besucher müssen bereits existieren: Einträge mit einer unbekannten profile_id oder einem unbekannten visitor_token kommen in den Ergebnissen als Fehler zurück. |
Globale Abmeldungen
E-Mail-Adressen, die sich innerhalb einer Sprache von allen Listen abgemeldet haben.
- profile_emailstring
- profile_idstring
- created_atstring
- updated_atstring
- created_afterstring · date-time
- created_beforestring · date-time
- updated_afterstring · date-time
- updated_beforestring · date-time
- pageinteger · int32
- Abzurufende Seite. Standard
1. - per_pageinteger · int32
- Anzahl der Einträge pro Seite. Höchstens 250. Standard
10.
{
"profile_email": "…",
"profile_id": "123",
"created_at": "…",
"updated_at": "…"
}
curl https://app.reloadify.com/api/v2/languages/{language_id}/global_unsubscribes \
-H "Authorization: Bearer {access_token}"
| Methode | Pfad | Beschreibung |
|---|---|---|
| GET | /v2/languages/{language_id}/global_unsubscribes | Gibt eine Liste der globalen Abmeldungen zurück |
| PUT | /v2/languages/{language_id}/global_unsubscribes | Legt eine globale Abmeldung an |
Eigene Attribute
Definitionen der eigenen Profilattribute in deinem Konto (nicht pro Sprache).
- namestring
- handlestring
- descriptionstring
- datatypestring
- resourcestring
- pageinteger · int32
- Abzurufende Seite. Standard
1. - per_pageinteger · int32
- Anzahl der Einträge pro Seite. Höchstens 250. Standard
10.
{
"name": "Example",
"handle": "…",
"description": "…",
"datatype": "…",
"resource": "…"
}
curl https://app.reloadify.com/api/v2/custom_attributes \
-H "Authorization: Bearer {access_token}"
| Methode | Pfad | Beschreibung |
|---|---|---|
| GET | /v2/custom_attributes | Gibt eine Liste der eigenen Attribute zurück |
| PUT | /v2/custom_attributes | Aktualisiertes eigenes Attribut |
| POST | /v2/custom_attributes/batch_jobs | Sendet einen asynchronen Batch mit eigenen Attributen. Gibt 202 mit einer batch_id zurück; den Status fragst du über /v2/batch_jobs/:batch_id ab. |
Batch-Jobs
Status und Ergebnisse der asynchronen Batch-Jobs, die du über einen `…/batch_jobs`-Endpoint gesendet hast.
- batch_idstring
- statusstring
- resource_typestring
- language_idstring
- total_countstring
- success_countstring
- error_countstring
- submitted_atstring
- started_atstring
- completed_atstring
- status_urlstring
- error_codestring
- error_messagestring
- results_urlstring
- poll_after_atstring
- pageinteger · int32
- Abzurufende Seite. Standard
1. - per_pageinteger · int32
- Anzahl der Einträge pro Seite. Höchstens 250. Standard
10.
{
"batch_id": "123",
"status": "…",
"resource_type": "…",
"language_id": "123",
"total_count": "…",
"success_count": "…",
"error_count": "…",
"submitted_at": "…",
"started_at": "…",
"completed_at": "…",
"status_url": "…",
"error_code": "…",
"error_message": "…",
"results_url": "…",
"poll_after_at": "…"
}
curl https://app.reloadify.com/api/v2/batch_jobs/{batch_id}/results \
-H "Authorization: Bearer {access_token}"
| Methode | Pfad | Beschreibung |
|---|---|---|
| GET | /v2/batch_jobs/{batch_id} | Zeigt den Status eines Batch-Jobs |
| GET | /v2/batch_jobs/{batch_id}/results | Listet die Ergebnisse pro Eintrag für einen abgeschlossenen Batch-Job auf |