Vai al contenuto principale
POST
/
push_notifications
/
create
Creazione notifica
curl --request POST \
  --url https://app.xmenu.it/api/push_notifications/create \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --data '
{
  "title": "<string>",
  "message": "<string>",
  "subrestaurant_code": "<string>",
  "subrestaurant_uid": "<string>"
}
'
{
  "success": true,
  "uid": "<string>",
  "error": "<string>",
  "message": "<string>"
}
write:push_notifications

Autorizzazioni

​
X-Client-Id
string
header
obbligatorio

Client ID per l'autenticazione API Client (deve essere usato insieme al Client Secret)

​
X-Client-Secret
string
header
obbligatorio

Client Secret per l'autenticazione API Client (deve essere usato insieme al Client ID)

Corpo

application/json
​
title
string
obbligatorio

Titolo della notifica push (massimo 50 caratteri)

Maximum string length: 50
​
message
string
obbligatorio

Testo del corpo della notifica push (massimo 500 caratteri)

Maximum string length: 500
​
subrestaurant_code
string

Codice identificativo della locale per invio specifico a una sede (alternativo a subrestaurant_uid)

​
subrestaurant_uid
string

Identificatore univoco della locale per invio specifico a una sede (alternativo a subrestaurant_code)

Risposta

Risposta dell'operazione

​
success
boolean
obbligatorio

Risultato dell'operazione: true se ha avuto successo, false se è fallita

​
uid
string

Identificatore univoco della notifica creata (presente solo in caso di successo)

​
error
string

Codice errore se l'operazione è fallita. Valori possibili:

  • MAX_LENGTH_EXCEEDED = Superato limite di caratteri per titolo o messaggio
  • SUBRESTAURANT_NOT_FOUND = Sottolocalità non trovata

Vedi Codici errore per i codici errore generali che possono verificarsi.

​
message
string

Descrizione leggibile dell'errore se l'operazione è fallita