Wat dit API-eindpunt doet

Met de Invitations API maakt en verwijdert u uitnodigingen voor Reach 360. Beheerders zien dit als gebruikers op het tabblad In behandeling. Gebruikers ontvangen e-mails wanneer ze worden uitgenodigd. Als hun openstaande uitnodiging wordt verwijderd voordat ze deze accepteren, werkt de e‑maillink niet.

Je kunt deze API ook gebruiken om een lijst op te halen van alle openstaande uitnodigingen of uitnodigingsgegevens voor een specifieke gebruiker.

• Eindpunten
• Objecten voor uitnodigingen
• Uitnodiging maken
• Uitnodigingen weergeven
• Uitnodiging met ID ophalen
• Uitnodigingen verwijderen

Eindpunten

• POST /invitations—stuur een uitnodiging naar een gebruiker om lid te worden van je team
• GET /invitations—lijst van openstaande uitnodigingen
• GET /invitations/{invitationId}—verkrijg informatie over een openstaande uitnodiging op basis van de uitnodigings-id
• DELETE /invitations/{invitationId}—verwijder een openstaande uitnodiging met behulp van de uitnodigings-id

Objecten voor uitnodigingen

• id(string) - de unieke identificator van de uitnodiging
• email(string) - het e-mailadres van de genodigde
• firstName(string) - de voornaam van de genodigde
• lastName(string) - de achternaam van de genodigde
• groups(lijst met tekenreeksen) - een lijst met groepsnamen waaraan de genodigde moet worden toegewezen
• url(string) - URL om de details van de uitnodiging op te halen uit de API

Uitnodiging maken

POST /invitations

Parameters aanvragen (JSON)

• email(tekenreeks, vereist) - e-mailadres van de gebruiker om uit te nodigen
• firstName(string, optioneel) - voornaam van de uit te nodigen gebruiker
• lastName(string, optioneel) - achternaam van de uit te nodigen gebruiker
• groups(lijst met tekenreeksen, optioneel) - lijst met groepsnamen waaraan een uitgenodigde gebruiker moet worden toegewezen. Alle groepen die niet bestaan, worden aangemaakt wanneer de gebruiker de uitnodiging accepteert.

Voorbeeldreactie

{
„invitation”: {
„id”: „voorbeeld-uitnodigings-id”, 
 „email”: "foo@example.com „, 
 „voornaam”: „Voornaam voorbeeld”, 
 „Achternaam”: „Voorbeeld van achternaam”, 
 „groepen”: ["voorbeeldgroep a”, „voorbeeldgroep b"]} 
 

Endpoint-specifieke foutcodes

• 'user_exists'- kan geen uitnodiging aanmaken omdat het opgegeven e-mailadres al een account heeft
• 'invite_pending'- kan geen uitnodiging aanmaken omdat er op het opgegeven e-mailadres al een uitnodiging in behandeling is
• 'max_invites_reached'- kan geen uitnodiging maken omdat je de limiet voor je proefaccount hebt bereikt. Upgrade je abonnement of neem contact op met de klantenservice om deze limiet te verhogen.

Uitnodigingen weergeven

GET /invitations

Verzoekparameters (queryreeks)

• limit(geheel getal, optioneel) - het maximale aantal resultaten dat in één antwoord kan worden geretourneerd (zie Paginering); moet tussen 1 en 100 liggen (standaard 50)
• email(tekenreeks, optioneel) - indien aanwezig, stuur alleen uitnodigingen voor dit e-mailadres

Voorbeeldreactie

{
„invitations”: [
{
„id”: „voorbeelduitnodiging-id-1", 
 „email”: "foo@example.com „, „Voornaam”: 
 „Voorbeeld Voornaam 1", „Achternaam”: 
 „Voorbeeld Achternaam 1", „groepen”: ["voorbeeldgroep a”, 
 „voorbeeldgroep b"]},... 
 
], 
 „NextURL”: "https://url-for-next-page-of-results"} 

Uitnodiging met ID ophalen

GET /invitations/{invitationId}

Voorbeeldreactie

{
„id”: „voorbeeld-uitnodigings-id”, 
 „email”: "foo@example.com „, 
 „voornaam”: „Voornaam voorbeeld”, 
 „Achternaam”: „Voorbeeld van achternaam”, 
 „groepen”: ["voorbeeldgroep a”, „voorbeeldgroep b"]} 

Endpoint-specifieke foutcodes

• 'invitation_not_found'- kan de uitnodiging niet ophalen omdat de uitnodiging niet bestaat

Uitnodigingen verwijderen

DELETE /invitations/{invitationId}

Reactie op succes

204 „Geen inhoud”

Endpoint-specifieke foutcodes

• 'invitation_not_found'- kan de uitnodiging niet ophalen omdat de uitnodiging niet bestaat