Courier (onafhankelijke uitgever) (preview)
Courier is een service en web studio voor ontwikkelteams voor het beheren van alle door producten geactiveerde communicatie (e-mail, chat, in-app, sms, push, enzovoort) op één plek. Courier is gebouwd voor ontwikkelaars die een uitzonderlijke meldingservaring willen leveren.
Deze connector is beschikbaar in de volgende producten en regio's:
| Dienst | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Logic-apps | Standaard | Alle Logic Apps-regio's , met uitzondering van het volgende: - Azure Government-regio's - Azure China-regio's - Us Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Contactpersoon | |
|---|---|
| Naam | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| E-mailen | ttaylor@hitachisolutions.com |
| Connectormetagegevens | |
|---|---|
| Uitgever | Troy Taylor |
| Webpagina | https://www.courier.com/ |
| Privacybeleid | https://www.courier.com/privacy/ |
| Categorieën | Communicatie; Sociale media |
Een verbinding maken
De connector ondersteunt de volgende verificatietypen:
| standaard | Parameters voor het maken van verbinding. | Alle regio's | Niet deelbaar |
Verstek
Van toepassing: Alle regio's
Parameters voor het maken van verbinding.
Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.
| Naam | Typologie | Description | Verplicht |
|---|---|---|---|
| Token (in de vorm 'Bearer yourToken') | beveiligde string | Het token (in de vorm Bearer yourToken) voor deze API | Klopt |
Beperkingslimieten
| Name | Aanroepen | Verlengingsperiode |
|---|---|---|
| API-aanroepen per verbinding | 100 | 60 seconden |
Acties
| Abonnee(s) toevoegen aan een lijst |
Voeg extra abonnees toe aan een lijst. |
| Abonnementen van de lijst ophalen |
Hiermee worden de abonnementen voor een lijst opgehaald. |
| Ad-hocautomatisering uitvoeren |
Roep een automatisering aan in een ad-hocuitvoering. |
| Alle adressenlijsten ophalen |
Een lijst met alle adressenlijsten ophalen. |
| Alle controlegebeurtenissen ophalen |
Haal een lijst met controlegebeurtenissen op. |
| Alle doelgroepen weergeven |
Haal alle doelgroepen op die aan uw account zijn gekoppeld. |
| Berichten weergeven |
Haal de statussen van eerder verzonden berichten op. |
| De geschiedenis van een bericht ophalen |
Haal de gebeurtenissen van een eerder verzonden bericht op. |
| Een bericht archiveren |
Vraag of een bericht moet worden gearchiveerd. |
| Een bericht ophalen |
Haal de status van een bericht op. |
| Een bericht verzenden |
Hiermee wordt een bericht verzonden naar een of meer geadresseerden. |
| Een bulktaak maken |
Hiermee maakt u een bulktaak voor de opgegeven berichtparameters. |
| Een bulktaak ophalen |
Haal de informatie over een bulktaak op. |
| Een bulktaak uitvoeren |
Start met het uitvoeren van een bulktaak. |
| Een controlegebeurtenis ophalen |
Haal een specifieke controlegebeurtenis op id op. |
| Een doelgroep maken of bijwerken |
Hiermee maakt of werkt u een doelgroep bij op basis van de opgegeven parameters en filters. |
| Een doelgroep ophalen |
Retourneert de opgegeven doelgroep op id. |
| Een doelgroep verwijderen |
Hiermee verwijdert u de opgegeven doelgroep voor geadresseerden. |
| Een gebruiker afmelden voor een lijst |
Hiermee verwijdert u een abonnement op een lijst op lijst en geadresseerde-id's. |
| Een lijst bijwerken |
Hiermee maakt of vervangt u een bestaande lijst door de opgegeven waarden. |
| Een lijst herstellen |
Hiermee herstelt u een bestaande lijst op id. |
| Een lijst ophalen |
Haal de items van een lijst op. |
| Een lijst verwijderen |
Hiermee verwijdert u een lijst op lijst-id. |
| Een merk maken |
Hiermee maakt u een nieuw merk op basis van de opgegeven instellingen. |
| Een merk ophalen |
Haal een specifiek merk op id op. |
| Een profiel bijwerken |
Updates voor een gedeelte van een profiel. |
| Een profiel maken |
Voeg de opgegeven waarden samen met een bestaand profiel of maak een nieuw profiel als deze nog niet bestaat. |
| Een profiel ophalen |
Hiermee haalt u het opgegeven geadresseerdeprofiel op. |
| Een profiel verwijderen |
Hiermee verwijdert u het opgegeven geadresseerdeprofiel. |
| Een sjabloonautomatisering uitvoeren |
Een automatiseringsuitvoering aanroepen vanuit een automatiseringssjabloon. |
| Gebruikers toevoegen aan een bulktaak |
Gebruikersgegevens opnemen in een bulktaak. |
| Gebruikers van een bulktaak ophalen |
Haal de gebruikers van een bulktaak op. |
| Inhoud van een bericht ophalen |
Haal de inhoud van een eerder verzonden bericht op. |
| Leden van doelgroep vermelden |
Een lijst met leden van een doelgroep ophalen. |
| Meldingen weergeven |
Hiermee haalt u een lijst met meldingen op. |
| Merken vermelden |
Haal een lijst met merken op. |
Abonnee(s) toevoegen aan een lijst
Voeg extra abonnees toe aan een lijst.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Lijst-id
|
list_id | True | string |
De lijst-id. |
|
Geadresseerde-id
|
recipientId | string |
De ontvanger-id. |
Retouren
- response
- string
Abonnementen van de lijst ophalen
Hiermee worden de abonnementen voor een lijst opgehaald.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Lijst-id
|
list_id | True | string |
De lijst-id. |
|
Cursor
|
cursor | string |
De cursor. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
De cursor. |
|
Meer
|
paging.more | boolean |
Of er meer is. |
|
Artikelen
|
items | array of object | |
|
Geadresseerde-id
|
items.recipientId | string |
De ontvanger-id. |
|
Gecreëerd
|
items.created | string |
Wanneer deze is gemaakt. |
Ad-hocautomatisering uitvoeren
Roep een automatisering aan in een ad-hocuitvoering.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Token voor annuleren
|
cancelation_token | string |
Het annuleringstoken. |
|
|
Merk
|
brand | string |
Het merk. |
|
|
Template
|
template | string |
De sjabloon. |
|
|
Recipient
|
recipient | string |
De ontvanger. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Uitvoerings-id
|
runId | string |
De run-id. |
Alle adressenlijsten ophalen
Een lijst met alle adressenlijsten ophalen.
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
De cursor. |
|
Meer
|
paging.more | boolean |
Of er meer is. |
|
Results
|
results | array of object | |
|
Gecreëerd
|
results.created | string |
Wanneer deze is gemaakt. |
|
ID-kaart
|
results.id | string |
De id. |
|
Naam
|
results.name | string |
De naam. |
|
Updated
|
results.updated | string |
Wanneer dit is bijgewerkt. |
Alle controlegebeurtenissen ophalen
Haal een lijst met controlegebeurtenissen op.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
De cursor. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
De cursor. |
|
Meer
|
paging.more | boolean |
Of er meer is. |
|
Results
|
results | array of object | |
|
Gebeurtenis-id controleren
|
results.auditEventId | string |
De controlegebeurtenis-id. |
|
ID-kaart
|
results.actor.id | string |
De id. |
|
E-mailen
|
results.actor.email | string |
Het e-mailadres. |
|
ID-kaart
|
results.target.id | string |
De id. |
|
E-mailen
|
results.target.email | string |
Het e-mailadres. |
|
Bron
|
results.source | string |
De bron. |
|
Tijdstempel
|
results.timestamp | string |
De tijdstempel. |
|
Typologie
|
results.type | string |
Het type. |
Alle doelgroepen weergeven
Haal alle doelgroepen op die aan uw account zijn gekoppeld.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
De cursor. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Artikelen
|
items | array of object | |
|
ID-kaart
|
items.id | string |
De id. |
|
Naam
|
items.name | string |
De naam. |
|
Description
|
items.description | string |
De beschrijving. |
|
Operator
|
items.filter.operator | string |
De operator. |
|
Waarde
|
items.filter.value | string |
De waarde. |
|
Path
|
items.filter.path | string |
Het pad. |
|
Cursor
|
paging.cursor | string |
De cursor. |
|
Meer
|
paging.more | boolean |
Of er meer is. |
Berichten weergeven
Haal de statussen van eerder verzonden berichten op.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Gearchiveerde
|
archived | boolean |
Of het nu gearchiveerd is. |
|
|
Cursor
|
cursor | string |
De cursor. |
|
|
Event
|
event | string |
De gebeurtenis. |
|
|
List
|
list | string |
De lijst. |
|
|
Bericht-id
|
messageId | string |
De bericht-id. |
|
|
Notification
|
notification | string |
De melding. |
|
|
Recipient
|
recipient | string |
De ontvanger. |
|
|
Toestand
|
status | string |
De status. |
|
|
Tags
|
tags | string |
De tags. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
De cursor. |
|
Meer
|
paging.more | boolean |
Of er meer is. |
|
Results
|
results | array of object | |
|
ID-kaart
|
results.id | string |
De id. |
|
Toestand
|
results.status | string |
De status. |
|
Enqueued
|
results.enqueued | integer |
De enqueued. |
|
Gezonden
|
results.sent | integer |
De verzonden. |
|
Afgeleverd
|
results.delivered | integer |
De geleverde. |
|
Geopend
|
results.opened | integer |
De geopende. |
|
Geklikt
|
results.clicked | integer |
De muisklik. |
|
Recipient
|
results.recipient | string |
De ontvanger. |
|
Event
|
results.event | string |
De gebeurtenis. |
|
Notification
|
results.notification | string |
De melding. |
|
Fout
|
results.error | string |
De fout. |
|
Reden
|
results.reason | string |
De reden. |
De geschiedenis van een bericht ophalen
Haal de gebeurtenissen van een eerder verzonden bericht op.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bericht-id
|
message_id | True | string |
De bericht-id. |
|
Typologie
|
type | string |
Het type. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Naam
|
results.data.name | string |
De naam. |
|
Event
|
results.event | string |
De gebeurtenis. |
|
Recipient
|
results.recipient | string |
De ontvanger. |
|
TS
|
results.ts | integer |
De TS. |
|
Typologie
|
results.type | string |
Het type. |
|
Gebeurtenis-id
|
results.event_id | string |
De gebeurtenis-id. |
|
Meldings-id
|
results.notification_id | string |
De meldings-id. |
|
ID-kaart
|
results.channel.id | string |
De id. |
|
ID-kaart
|
results.integration.id | string |
De id. |
|
Provider
|
results.integration.provider | string |
De provider. |
Een bericht archiveren
Vraag of een bericht moet worden gearchiveerd.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Aanvraag-id
|
request_id | True | string |
De aanvraag-id. |
Retouren
- response
- string
Een bericht ophalen
Haal de status van een bericht op.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bericht-id
|
message_id | True | string |
De bericht-id. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
ID-kaart
|
id | string |
De id. |
|
Toestand
|
status | string |
De status. |
|
Enqueued
|
enqueued | integer |
De enqueued. |
|
Gezonden
|
sent | integer |
De verzonden. |
|
Afgeleverd
|
delivered | integer |
De geleverde. |
|
Geopend
|
opened | integer |
De geopende. |
|
Geklikt
|
clicked | integer |
De muisklik. |
|
Recipient
|
recipient | string |
De ontvanger. |
|
Event
|
event | string |
De gebeurtenis. |
|
Notification
|
notification | string |
De melding. |
|
Fout
|
error | string |
De fout. |
|
Reden
|
reason | string |
De reden. |
|
Providers
|
providers | array of object | |
|
Gezonden
|
providers.sent | integer |
De verzonden. |
|
Afgeleverd
|
providers.delivered | integer |
De geleverde. |
|
Geklikt
|
providers.clicked | integer |
De muisklik. |
|
Geopend
|
providers.opened | integer |
De geopende. |
|
Fout
|
providers.error | string |
De fout. |
|
Provider
|
providers.provider | string |
De provider. |
|
Toestand
|
providers.status | string |
De status. |
Een bericht verzenden
Hiermee wordt een bericht verzonden naar een of meer geadresseerden.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Idempotentie
|
idempotency | True | string |
De idempotentiesleutel. |
|
Title
|
title | string |
De titel. |
|
|
Body
|
body | string |
Het lichaam. |
|
|
Gebruikers-ID
|
user_id | string |
De gebruikers-id. |
|
|
Lijst-id
|
list_id | string |
De lijst-id. |
|
|
Doelgroep-id
|
audience_id | string |
De doelgroep-id. |
|
|
E-mailen
|
string |
Het e-mailadres. |
||
|
Telefoonnummer
|
phone_number | string |
Het telefoonnummer. |
|
|
Lokatie
|
locale | string |
De landinstelling. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Aanvraag-id
|
requestId | string |
De aanvraag-id. |
Een bulktaak maken
Hiermee maakt u een bulktaak voor de opgegeven berichtparameters.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Event
|
event | string |
De gebeurtenis. |
|
|
Merk
|
brand | string |
Het merk. |
|
|
Template
|
template | string |
De sjabloon. |
|
|
Merk-id
|
brand_id | string |
De merk-id. |
|
|
Methode
|
method | string |
De methode. |
|
|
Kanalen
|
channels | array of string |
De kanalen. |
|
|
Event
|
event | string |
De gebeurtenis. |
|
|
Tags
|
tags | array of string |
De tags. |
|
|
Tracerings-id
|
trace_id | string |
De tracerings-id. |
|
|
Campagne
|
campaign | string |
De campagne. |
|
|
Content
|
content | string |
De inhoud. |
|
|
Gemiddeld
|
medium | string |
Het medium. |
|
|
Bron
|
source | string |
De bron. |
|
|
Termijn
|
term | string |
De term. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Functie-ID
|
jobId | string |
De taak-ID. |
Een bulktaak ophalen
Haal de informatie over een bulktaak op.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Functie-ID
|
job_id | True | string |
De taak-ID. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Event
|
job.definition.event | string |
De gebeurtenis. |
|
Enqueued
|
job.enqueued | integer |
De enqueued. |
|
Mislukkingen
|
job.failures | integer |
De fouten. |
|
Ontvangen
|
job.received | integer |
Wanneer ontvangen. |
|
Toestand
|
job.status | string |
De status. |
Een bulktaak uitvoeren
Start met het uitvoeren van een bulktaak.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Functie-ID
|
job_id | True | string |
De taak-ID. |
Retouren
- response
- object
Een controlegebeurtenis ophalen
Haal een specifieke controlegebeurtenis op id op.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Gebeurtenis-id controleren
|
audit-event-id | True | string |
De controlegebeurtenis-id. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Gebeurtenis-id controleren
|
auditEventId | string |
De controlegebeurtenis-id. |
|
ID-kaart
|
actor.id | string |
De id. |
|
E-mailen
|
actor.email | string |
Het e-mailadres. |
|
ID-kaart
|
target.id | string |
De id. |
|
E-mailen
|
target.email | string |
Het e-mailadres. |
|
Bron
|
source | string |
De bron. |
|
Tijdstempel
|
timestamp | string |
De tijdstempel. |
|
Typologie
|
type | string |
Het type. |
Een doelgroep maken of bijwerken
Hiermee maakt of werkt u een doelgroep bij op basis van de opgegeven parameters en filters.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Doelgroep-id
|
audience_id | True | string |
De doelgroep-id. |
|
Naam
|
name | string |
De naam. |
|
|
Path
|
path | string |
Het pad. |
|
|
Operator
|
operator | string |
De operator. |
|
|
Waarde
|
value | string |
De waarde. |
|
|
Path
|
path | string |
Het pad. |
|
|
Operator
|
operator | string |
De operator. |
|
|
Waarde
|
value | string |
De waarde. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
ID-kaart
|
id | string |
De id. |
|
Naam
|
name | string |
De naam. |
|
Description
|
description | string |
De beschrijving. |
|
Operator
|
filter.operator | string |
De operator. |
|
Waarde
|
filter.value | string |
De waarde. |
|
Path
|
filter.path | string |
Het pad. |
|
Filteren
|
filter.filters | array of object | |
|
Path
|
filter.filters.path | string |
Het pad. |
|
Operator
|
filter.filters.operator | string |
De operator. |
|
Waarde
|
filter.filters.value | string |
De waarde. |
Een doelgroep ophalen
Retourneert de opgegeven doelgroep op id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Doelgroep-id
|
audience_id | True | string |
De doelgroep-id. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
ID-kaart
|
id | string |
De id. |
|
Naam
|
name | string |
De naam. |
|
Description
|
description | string |
De beschrijving. |
|
Operator
|
filter.operator | string |
De operator. |
|
Waarde
|
filter.value | string |
De waarde. |
|
Path
|
filter.path | string |
Het pad. |
Een doelgroep verwijderen
Hiermee verwijdert u de opgegeven doelgroep voor geadresseerden.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Doelgroep-id
|
audience_id | True | string |
De doelgroep-id. |
Retouren
- response
- string
Een gebruiker afmelden voor een lijst
Hiermee verwijdert u een abonnement op een lijst op lijst en geadresseerde-id's.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Lijst-id
|
list_id | True | string |
De lijst-id. |
|
Geadresseerde-id
|
recipient_id | True | string |
De ontvanger-id. |
Retouren
- response
- string
Een lijst bijwerken
Hiermee maakt of vervangt u een bestaande lijst door de opgegeven waarden.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Lijst-id
|
list_id | True | string |
De lijst-id. |
|
Naam
|
name | string |
De naam. |
Retouren
- response
- string
Een lijst herstellen
Hiermee herstelt u een bestaande lijst op id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Lijst-id
|
list_id | True | string |
De lijst-id. |
Retouren
- response
- string
Een lijst ophalen
Haal de items van een lijst op.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Lijst-id
|
list_id | True | string |
De lijst-id. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Gecreëerd
|
created | string |
Wanneer deze is gemaakt. |
|
ID-kaart
|
id | string |
De id. |
|
Naam
|
name | string |
De naam. |
|
Updated
|
updated | string |
De bijgewerkte versie. |
Een lijst verwijderen
Hiermee verwijdert u een lijst op lijst-id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Lijst-id
|
list_id | True | string |
De lijst-id. |
Retouren
- response
- string
Een merk maken
Hiermee maakt u een nieuw merk op basis van de opgegeven instellingen.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ID-kaart
|
id | string |
De id. |
|
|
Naam
|
name | True | string |
De naam. |
|
Primary
|
primary | string |
De primaire. |
|
|
Secundair
|
secondary | string |
De secundaire. |
|
|
Tertiair
|
tertiary | string |
De tertiaire. |
|
|
Balkkleur
|
barColor | string |
De kleur van de balk. |
|
|
HREF
|
href | string |
De HREF. |
|
|
Afbeelding
|
image | string |
De afbeelding. |
|
|
Markdown
|
markdown | string |
De markdown. |
|
|
URL
|
url | string |
Het URL-adres. |
|
|
URL
|
url | string |
Het URL-adres. |
|
|
URL
|
url | string |
Het URL-adres. |
|
|
URL
|
url | string |
Het URL-adres. |
|
|
URL
|
url | string |
Het URL-adres. |
|
|
Pictogram Bericht uitschakelen
|
disableMessageIcon | boolean |
Of u het berichtpictogram wilt uitschakelen. |
|
|
Plaatsing
|
placement | string |
De plaatsing. |
|
|
Artikelen
|
items | array of string |
De items. |
Retouren
- response
- string
Een merk ophalen
Haal een specifiek merk op id op.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Merk-id
|
brand_id | True | string |
De merk-id. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Gecreëerd
|
created | integer |
Wanneer deze is gemaakt. |
|
ID-kaart
|
id | string |
De id. |
|
Naam
|
name | string |
De naam. |
|
Gepubliceerd
|
published | integer |
Wanneer deze wordt gepubliceerd. |
|
Updated
|
updated | integer |
De bijgewerkte versie. |
|
Versie
|
version | string |
De versie. |
|
Primary
|
settings.colors.primary | string |
De primaire. |
|
Secundair
|
settings.colors.secondary | string |
De secundaire. |
|
Tertiair
|
settings.colors.tertiary | string |
De tertiaire. |
|
Balkkleur
|
settings.email.header.barColor | string |
De kleur van de balk. |
|
HREF
|
settings.email.header.logo.href | string |
De HREF. |
|
Afbeelding
|
settings.email.header.logo.image | string |
De afbeelding. |
|
Markdown
|
settings.email.footer.markdown | string |
De markdown. |
|
URL
|
settings.email.footer.social.facebook.url | string |
Het URL-adres. |
|
URL
|
settings.email.footer.social.instagram.url | string |
Het URL-adres. |
|
URL
|
settings.email.footer.social.linkedin.url | string |
Het URL-adres. |
|
URL
|
settings.email.footer.social.medium.url | string |
Het URL-adres. |
|
URL
|
settings.email.footer.social.twitter.url | string |
Het URL-adres. |
|
Pictogram Bericht uitschakelen
|
settings.inapp.disableMessageIcon | boolean |
Of u het berichtpictogram wilt uitschakelen. |
|
Plaatsing
|
settings.inapp.placement | string |
De plaatsing. |
|
Artikelen
|
snippets.items | array of string |
De items. |
Een profiel bijwerken
Updates voor een gedeelte van een profiel.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Geadresseerde-id
|
recipient_id | True | string |
De ontvanger-id. |
|
Operation
|
op | string |
De bewerking. |
|
|
Path
|
path | string |
Het pad. |
|
|
Waarde
|
value | string |
De waarde. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Toestand
|
status | string |
De status. |
Een profiel maken
Voeg de opgegeven waarden samen met een bestaand profiel of maak een nieuw profiel als deze nog niet bestaat.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Geadresseerde-id
|
recipient_id | True | string |
De ontvanger-id. |
|
E-mailen
|
string |
Het e-mailadres. |
||
|
Telefoonnummer
|
phone_number | string |
Het telefoonnummer. |
|
|
Geformatteerd
|
formatted | string |
Het opgemaakte adres. |
|
|
Straatadres
|
street_address | string |
Het adres. |
|
|
Localiteit
|
locality | string |
De plaats. |
|
|
Regio
|
region | string |
De regio. |
|
|
Postcode
|
postal_code | string |
De postcode. |
|
|
Country
|
country | string |
Het land. |
|
|
Geboortedatum
|
birthdate | string |
De geboortedatum. |
|
|
E-mail geverifieerd
|
email_verified | boolean |
Of e-mail is geverifieerd. |
|
|
Telefoonnummer geverifieerd
|
phone_number_verified | boolean |
Of het telefoonnummer is geverifieerd. |
|
|
Voornaam
|
given_name | string |
De opgegeven naam. |
|
|
Tweede naam
|
middle_name | string |
De middelste naam. |
|
|
Achternaam
|
family_name | string |
De familienaam. |
|
|
Voorkeursnaam
|
preferred_name | string |
De voorkeursnaam. |
|
|
Geslacht
|
gender | string |
Het geslacht. |
|
|
Lokatie
|
locale | string |
De landinstelling. |
|
|
Afbeelding
|
picture | string |
De foto. |
|
|
Profile
|
profile | string |
Het profiel. |
|
|
Subwoofer
|
sub | string |
De sub. |
|
|
Bijgewerkt op
|
updated_at | string |
Wanneer bijgewerkt op. |
|
|
Webpagina
|
website | string |
De website. |
|
|
Zonegegevens
|
zoneinfo | string |
De zone-informatie. |
|
|
Benoemde gebruiker
|
named_user | string |
De benoemde gebruiker. |
|
|
Apparaattypen
|
device_types | array of string |
De apparaattypen. |
|
|
APN
|
apn | string |
De APN. |
|
|
Doel-ARN
|
target_arn | string |
De doel-ARN. |
|
|
Kanaal-id
|
channel_id | string |
De kanaal-id. |
|
|
Gebruikers-ID
|
user_id | string |
De gebruikers-id. |
|
|
Teken
|
token | string |
Het token. |
|
|
Tokens
|
tokens | array of string |
De tokens. |
|
|
Facebook PS ID
|
facebookPSID | string |
De Facebook PS-id. |
|
|
Firebase-token
|
firebaseToken | string |
Het Firebase-token. |
|
|
Van
|
from | string |
De Van. |
|
|
ID-kaart
|
id | string |
De id. |
|
|
Gebruikers-ID
|
user_id | string |
De gebruikers-id. |
|
|
Gespreks-id
|
conversation_id | string |
De gespreks-id. |
|
|
Huurder-ID
|
tenant_id | string |
De tenant-id. |
|
|
Service-URL
|
service_url | string |
Het URL-adres van de service. |
|
|
OneSignal Player ID
|
oneSignalPlayerID | string |
De OneSignal Player-id. |
|
|
Toegangstoken
|
access_token | string |
Het toegangstoken. |
|
|
Channel
|
channel | string |
Het kanaal. |
|
|
E-mailen
|
string |
Het e-mailadres. |
||
|
Gebruikers-ID
|
user_id | string |
De gebruikers-id. |
|
|
URL
|
url | string |
Het URL-adres. |
|
|
URL
|
url | string |
Het URL-adres. |
|
|
Methode
|
method | string |
De methoden. |
|
|
Wijze
|
mode | string |
De modus. |
|
|
Gebruikersnaam
|
username | string |
De gebruikersnaam. |
|
|
Wachtwoord
|
password | string |
Het wachtwoord. |
|
|
Teken
|
token | string |
Het token. |
|
|
Profile
|
profile | string |
Het profiel. |
Retouren
- response
- string
Een profiel ophalen
Hiermee haalt u het opgegeven geadresseerdeprofiel op.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Geadresseerde-id
|
recipient_id | True | string |
De ontvanger-id. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
E-mailen
|
profile.email | string |
Het e-mailadres. |
|
Telefoonnummer
|
profile.phone_number | string |
Het telefoonnummer. |
Een profiel verwijderen
Hiermee verwijdert u het opgegeven geadresseerdeprofiel.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Geadresseerde-id
|
recipient_id | True | string |
De ontvanger-id. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Toestand
|
status | string |
De status. |
Een sjabloonautomatisering uitvoeren
Een automatiseringsuitvoering aanroepen vanuit een automatiseringssjabloon.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Sjabloon-ID
|
templateId | True | string |
De sjabloon-id. |
|
Merk
|
brand | string |
Het merk. |
|
|
Template
|
template | string |
De sjabloon. |
|
|
Recipient
|
recipient | string |
De ontvanger. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Uitvoerings-id
|
runId | string |
De run-id. |
Gebruikers toevoegen aan een bulktaak
Gebruikersgegevens opnemen in een bulktaak.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Functie-ID
|
job_id | True | string |
De taak-ID. |
|
Recipient
|
recipient | string |
De ontvanger. |
Retouren
- response
- string
Gebruikers van een bulktaak ophalen
Haal de gebruikers van een bulktaak op.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Functie-ID
|
job_id | True | string |
De taak-ID. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Artikelen
|
items | array of object | |
|
Recipient
|
items.recipient | string |
De ontvanger. |
|
E-mailen
|
items.email | string |
Het e-mailadres. |
|
Lokatie
|
items.locale | string |
De landinstelling. |
|
Cursor
|
paging.cursor | string |
De cursor. |
|
Meer
|
paging.more | boolean |
Of er meer is. |
Inhoud van een bericht ophalen
Haal de inhoud van een eerder verzonden bericht op.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bericht-id
|
message_id | True | string |
De bericht-id. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Channel
|
results.channel | string |
Het kanaal. |
|
Kanaal-id
|
results.channel_id | string |
De kanaal-id. |
|
HTML
|
results.content.html | string |
De HTML. |
|
Onderwerp
|
results.content.subject | string |
Het onderwerp. |
|
Tekst
|
results.content.text | string |
De tekst. |
|
Blokken
|
results.content.blocks | array of object | |
|
Typologie
|
results.content.blocks.type | string |
Het type. |
|
Tekst
|
results.content.blocks.text | string |
De tekst. |
Leden van doelgroep vermelden
Een lijst met leden van een doelgroep ophalen.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Doelgroep-id
|
audience_id | True | string |
De doelgroep-id. |
|
Cursor
|
cursor | string |
De cursor. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Artikelen
|
items | array of object | |
|
Lid-id
|
items.member_id | string |
De lid-id. |
|
Toegevoegd op
|
items.added_at | string |
Wanneer toegevoegd op. |
|
Doelgroep-id
|
items.audience_id | string |
De doelgroep-id. |
|
Doelgroepversie
|
items.audience_version | integer |
De doelgroepversie. |
|
Reden
|
items.reason | string |
De reden. |
|
Cursor
|
paging.cursor | string |
De cursor. |
|
Meer
|
paging.more | boolean |
Of er meer is. |
Meldingen weergeven
Hiermee haalt u een lijst met meldingen op.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
De cursor. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
De cursor. |
|
Meer
|
paging.more | boolean |
Of er meer is. |
|
Results
|
results | array of object | |
|
Gemaakt op
|
results.created_at | integer |
Wanneer gemaakt op. |
|
ID-kaart
|
results.id | string |
De id. |
|
Gegevens
|
results.tags.data | array of object | |
|
ID-kaart
|
results.tags.data.id | string |
De id. |
|
Naam
|
results.tags.data.name | string |
De naam. |
|
Title
|
results.title | string |
De titel. |
|
Bijgewerkt op
|
results.updated_at | integer |
Wanneer bijgewerkt op. |
Merken vermelden
Haal een lijst met merken op.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
De cursor. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
De cursor. |
|
Meer
|
paging.more | boolean |
Of er meer is. |
|
Results
|
results | array of object | |
|
Gecreëerd
|
results.created | integer |
Wanneer deze is gemaakt. |
|
ID-kaart
|
results.id | string |
De id. |
|
Naam
|
results.name | string |
De naam. |
|
Gepubliceerd
|
results.published | integer |
Wanneer deze wordt gepubliceerd. |
|
Updated
|
results.updated | integer |
Wanneer dit is bijgewerkt. |
|
Versie
|
results.version | string |
De versie. |
|
Primary
|
results.settings.colors.primary | string |
De primaire. |
|
Secundair
|
results.settings.colors.secondary | string |
De secundaire. |
|
Tertiair
|
results.settings.colors.tertiary | string |
De tertiaire. |
|
Balkkleur
|
results.settings.email.header.barColor | string |
De kleur van de balk. |
|
HREF
|
results.settings.email.header.logo.href | string |
De HREF. |
|
Afbeelding
|
results.settings.email.header.logo.image | string |
De afbeelding. |
|
Markdown
|
results.settings.email.footer.markdown | string |
De markdown. |
|
URL
|
results.settings.email.footer.social.facebook.url | string |
Het URL-adres. |
|
URL
|
results.settings.email.footer.social.instagram.url | string |
Het URL-adres. |
|
URL
|
results.settings.email.footer.social.linkedin.url | string |
Het URL-adres. |
|
URL
|
results.settings.email.footer.social.medium.url | string |
Het URL-adres. |
|
URL
|
results.settings.email.footer.social.twitter.url | string |
Het URL-adres. |
|
Pictogram Bericht uitschakelen
|
results.settings.inapp.disableMessageIcon | boolean |
Of u het berichtpictogram wilt uitschakelen. |
|
Plaatsing
|
results.settings.inapp.placement | string |
De plaatsing. |
|
Artikelen
|
results.snippets.items | array of string |
De items. |
Definities
touw
Dit is het basisgegevenstype 'tekenreeks'.
Voorwerp
Dit is het type 'object'.