Flows
GET https://push.marketcat.net/api/flows/
curl --request GET \
--url 'https://push.marketcat.net/api/flows/' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://push.marketcat.net/api/flows/' \
--header 'Authorization: Bearer {api_key}' \
| Parámetros | Detalles | Descripción |
|---|---|---|
| page | Opcional Entero | El número de página del que deseas obtener resultados. Por defecto es 1. |
| results_per_page | Opcional Entero | Cuántos resultados quieres por página. Los valores permitidos son: 10 , 25 , 50 , 100 , 250 , 500 , 1000. Por defecto es 25. |
{
"data": [
{
"id": 1,
"user_id": 1,
"website_id": 1,
"name": "API Sample",
"title": "Sample message",
"description": "This is coming from the API.",
"url": "https://example.com",
"image_url": null,
"settings": {
"ttl": 2419200,
"urgency": "normal",
"is_silent": 0,
"is_auto_hide": 0,
"button_title_1": "",
"button_url_1": "",
"button_title_2": "",
"button_url_2": ""
},
"wait_time": 3,
"wait_time_type": "days",
"is_enabled": true,
"total_sent_push_notifications": 0,
"total_displayed_push_notifications": 0,
"total_clicked_push_notifications": 0,
"total_closed_push_notifications": 0,
"last_sent_datetime": null,
"last_datetime": null,
"datetime": "2024-07-18 03:55:10"
}
],
"meta": {
"page": 1,
"results_per_page": 25,
"total": 1,
"total_pages": 1
},
"links": {
"first": "https://push.marketcat.net/api/flows?&page=1",
"last": "https://push.marketcat.net/api/flows?&page=1",
"next": null,
"prev": null,
"self": "https://push.marketcat.net/api/flows?&page=1"
}
}
GET https://push.marketcat.net/api/flows/{flow_id}
curl --request GET \
--url 'https://push.marketcat.net/api/flows/{flow_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://push.marketcat.net/api/flows/{flow_id}' \
--header 'Authorization: Bearer {api_key}' \
{
"data": {
"id": 1,
"user_id": 1,
"website_id": 1,
"name": "API Sample",
"title": "Sample message",
"description": "This is coming from the API.",
"url": "https://example.com",
"image_url": null,
"settings": {
"ttl": 2419200,
"urgency": "normal",
"is_silent": 0,
"is_auto_hide": 0,
"button_title_1": "",
"button_url_1": "",
"button_title_2": "",
"button_url_2": ""
},
"wait_time": 3,
"wait_time_type": "days",
"is_enabled": true,
"total_sent_push_notifications": 0,
"total_displayed_push_notifications": 0,
"total_clicked_push_notifications": 0,
"total_closed_push_notifications": 0,
"last_sent_datetime": null,
"last_datetime": null,
"datetime": "2024-07-18 03:55:10"
}
}
POST https://push.marketcat.net/api/flows
| Parámetros | Detalles | Descripción |
|---|---|---|
| website_id | Requerido Entero | - |
| name | Requerido Cadena | - |
| title | Requerido Cadena | - |
| description | Requerido Cadena | - |
| url | Opcional Cadena | - |
| image | Opcional Archivo | - |
| wait_time | Requerido Entero | - |
| wait_time_type | Requerido Cadena | Valores permitidos: minutes , hours , days |
| button_title_1 | Opcional Cadena | - |
| button_url_1 | Opcional Cadena | - |
| button_title_2 | Opcional Cadena | - |
| button_url_2 | Opcional Cadena | - |
| is_silent | Opcional Booleano | - |
| is_auto_hide | Opcional Booleano | - |
| ttl | Opcional Cadena | Valores permitidos: 0 , 900 , 1800 , 3600 , 10800 , 21600 , 43200 , 86400 , 259200 , 432000 , 604800 , 1209600 , 2419200 |
curl --request POST \
--url 'https://push.marketcat.net/api/flows' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'website_id=1' \
--form 'title=Example title' \
--form 'description=Example description' \
--form 'segment=all' \
--url 'https://push.marketcat.net/api/flows' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'website_id=1' \
--form 'title=Example title' \
--form 'description=Example description' \
--form 'segment=all' \
{
"data": {
"id": 1
}
}
POST https://push.marketcat.net/api/flows/{flow_id}
| Parámetros | Detalles | Descripción |
|---|---|---|
| website_id | Opcional Entero | - |
| name | Opcional Cadena | - |
| title | Opcional Cadena | - |
| description | Opcional Cadena | - |
| url | Opcional Cadena | - |
| image | Opcional Archivo | - |
| wait_time | Opcional Entero | - |
| wait_time_type | Opcional Cadena | Valores permitidos: minutes , hours , days |
| button_title_1 | Opcional Cadena | - |
| button_url_1 | Opcional Cadena | - |
| button_title_2 | Opcional Cadena | - |
| button_url_2 | Opcional Cadena | - |
| is_silent | Opcional Booleano | - |
| is_auto_hide | Opcional Booleano | - |
| ttl | Opcional Cadena | Valores permitidos: 0 , 900 , 1800 , 3600 , 10800 , 21600 , 43200 , 86400 , 259200 , 432000 , 604800 , 1209600 , 2419200 |
curl --request POST \
--url 'https://push.marketcat.net/api/flows/{flow_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'website_id=1' \
--form 'title=Example title' \
--form 'description=Example description' \
--form 'segment=all' \
--url 'https://push.marketcat.net/api/flows/{flow_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'website_id=1' \
--form 'title=Example title' \
--form 'description=Example description' \
--form 'segment=all' \
{
"data": {
"id": 1
}
}
DELETE https://push.marketcat.net/api/flows/{flow_id}
curl --request DELETE \
--url 'https://push.marketcat.net/api/flows/{flow_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://push.marketcat.net/api/flows/{flow_id}' \
--header 'Authorization: Bearer {api_key}' \