Reloadify API · v2

API-referentie

De Reloadify API is een REST API voor de marketingdata van je shop: profielen, producten, bestellingen, winkelwagens en meer. De API ontvangt en verstuurt JSON, gebruikt de standaard HTTP-methodes en statuscodes en authenticeert met OAuth2.

Bijna elke resource hoort bij een taal (een winkel of markt). Je vraagt eerst je talen op en gebruikt daarna een language_id in het pad van elke andere call.

Basis-URLhttps://app.reloadify.com/api

Overzicht van resources

# Per taal
/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
# Op accountniveau
/v2/custom_attributes
/v2/batch_jobs/{batch_id}

Authenticatie

De API gebruikt de OAuth2-client-credentials-flow. Wissel je client id en secret bij het token-endpoint in voor een access token en stuur dat als Bearer token mee met elke request.

Je maakt credentials aan in je Reloadify-account. Tokens zijn kort geldig: vraag een nieuwe aan zodra je token verloopt (HTTP 401).

POST/oauth/token

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

Geauthenticeerde request

curl https://app.reloadify.com/api/v2/languages \
  -H "Authorization: Bearer {access_token}"

Talen & scope

Een taal staat voor één winkel of markt. Alle catalogus- en doelgroepdata valt onder een taal, dus elk pad voor producten, profielen en bestellingen begint met /v2/languages/{language_id}/….

Roep GET /v2/languages aan om te zien welke ids je met je credentials kunt gebruiken.

GET/v2/languages

curl https://app.reloadify.com/api/v2/languages \
  -H "Authorization: Bearer {access_token}"

Paginering & filters

Lijst-endpoints werken met pagina's. Geef page (standaard 1) en per_page (standaard 10, maximaal 250) mee. De meeste lijsten accepteren ook tijdfilters, created_after, created_before, updated_after en updated_before (ISO 8601-datum en -tijd), zodat je alleen synchroniseert wat er veranderd is.

Sommige lijsten kun je filteren op id of e-mailadres, bijvoorbeeld met emails[]; bij elke resource staat welke parameters die ondersteunt.

GET…/profiles?updated_after=…

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

Async batch jobs

Voor schrijven in bulk heeft elke belangrijke resource een POST …/batch_jobs-endpoint. Dat accepteert een array met records en geeft direct een batch_id terug; de verwerking gebeurt asynchroon.

Vraag via GET /v2/batch_jobs/{batch_id} de status, success_count en error_count op. Is de job klaar, dan haal je de uitkomst per record op via GET /v2/batch_jobs/{batch_id}/results.

GET/v2/batch_jobs/{batch_id}

{
  "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": "…"
}

Foutmeldingen

De API gebruikt de gangbare HTTP-statuscodes. 2xx betekent dat het gelukt is, 4xx wijst op een probleem met de request (een ontbrekend veld, een ongeldig token of een resource die niet bestaat) en 5xx betekent dat er aan onze kant iets misging.

Status	Betekenis
200 / 201 / 202	Gelukt. Een batch geeft `202` terug met een `batch_id`.
401	Access token ontbreekt of is verlopen: vraag een nieuwe aan.
404	Resource (of taal) niet gevonden.
422	Validatie mislukt: de body noemt het veld dat niet klopt.
429	Rate limit bereikt. Wacht even en probeer het opnieuw.
5xx	Serverfout: je kunt het veilig opnieuw proberen, met oplopende wachttijd.

Foutresponse · 422

{
  "error": "validation_failed",
  "message": "email is invalid"
}

Talen

Elke resource hoort bij een taal (winkel/markt). Vraag eerst je talen op: hun ids gebruik je in elk ander pad.

Attributen

idstring
namestring
codestring
activestring

Queryparameters

pageinteger · int32: Op te halen pagina. Standaard 1.
per_pageinteger · int32: Aantal items per pagina. Maximaal 250. Standaard 10.

Het taalobject

{
  "id": "123",
  "name": "Example",
  "code": "en",
  "active": "…"
}

GET/v2/languages

curl https://app.reloadify.com/api/v2/languages \
  -H "Authorization: Bearer {access_token}"

Endpoints

Methode	Pad	Omschrijving
GET	`/v2/languages`	Geeft een lijst met talen terug
PUT	`/v2/languages`	Bijgewerkte taal
GET	`/v2/languages/{language_id}`	Geeft een taal terug op basis van ID
DELETE	`/v2/languages/{language_id}`

Profielen

De mensen in je doelgroep: contactgegevens, toestemmingsstatus, custom attributen en adres.

Attributen

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

Queryparameters

created_afterstring · date-time
created_beforestring · date-time
updated_afterstring · date-time
updated_beforestring · date-time
pageinteger · int32: Op te halen pagina. Standaard 1.
per_pageinteger · int32: Aantal items per pagina. Maximaal 250. Standaard 10.
emails[]array

Het profielobject

{
  "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": "…"
}

GET/v2/languages/{language_id}/profiles

curl https://app.reloadify.com/api/v2/languages/{language_id}/profiles \
  -H "Authorization: Bearer {access_token}"

Endpoints

Methode	Pad	Omschrijving
GET	`/v2/languages/{language_id}/profiles`	Geeft een lijst met profielen voor een taal terug.
PUT	`/v2/languages/{language_id}/profiles`	Maakt een profiel aan of werkt het bij op basis van e-mailadres, binnen een taal
POST	`/v2/languages/{language_id}/profiles/batch_jobs`	Verstuurt een async batch met profielen. Geeft 202 terug met een batch_id; vraag de status op via /v2/batch_jobs/:batch_id.
GET	`/v2/languages/{language_id}/profiles/{profile_id}`	Zoekt profielen op ID binnen een taal
DELETE	`/v2/languages/{language_id}/profiles/{profile_id}`
GET	`/v2/languages/{language_id}/profile_streams`	Geeft een stream met profielen van een taal terug, oplopend gesorteerd op id en gepagineerd met een keyset. Er wordt geen totaal berekend; haal de volgende pagina op met de X-Next-After-Id-header (of de Link rel="next"-header).

Producten

Je catalogus. Producten hebben varianten, categorieën, merken en links naar relevante producten.

Attributen

custom_attributesstring
idstring
namestring
visiblestring
main_imagestring
urlstring
pricenumber · double
short_descriptionstring
brand_idstring
category_idsstring
relevant_product_idsstring

Queryparameters

created_afterstring · date-time
created_beforestring · date-time
updated_afterstring · date-time
updated_beforestring · date-time
pageinteger · int32: Op te halen pagina. Standaard 1.
per_pageinteger · int32: Aantal items per pagina. Maximaal 250. Standaard 10.

Het productobject

{
  "custom_attributes": "…",
  "id": "123",
  "name": "Example",
  "visible": "…",
  "main_image": "…",
  "url": "…",
  "price": 0,
  "short_description": "…",
  "brand_id": "123",
  "category_ids": "…",
  "relevant_product_ids": "…"
}

GET/v2/languages/{language_id}/products

curl https://app.reloadify.com/api/v2/languages/{language_id}/products \
  -H "Authorization: Bearer {access_token}"

Endpoints

Methode	Pad	Omschrijving
GET	`/v2/languages/{language_id}/products`	Geeft een lijst met producten voor een taal terug
PUT	`/v2/languages/{language_id}/products`	Maakt een product aan of werkt het bij, binnen een taal
POST	`/v2/languages/{language_id}/products/batch_jobs`	Verstuurt een async batch met producten. Geeft 202 terug met een batch_id; vraag de status op via /v2/batch_jobs/:batch_id. Een merk waarnaar verwezen wordt, wordt automatisch aangemaakt als het nog niet bestaat, dus je kunt producten uploaden vóór hun merken. Elk product kan zijn varianten direct meesturen via variants[].
GET	`/v2/languages/{language_id}/products/{product_id}`	Zoekt een product op ID binnen een taal
DELETE	`/v2/languages/{language_id}/products/{product_id}`
GET	`/v2/languages/{language_id}/products/{product_id}/variants`	Geeft een lijst met varianten van een product terug
GET	`/v2/languages/{language_id}/products/{product_id}/categories`	Geeft een lijst met categorieën van een product terug
PUT	`/v2/languages/{language_id}/products/{product_id}/categories/{category_id}`	Voegt een product toe aan een categorie
DELETE	`/v2/languages/{language_id}/products/{product_id}/categories/{category_id}`
GET	`/v2/languages/{language_id}/products/{product_id}/relevant_products`	Geeft een lijst met relevante producten bij een product terug
PUT	`/v2/languages/{language_id}/products/{product_id}/relevant_products/{relevant_product_id}`	Voegt een relevant product toe aan een product
DELETE	`/v2/languages/{language_id}/products/{product_id}/relevant_products/{relevant_product_id}`

Varianten

Verkoopbare varianten van een product (maat, kleur) met een eigen SKU, prijs en voorraad.

Attributen

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

Queryparameters

created_afterstring · date-time
created_beforestring · date-time
updated_afterstring · date-time
updated_beforestring · date-time
pageinteger · int32: Op te halen pagina. Standaard 1.
per_pageinteger · int32: Aantal items per pagina. Maximaal 250. Standaard 10.

Het variantobject

{
  "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": "…"
}

GET/v2/languages/{language_id}/variants

curl https://app.reloadify.com/api/v2/languages/{language_id}/variants \
  -H "Authorization: Bearer {access_token}"

Endpoints

Methode	Pad	Omschrijving
GET	`/v2/languages/{language_id}/variants`	Geeft een lijst met varianten voor een taal terug
PUT	`/v2/languages/{language_id}/variants`	Maakt een variant aan of werkt die bij, binnen een taal
POST	`/v2/languages/{language_id}/variants/batch_jobs`	Verstuurt een async batch met varianten. Geeft 202 terug met een batch_id; vraag de status op via /v2/batch_jobs/:batch_id. Een product waarnaar verwezen wordt, wordt automatisch aangemaakt als het nog niet bestaat, dus je kunt varianten uploaden vóór hun producten.
GET	`/v2/languages/{language_id}/variants/{variant_id}`	Zoekt een variant op ID binnen een taal
DELETE	`/v2/languages/{language_id}/variants/{variant_id}`

Categorieën

De categorieboom van de catalogus; een product kan in meerdere categorieën zitten.

Attributen

custom_attributesstring
idstring
parent_category_idstring
product_idsstring
namestring
urlstring
created_atstring
updated_atstring

Queryparameters

created_afterstring · date-time
created_beforestring · date-time
updated_afterstring · date-time
updated_beforestring · date-time
pageinteger · int32: Op te halen pagina. Standaard 1.
per_pageinteger · int32: Aantal items per pagina. Maximaal 250. Standaard 10.

Het categorie-object

{
  "custom_attributes": "…",
  "id": "123",
  "parent_category_id": "123",
  "product_ids": "…",
  "name": "Example",
  "url": "…",
  "created_at": "…",
  "updated_at": "…"
}

GET/v2/languages/{language_id}/categories

curl https://app.reloadify.com/api/v2/languages/{language_id}/categories \
  -H "Authorization: Bearer {access_token}"

Endpoints

Methode	Pad	Omschrijving
GET	`/v2/languages/{language_id}/categories`	Geeft een lijst met categorieën voor een taal terug
PUT	`/v2/languages/{language_id}/categories`	Maakt een categorie aan of werkt die bij, binnen een taal
POST	`/v2/languages/{language_id}/categories/batch_jobs`	Verstuurt een async batch met categorieën. Geeft 202 terug met een batch_id; vraag de status op via /v2/batch_jobs/:batch_id. Een bovenliggende categorie waarnaar verwezen wordt, wordt automatisch aangemaakt als die nog niet bestaat, dus je kunt categorieën in elke volgorde uploaden.
GET	`/v2/languages/{language_id}/categories/{category_id}`	Zoekt een categorie op ID binnen een taal
DELETE	`/v2/languages/{language_id}/categories/{category_id}`
GET	`/v2/languages/{language_id}/categories/{category_id}/products`	Geeft een lijst met producten in een categorie terug

Merken

Merken die aan producten gekoppeld zijn; de producten van een merk vraag je op via de sub-resource.

Attributen

custom_attributesstring
idstring
product_idsstring
namestring
urlstring
contentstring
created_atstring
updated_atstring

Queryparameters

created_afterstring · date-time
created_beforestring · date-time
updated_afterstring · date-time
updated_beforestring · date-time
pageinteger · int32: Op te halen pagina. Standaard 1.
per_pageinteger · int32: Aantal items per pagina. Maximaal 250. Standaard 10.

Het merkobject

{
  "custom_attributes": "…",
  "id": "123",
  "product_ids": "…",
  "name": "Example",
  "url": "…",
  "content": "…",
  "created_at": "…",
  "updated_at": "…"
}

GET/v2/languages/{language_id}/brands

curl https://app.reloadify.com/api/v2/languages/{language_id}/brands \
  -H "Authorization: Bearer {access_token}"

Endpoints

Methode	Pad	Omschrijving
GET	`/v2/languages/{language_id}/brands`	Geeft een lijst met merken voor een taal terug
PUT	`/v2/languages/{language_id}/brands`	Maakt een merk aan of werkt het bij, binnen een taal
POST	`/v2/languages/{language_id}/brands/batch_jobs`	Verstuurt een async batch met merken. Geeft 202 terug met een batch_id; vraag de status op via /v2/batch_jobs/:batch_id.
GET	`/v2/languages/{language_id}/brands/{brand_id}`	Zoekt een merk op ID binnen een taal
DELETE	`/v2/languages/{language_id}/brands/{brand_id}`
GET	`/v2/languages/{language_id}/brands/{brand_id}/products`	Geeft een lijst met producten van een merk terug

Bestellingen

Afgeronde bestellingen en hun orderregels, gebruikt voor segmentatie en omzet.

Attributen

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

Queryparameters

created_afterstring · date-time
created_beforestring · date-time
updated_afterstring · date-time
updated_beforestring · date-time
pageinteger · int32: Op te halen pagina. Standaard 1.
per_pageinteger · int32: Aantal items per pagina. Maximaal 250. Standaard 10.

Het bestellingsobject

{
  "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": "…"
}

GET/v2/languages/{language_id}/orders

curl https://app.reloadify.com/api/v2/languages/{language_id}/orders \
  -H "Authorization: Bearer {access_token}"

Endpoints

Methode	Pad	Omschrijving
GET	`/v2/languages/{language_id}/orders`	Geeft een lijst met bestellingen voor een taal terug
PUT	`/v2/languages/{language_id}/orders`	Maakt een bestelling aan of werkt die bij, binnen een taal
POST	`/v2/languages/{language_id}/orders/batch_jobs`	Verstuurt een async batch met bestellingen. Geeft 202 terug met een batch_id; vraag de status op via /v2/batch_jobs/:batch_id. Een profiel waarnaar verwezen wordt, wordt automatisch als stub aangemaakt als het nog niet bestaat (alleen platform_id, geen e-mailadres); werk het profiel daarna apart bij via /v2/profiles om de attributen te vullen. Elke bestelling kan haar orderregels direct meesturen via order_products[].
GET	`/v2/languages/{language_id}/orders/{order_id}`	Zoekt een bestelling op ID binnen een taal
DELETE	`/v2/languages/{language_id}/orders/{order_id}`
GET	`/v2/languages/{language_id}/orders/{order_id}/products`	Geeft alle producten van een bestelling terug
PUT	`/v2/languages/{language_id}/orders/{order_id}/products/{product_id}`	Voegt een product toe aan een bestelling
DELETE	`/v2/languages/{language_id}/orders/{order_id}/products/{product_id}`	Verwijdert een product uit een bestelling

Bestelde producten

Koppeling van producten aan bestellingen, alleen in bulk (async batch).

Attributen

custom_attributesstring
order_idstring
product_idstring
variant_idstring
quantitystring
quantity_refundedstring
total_refundednumber · double

Het orderregelobject

{
  "custom_attributes": "…",
  "order_id": "123",
  "product_id": "123",
  "variant_id": "123",
  "quantity": "…",
  "quantity_refunded": "…",
  "total_refunded": 0
}

Endpoints

Methode	Pad	Omschrijving
POST	`/v2/languages/{language_id}/order_products/batch_jobs`	Verstuurt een async batch met order_products. Geeft 202 terug met een batch_id; vraag de status op via /v2/batch_jobs/:batch_id. Bestellingen, producten en varianten waarnaar verwezen wordt, worden automatisch als stub aangemaakt als ze nog niet bestaan, dus je kunt order_products uploaden vóór die resources. Een stub-bestelling heeft nog geen profiel en wordt aangevuld zodra de volledige bestelling via het orders-endpoint binnenkomt (beide routes komen samen op hetzelfde order-id).

Winkelwagens

Actieve en verlaten winkelwagens met hun producten: de trigger voor winkelwagenflows.

Attributen

custom_attributesstring
idstring
profile_idstring
product_idsstring
currencystring
pricestring
recovery_urlstring
recovery_tokenstring
deletedstring
created_atstring
updated_atstring

Queryparameters

created_afterstring · date-time
created_beforestring · date-time
updated_afterstring · date-time
updated_beforestring · date-time
pageinteger · int32: Op te halen pagina. Standaard 1.
per_pageinteger · int32: Aantal items per pagina. Maximaal 250. Standaard 10.

Het winkelwagenobject

{
  "custom_attributes": "…",
  "id": "123",
  "profile_id": "123",
  "product_ids": "…",
  "currency": "…",
  "price": "…",
  "recovery_url": "…",
  "recovery_token": "…",
  "deleted": "…",
  "created_at": "…",
  "updated_at": "…"
}

GET/v2/languages/{language_id}/shopping_carts

curl https://app.reloadify.com/api/v2/languages/{language_id}/shopping_carts \
  -H "Authorization: Bearer {access_token}"

Endpoints

Methode	Pad	Omschrijving
GET	`/v2/languages/{language_id}/shopping_carts`	Geeft een lijst met winkelwagens voor een taal terug
PUT	`/v2/languages/{language_id}/shopping_carts`	Maakt een winkelwagen aan of werkt die bij, binnen een taal
POST	`/v2/languages/{language_id}/shopping_carts/batch_jobs`	Verstuurt een async batch met winkelwagens. Geeft 202 terug met een batch_id; vraag de status op via /v2/batch_jobs/:batch_id. Een profiel waarnaar verwezen wordt, wordt automatisch als stub aangemaakt als het nog niet bestaat (alleen platform_id, geen e-mailadres); werk het profiel daarna apart bij via /v2/profiles om de attributen te vullen. Elke winkelwagen kan zijn producten direct meesturen via products[].
GET	`/v2/languages/{language_id}/shopping_carts/{shopping_cart_id}`	Zoekt een winkelwagen op ID binnen een taal
DELETE	`/v2/languages/{language_id}/shopping_carts/{shopping_cart_id}`
GET	`/v2/languages/{language_id}/shopping_carts/{shopping_cart_id}/products`	Geeft alle producten in een winkelwagen terug
PUT	`/v2/languages/{language_id}/shopping_carts/{shopping_cart_id}/products/{product_id}`	Voegt een product toe aan een winkelwagen
DELETE	`/v2/languages/{language_id}/shopping_carts/{shopping_cart_id}/products/{product_id}`

Reviews

Productreviews van klanten.

Attributen

custom_attributesstring
idstring
product_idstring
profile_idstring
descriptionstring
namestring
visiblestring
scorestring
created_atstring
updated_atstring

Queryparameters

created_afterstring · date-time
created_beforestring · date-time
updated_afterstring · date-time
updated_beforestring · date-time
pageinteger · int32: Op te halen pagina. Standaard 1.
per_pageinteger · int32: Aantal items per pagina. Maximaal 250. Standaard 10.

Het reviewobject

{
  "custom_attributes": "…",
  "id": "123",
  "product_id": "123",
  "profile_id": "123",
  "description": "…",
  "name": "Example",
  "visible": "…",
  "score": "…",
  "created_at": "…",
  "updated_at": "…"
}

GET/v2/languages/{language_id}/reviews

curl https://app.reloadify.com/api/v2/languages/{language_id}/reviews \
  -H "Authorization: Bearer {access_token}"

Endpoints

Methode	Pad	Omschrijving
GET	`/v2/languages/{language_id}/reviews`	Geeft een lijst met reviews voor een taal terug
PUT	`/v2/languages/{language_id}/reviews`	Maakt een review aan of werkt die bij, binnen een taal
POST	`/v2/languages/{language_id}/reviews/batch_jobs`	Verstuurt een async batch met reviews. Geeft 202 terug met een batch_id; vraag de status op via /v2/batch_jobs/:batch_id. Producten en profielen waarnaar verwezen wordt, worden automatisch als stub aangemaakt als ze nog niet bestaan (alleen platform_id); werk ze daarna apart bij om de attributen te vullen.
GET	`/v2/languages/{language_id}/reviews/{review_id}`	Zoekt een review op ID binnen een taal
DELETE	`/v2/languages/{language_id}/reviews/{review_id}`

Aankoopevents

Aankoopsignalen die flows en aanbevelingen aansturen (alleen schrijven / batch).

Endpoints

Methode	Pad	Omschrijving
PUT	`/v2/languages/{language_id}/purchase_events`	Maakt een server-side aankoopevent aan
POST	`/v2/languages/{language_id}/purchase_events/batch_jobs`	Verstuurt een async batch met aankoopevents. Geeft 202 terug met een batch_id; vraag de status op via /v2/batch_jobs/:batch_id. Het profiel en de bezoeker waarnaar verwezen wordt, moeten al bestaan: items met een onbekend profile_id of visitor_token komen als fout terug in de resultaten.

Globale uitschrijvingen

E-mailadressen die zich binnen een taal voor elke lijst hebben uitgeschreven.

Attributen

profile_emailstring
profile_idstring
created_atstring
updated_atstring

Queryparameters

created_afterstring · date-time
created_beforestring · date-time
updated_afterstring · date-time
updated_beforestring · date-time
pageinteger · int32: Op te halen pagina. Standaard 1.
per_pageinteger · int32: Aantal items per pagina. Maximaal 250. Standaard 10.

Het uitschrijvingsobject

{
  "profile_email": "…",
  "profile_id": "123",
  "created_at": "…",
  "updated_at": "…"
}

GET/v2/languages/{language_id}/global_unsubscribes

curl https://app.reloadify.com/api/v2/languages/{language_id}/global_unsubscribes \
  -H "Authorization: Bearer {access_token}"

Endpoints

Methode	Pad	Omschrijving
GET	`/v2/languages/{language_id}/global_unsubscribes`	Geeft een lijst met globale uitschrijvingen terug
PUT	`/v2/languages/{language_id}/global_unsubscribes`	Maakt een globale uitschrijving aan

Custom attributen

Definities van de custom profielattributen in je account (niet per taal).

Attributen

namestring
handlestring
descriptionstring
datatypestring
resourcestring

Queryparameters

pageinteger · int32: Op te halen pagina. Standaard 1.
per_pageinteger · int32: Aantal items per pagina. Maximaal 250. Standaard 10.

Het object voor custom attributen

{
  "name": "Example",
  "handle": "…",
  "description": "…",
  "datatype": "…",
  "resource": "…"
}

GET/v2/custom_attributes

curl https://app.reloadify.com/api/v2/custom_attributes \
  -H "Authorization: Bearer {access_token}"

Endpoints

Methode	Pad	Omschrijving
GET	`/v2/custom_attributes`	Geeft een lijst met custom attributen terug
PUT	`/v2/custom_attributes`	Bijgewerkt custom attribuut
POST	`/v2/custom_attributes/batch_jobs`	Verstuurt een async batch met custom attributen. Geeft 202 terug met een batch_id; vraag de status op via /v2/batch_jobs/:batch_id.

Batch jobs

Status en resultaten van de async batch jobs die je via een `…/batch_jobs`-endpoint hebt verstuurd.

Attributen

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

Queryparameters

pageinteger · int32: Op te halen pagina. Standaard 1.
per_pageinteger · int32: Aantal items per pagina. Maximaal 250. Standaard 10.

Het batch-job-object

{
  "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": "…"
}

GET/v2/batch_jobs/{batch_id}/results

curl https://app.reloadify.com/api/v2/batch_jobs/{batch_id}/results \
  -H "Authorization: Bearer {access_token}"

Endpoints

Methode	Pad	Omschrijving
GET	`/v2/batch_jobs/{batch_id}`	Toont de status van een batch job
GET	`/v2/batch_jobs/{batch_id}/results`	Geeft per item de resultaten van een afgeronde batch job terug