Cosa fa questo endpoint API

Con l'API Invitations, puoi creare ed eliminare gli inviti a Reach 360. Gli amministratori lo vedono riflesso come utenti nella scheda In sospeso. Gli utenti ricevono e-mail quando vengono invitati. Se l'invito in sospeso viene eliminato prima dell'accettazione, il link e-mail non funzionerà.

Puoi anche utilizzare questa API per recuperare un elenco di tutti gli inviti o i dettagli degli inviti in sospeso per un utente specifico.

• Endpoint
• Oggetti di invito
• Crea invito
• Elenca inviti
• Recupera l'invito tramite ID
• Elimina gli inviti

Endpoint

• POST /invitations—invia un invito a un utente affinché entri a far parte del tuo team
• GET /invitations—elenca gli inviti in sospeso
• GET /invitations/{invitationId}—ottieni i dettagli di un invito in sospeso tramite l'ID dell'invito
• DELETE /invitations/{invitationId}—elimina un invito in sospeso in base all'ID dell'invito

Oggetti di invito

• id(stringa): l'identificatore univoco dell'invito
• email(string): l'indirizzo email dell'invitato
• firstName(string): il nome dell'invitato
• lastName(string) - il cognome dell'invitato
• groups(elenco di stringhe) - un elenco di nomi di gruppo a cui deve essere assegnato l'invitato
• url(stringa) - URL per recuperare i dettagli dell'invito dall'API

Crea invito

POST /invitations

Parametri di richiesta (JSON)

• email(stringa, obbligatorio) - email dell'utente da invitare
• firstName(stringa, opzionale) - nome dell'utente da invitare
• lastName(stringa, opzionale) - cognome dell'utente da invitare
• groups(elenco di stringhe, opzionale) - elenco di nomi di gruppi a cui assegnare l'utente invitato. Tutti i gruppi che non esistono vengono creati quando l'utente accetta l'invito.

Esempio di risposta

{
«invitation»: {
«id»: «example-invitation-id», 
 «email»: "foo@example.com «, «firstName»: 
 «Nome di esempio», «cognome»: 
 «Cognome di esempio», «groups»: ["esempio gruppo a», 
 «gruppo di esempio b"]}} 
 

Codici di errore specifici dell'endpoint

• 'user_exists'- impossibile creare un invito perché l'indirizzo e-mail specificato ha già un account
• 'invite_pending'- impossibile creare un invito perché l'indirizzo e-mail specificato ha già un invito in sospeso
• 'max_invites_reached'- non puoi creare un invito perché hai raggiunto il limite per il tuo account di prova. Aggiorna il tuo piano o contatta l'assistenza per aumentare questo limite.

Elenca gli inviti

GET /invitations

Parametri della richiesta (stringa di query)

• limit(intero, opzionale): il numero massimo di risultati da restituire in una singola risposta (vedi Pagination); deve essere compreso tra 1 e 100 (il valore predefinito è 50)
• email(stringa, opzionale): se fornito, restituisci solo gli inviti per questo indirizzo email

Esempio di risposta

{
«invitations»: [
{
«id»: «example-invitation-id-1", 
 «email»: "foo@example.com «, «firstName»: «Esempio di nome 1", 
 «cognome»: «Cognome di esempio 1", 
 «group»: ["esempio gruppo a», 
 «gruppo di esempio b"]},... 
 
], «nextUrl»: "https://url-for-next-page-of-results"} 
 

Recupera l'invito per ID

GET /invitations/{invitationId}

Esempio di risposta

{
«id»: «example-invitation-id», 
 «email»: "foo@example.com «, «firstName»: 
 «Nome di esempio», «lastName»: 
 «Cognome di esempio», «groups»: ["example group a», 
 «example-group b"]} 

Codici di errore specifici dell'endpoint

• 'invitation_not_found'- impossibile recuperare l'invito perché l'invito non esiste

Eliminare gli inviti

DELETE /invitations/{invitationId}

Risposta di successo

204 «Nessun contenuto»

Codici di errore specifici dell'endpoint

• 'invitation_not_found'- impossibile recuperare l'invito perché l'invito non esiste