Skip to main content

PUT /v1/whatsapp/contacts/{phone}

Crea la scheda contatto di un numero di telefono, o la aggiorna se esiste già. È la rotta con cui il gestionale porta in MyFlow quello che sa dei suoi clienti: il team vede il nome giusto in Inbox, e le Campagne e gli Automatismi possono usare tag e date. La scheda si può creare anche per un numero che non ha mai scritto: da quel momento compare tra i contatti, con numbers vuoto finché non scrive. Aggiornamento parziale:
  • un campo assente dal body resta com’è;
  • un campo a null (o stringa vuota) viene svuotato;
  • un campo con un valore lo sostituisce.
Per cambiare solo l’email, quindi, basta mandare {"email": "…"}.

Parametri

Request Body

Un oggetto JSON. Tutti i campi sono facoltativi; {} crea una scheda vuota se non c’è, e non cambia niente se c’è già. I campi di testo (name, company, customer_code, email) accettano una stringa o un numero intero. Gli spazi all’inizio e alla fine vengono tolti, gli a capo e gli altri caratteri di controllo diventano spazi. Un valore che dopo la pulizia resta vuoto svuota il campo.
Tag e date personalizzate non si creano dall’API: si definiscono in MyFlow → Impostazioni e si leggono con GET /v1/whatsapp/contacts/fields. Un nome sconosciuto fa rifiutare l’intera richiesta, con l’elenco dei nomi sconosciuti in error.unknown: niente viene salvato a metà.
I tag che restano sulla scheda non vengono toccati: conservano la data in cui sono stati messi la prima volta. Gli Automatismi di MyFlow che partono quando si mette un tag non ripartono a ogni aggiornamento del gestionale.

Richiesta

Per svuotare un campo, mandalo a null:

Risposta

201 Created se la scheda è nuova ("created": true), 200 OK se esisteva già ("created": false). Il contatto torna com’è dopo il salvataggio, nello stesso formato di GET /v1/whatsapp/contacts/{phone}.
Il compleanno torna sempre nel formato YYYY-MM-DD se c’è l’anno, DD/MM se non c’è, qualunque formato tu abbia usato per scriverlo.

Campi della risposta

Quelli del dettaglio contatto, più: Ogni creazione e ogni modifica lascia una riga nel Log attività del pannello, così il titolare vede che cosa ha cambiato il gestionale.

Errori

400 - invalid_phone

Il numero nel percorso non è riconoscibile. Usa il formato internazionale, per esempio +393331234567.

422 - invalid_name / invalid_company / invalid_customer_code

Il campo non è un testo (per esempio è un booleano, un oggetto o un elenco) o supera la lunghezza massima. Il messaggio dice quale.

422 - invalid_email

L’email non è un testo, supera i 190 caratteri o non è un indirizzo valido.

422 - invalid_birthday

Il compleanno non è in uno dei tre formati, la data non esiste (per esempio 31/04) o l’anno è fuori dall’intervallo che va dal 1900 all’anno in corso.

422 - invalid_dates

dates non è un oggetto, una data non è nel formato YYYY-MM-DD o non esiste, oppure una chiave non corrisponde a nessuna data dell’account. In quest’ultimo caso error.unknown elenca le chiavi sconosciute:

422 - invalid_tags

tags non è un elenco, oppure contiene tag che non esistono sull’account. error.unknown elenca quelli sconosciuti. Gli errori comuni a tutte le rotte sono nell’introduzione.