API documentation  POST /leads/edit

Modifica una lead

POST https://demo.trafficmanager.com/api/v1/leads/edit
Usa questo endpoint per completare una lead dopo averla inviata con la API nuova lead: invia di nuovo il leadId che hai ricevuto e solo i campi che hai raccolto nel frattempo, per esempio la città o il CAP. La risposta ripete gli stessi valori code / message / clickid / leadId, quindi l'endpoint può essere richiamato ogni volta che ottieni un altro campo.
Gli advertiser che aggiornano le proprie lead devono usare PUT /leads/{id}, che permette anche di cambiare lo stato della lead e si autentica con la chiave advertiser.

Authentication:

The request must be authenticated with the following HTTP headers:
  • x-api-key: Your API key, found on the Security page
  • x-user-id: Your User ID, found on the Security page
If the HTTP headers are not passed, but you are logged in to the TrafficManager panel, the current user is used instead (so you can easily preview or download the data using your browser)

Parametri GET:

  • nessuno

Parametri POST:

Sempre obbligatori:
  • leadId: l'UUID della lead restituito dalla API nuova lead
Campi della lead:
Invia solo i campi che vuoi modificare. Un campo non presente nella richiesta mantiene il valore attuale; un campo inviato vuoto viene salvato vuoto.
  • name: Nome completo
  • given-name: Nome
  • family-name: Cognome o equivalente
  • tel: Numero di telefono completo, con o senza prefisso internazionale
  • email: Indirizzo email del cliente
  • street-address: Indirizzo completo. Sono ammesse più righe di testo.
  • address-level2: Il secondo livello amministrativo, di solito la città/il paese.
  • address-level1: Il primo livello amministrativo dell'indirizzo: stato, regione, provincia o simili.
  • postal-code: Il codice postale (CAP in Italia)
  • qualsiasi altro campo che puoi inviare quando crei la lead, e qualsiasi nuovo campo ti serva aggiungere
Il valore dell'ordine e lo stato della lead non possono essere modificati con questo endpoint. Un campo che seleziona una variante di prodotto viene rifiutato con un 400, perché il prezzo dell'ordine dipende da questo.

Codici di risposta:

  • 200: La richiesta è stata elaborata.
  • 400: Richiesta non valida. Il leadId manca o non è corretto, oppure un campo non è accettato.
  • 403: Autenticazione fallita.
  • 404: Lead non trovata, o non accessibile con queste credenziali.
  • 409: La lead non è più modificabile.

Valori restituiti:

  • code: vedi i Codici di risposta qui sopra. Gli stessi quattro campi vengono restituiti anche in caso di errore, con clickid e leadId impostati a null quando la lead non è stata identificata.
  • message:
    - "OK": la lead è stata aggiornata.
    - "NO_CHANGES": la richiesta non conteneva campi da aggiornare, oppure i valori inviati erano già salvati.
    - "NOT_EDITABLE": la lead non è più in uno stato che ne permette la modifica. Si possono modificare solo le lead ancora in attesa o segnalate come potenziale doppione.
    Nota: nuovi messaggi possono essere aggiunti in qualsiasi momento senza preavviso.
  • clickid: il clickid della lead
  • leadId: l'UUID della lead, come inviato nella richiesta
Se la lead è già stata inoltrata a un partner logistico che supporta l'aggiornamento degli ordini, i nuovi dati vengono inviati anche a lui; il partner può rifiutare l'aggiornamento, per esempio quando l'ordine è già stato preso in carico da un operatore. Questo non influisce sulla risposta: la lead viene comunque aggiornata nella piattaforma. I campi personalizzati vengono aggiornati solo nella piattaforma: contatta il tuo account manager se hai bisogno che arrivino anche all'advertiser.

Esempio di richiesta

curl --location --request POST 'https://demo.trafficmanager.com/api/v1/leads/edit' \
--header 'x-user-id: 04120c02-b144-439f-9f0a-85824e66fc00' \
--header 'x-api-key: TM04dca746122da971e02d55d496ebc457f20a8300' \
--form 'leadId=01913190-5ec5-72a5-a23b-7609ad5328d0' \
--form 'address-level2=Roma' \
--form 'postal-code=00100'

Esempio di risposta

Lead aggiornata:
{
    "code": 200,
    "message": "OK",
    "clickid": "TMd59e6a59297f6b698469b3f02cd57f40",
    "leadId": "01913190-5ec5-72a5-a23b-7609ad5328d0"
}
Lead non più modificabile:
{
    "code": 409,
    "message": "NOT_EDITABLE",
    "clickid": "TMd59e6a59297f6b698469b3f02cd57f40",
    "leadId": "01913190-5ec5-72a5-a23b-7609ad5328d0"
}