Centro de Ayuda de Dardo
Referencia

Plantillas

Las plantillas de tarjeta que creás en el panel. Acá se listan, se consultan y se administran.

Activate template

POST/api/v2/templates/{id}/activate

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Path Parameters

id*string

Response Body

application/json

curl -X POST "https://example.com/api/v2/templates/string/activate"
{  "responseId": "ed662de2-39c1-4e7d-a6bf-6980511adfaf",  "createdAt": "2019-08-24T14:15:22Z",  "code": 0,  "data": {    "id": 0,    "idHash": "string",    "companyId": 0,    "type": 0,    "name": "string",    "customFields": [      {        "id": 0,        "name": "string",        "type": "string",        "order": 0,        "value": "string",        "required": true,        "unique": true      }    ],    "membershipTiers": [      {        "id": 0,        "templateId": 0,        "name": "string",        "description": "string",        "dailyParameters": {          "price": 0.1,          "limit": 0,          "perFilialLimit": 0,          "active": true,          "recommended": true        },        "weeklyParameters": {          "price": 0.1,          "limit": 0,          "perFilialLimit": 0,          "active": true,          "recommended": true        },        "monthlyParameters": {          "price": 0.1,          "limit": 0,          "perFilialLimit": 0,          "active": true,          "recommended": true        },        "yearlyParameters": {          "price": 0.1,          "limit": 0,          "perFilialLimit": 0,          "active": true,          "recommended": true        },        "benefits": [          "string"        ]      }    ],    "rewardTiers": [      {        "id": 0,        "templateId": 0,        "name": "string",        "type": 0,        "threshold": 0,        "value": 0.1,        "valueLimit": 0.1,        "periodValueLimit": 0.1,        "usageLimit": 0,        "limitPeriod": 0,        "calendarPeriod": true,        "imageUrl": "string",        "includedSegmentIds": [          0        ],        "excludedSegmentIds": [          0        ],        "includedUtmLinkIds": [          0        ],        "excludedUtmLinkIds": [          0        ]      }    ],    "appearance": {      "barcodeType": "string",      "textColor": "string",      "backgroundColor": "string",      "activeStampColor": "string",      "inactiveStampColor": "string",      "stampBackgroundColor": "string",      "stampStrokeColor": "string",      "stampsAreaBackgroundColor": "string",      "logoImageUrl": "string",      "iconImageUrl": "string",      "backgroundImageUrl": "string",      "activeStampImageUrl": "string",      "inactiveStampImageUrl": "string"    },    "installLink": "string",    "qrLink": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "utmLinks": [      {        "id": 0,        "templateId": 0,        "type": "string",        "name": "string",        "utmSource": "string",        "shortLink": "string",        "welcomeBonusesNumber": 0,        "welcomeStampsNumber": 0,        "welcomeExpiryPeriodInUnits": 0,        "welcomeExpiryPeriodUnits": "string",        "formTitle": "string",        "formImageUrl": "string"      }    ],    "systemUtmLinks": [      {        "id": 0,        "templateId": 0,        "type": "string",        "name": "string",        "utmSource": "string",        "shortLink": "string",        "welcomeBonusesNumber": 0,        "welcomeStampsNumber": 0,        "welcomeExpiryPeriodInUnits": 0,        "welcomeExpiryPeriodUnits": "string",        "formTitle": "string",        "formImageUrl": "string"      }    ]  }}
POST/api/v2/templates/{templateId}/feedback-links

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Path Parameters

templateId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/api/v2/templates/string/feedback-links" \  -H "Content-Type: application/json" \  -d '{    "link": "string"  }'
{  "responseId": "ed662de2-39c1-4e7d-a6bf-6980511adfaf",  "createdAt": "2019-08-24T14:15:22Z",  "code": 0,  "data": {}}

List membership tiers

GET/api/v2/templates/{templateId}/membership-tiers

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Path Parameters

templateId*string
Match\d+

Response Body

application/json

curl -X GET "https://example.com/api/v2/templates/string/membership-tiers"
{  "responseId": "ed662de2-39c1-4e7d-a6bf-6980511adfaf",  "createdAt": "2019-08-24T14:15:22Z",  "code": 0,  "data": [    {      "id": 0,      "templateId": 0,      "name": "string",      "description": "string",      "dailyParameters": {        "price": 0.1,        "limit": 0,        "perFilialLimit": 0,        "active": true,        "recommended": true      },      "weeklyParameters": {        "price": 0.1,        "limit": 0,        "perFilialLimit": 0,        "active": true,        "recommended": true      },      "monthlyParameters": {        "price": 0.1,        "limit": 0,        "perFilialLimit": 0,        "active": true,        "recommended": true      },      "yearlyParameters": {        "price": 0.1,        "limit": 0,        "perFilialLimit": 0,        "active": true,        "recommended": true      },      "benefits": [        "string"      ]    }  ]}

Create membership tier

POST/api/v2/templates/{templateId}/membership-tiers

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Path Parameters

templateId*string
Match\d+

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/api/v2/templates/string/membership-tiers" \  -H "Content-Type: application/json" \  -d '{    "name": "",    "description": "",    "dailyParameters": {},    "weeklyParameters": {},    "monthlyParameters": {},    "yearlyParameters": {}  }'
{  "responseId": "ed662de2-39c1-4e7d-a6bf-6980511adfaf",  "createdAt": "2019-08-24T14:15:22Z",  "code": 0,  "data": {    "id": 0,    "templateId": 0,    "name": "string",    "description": "string",    "dailyParameters": {      "price": 0.1,      "limit": 0,      "perFilialLimit": 0,      "active": true,      "recommended": true    },    "weeklyParameters": {      "price": 0.1,      "limit": 0,      "perFilialLimit": 0,      "active": true,      "recommended": true    },    "monthlyParameters": {      "price": 0.1,      "limit": 0,      "perFilialLimit": 0,      "active": true,      "recommended": true    },    "yearlyParameters": {      "price": 0.1,      "limit": 0,      "perFilialLimit": 0,      "active": true,      "recommended": true    },    "benefits": [      "string"    ]  }}

Create reward tier

POST/api/v2/templates/{templateId}/reward-tiers

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Path Parameters

templateId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/api/v2/templates/string/reward-tiers" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "type": "custom",    "value": 0.1  }'
{  "responseId": "ed662de2-39c1-4e7d-a6bf-6980511adfaf",  "createdAt": "2019-08-24T14:15:22Z",  "code": 0,  "data": {    "id": 0,    "templateId": 0,    "name": "string",    "type": 0,    "threshold": 0,    "value": 0.1,    "valueLimit": 0.1,    "periodValueLimit": 0.1,    "usageLimit": 0,    "limitPeriod": 0,    "calendarPeriod": true,    "imageUrl": "string",    "includedSegmentIds": [      0    ],    "excludedSegmentIds": [      0    ],    "includedUtmLinkIds": [      0    ],    "excludedUtmLinkIds": [      0    ]  }}

List of templates

GET/api/v2/templates

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Query Parameters

page?integer

Page number

Range1 <= value
Default1
itemsPerPage?integer

Items per page

Range1 <= value <= 1000
Default30

Response Body

application/json

curl -X GET "https://example.com/api/v2/templates"
{  "responseId": "ed662de2-39c1-4e7d-a6bf-6980511adfaf",  "createdAt": "2019-08-24T14:15:22Z",  "code": 0,  "meta": {    "totalItems": 0,    "itemsPerPage": 0,    "currentPage": 0  },  "data": [    {      "id": 0,      "idHash": "string",      "companyId": 0,      "type": 0,      "name": "string",      "customFields": [        {          "id": 0,          "name": "string",          "type": "string",          "order": 0,          "value": "string",          "required": true,          "unique": true        }      ],      "membershipTiers": [        {          "id": 0,          "templateId": 0,          "name": "string",          "description": "string",          "dailyParameters": {            "price": 0.1,            "limit": 0,            "perFilialLimit": 0,            "active": true,            "recommended": true          },          "weeklyParameters": {            "price": 0.1,            "limit": 0,            "perFilialLimit": 0,            "active": true,            "recommended": true          },          "monthlyParameters": {            "price": 0.1,            "limit": 0,            "perFilialLimit": 0,            "active": true,            "recommended": true          },          "yearlyParameters": {            "price": 0.1,            "limit": 0,            "perFilialLimit": 0,            "active": true,            "recommended": true          },          "benefits": [            "string"          ]        }      ],      "rewardTiers": [        {          "id": 0,          "templateId": 0,          "name": "string",          "type": 0,          "threshold": 0,          "value": 0.1,          "valueLimit": 0.1,          "periodValueLimit": 0.1,          "usageLimit": 0,          "limitPeriod": 0,          "calendarPeriod": true,          "imageUrl": "string",          "includedSegmentIds": [            0          ],          "excludedSegmentIds": [            0          ],          "includedUtmLinkIds": [            0          ],          "excludedUtmLinkIds": [            0          ]        }      ],      "appearance": {        "barcodeType": "string",        "textColor": "string",        "backgroundColor": "string",        "activeStampColor": "string",        "inactiveStampColor": "string",        "stampBackgroundColor": "string",        "stampStrokeColor": "string",        "stampsAreaBackgroundColor": "string",        "logoImageUrl": "string",        "iconImageUrl": "string",        "backgroundImageUrl": "string",        "activeStampImageUrl": "string",        "inactiveStampImageUrl": "string"      },      "installLink": "string",      "qrLink": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "utmLinks": [        {          "id": 0,          "templateId": 0,          "type": "string",          "name": "string",          "utmSource": "string",          "shortLink": "string",          "welcomeBonusesNumber": 0,          "welcomeStampsNumber": 0,          "welcomeExpiryPeriodInUnits": 0,          "welcomeExpiryPeriodUnits": "string",          "formTitle": "string",          "formImageUrl": "string"        }      ],      "systemUtmLinks": [        {          "id": 0,          "templateId": 0,          "type": "string",          "name": "string",          "utmSource": "string",          "shortLink": "string",          "welcomeBonusesNumber": 0,          "welcomeStampsNumber": 0,          "welcomeExpiryPeriodInUnits": 0,          "welcomeExpiryPeriodUnits": "string",          "formTitle": "string",          "formImageUrl": "string"        }      ]    }  ]}

Create template

POST/api/v2/templates

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/api/v2/templates" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "type": "stamp",    "customFields": [      {        "name": "string",        "type": "number"      }    ]  }'
{  "responseId": "ed662de2-39c1-4e7d-a6bf-6980511adfaf",  "createdAt": "2019-08-24T14:15:22Z",  "code": 0,  "data": {    "id": 0,    "idHash": "string",    "companyId": 0,    "type": 0,    "name": "string",    "customFields": [      {        "id": 0,        "name": "string",        "type": "string",        "order": 0,        "value": "string",        "required": true,        "unique": true      }    ],    "membershipTiers": [      {        "id": 0,        "templateId": 0,        "name": "string",        "description": "string",        "dailyParameters": {          "price": 0.1,          "limit": 0,          "perFilialLimit": 0,          "active": true,          "recommended": true        },        "weeklyParameters": {          "price": 0.1,          "limit": 0,          "perFilialLimit": 0,          "active": true,          "recommended": true        },        "monthlyParameters": {          "price": 0.1,          "limit": 0,          "perFilialLimit": 0,          "active": true,          "recommended": true        },        "yearlyParameters": {          "price": 0.1,          "limit": 0,          "perFilialLimit": 0,          "active": true,          "recommended": true        },        "benefits": [          "string"        ]      }    ],    "rewardTiers": [      {        "id": 0,        "templateId": 0,        "name": "string",        "type": 0,        "threshold": 0,        "value": 0.1,        "valueLimit": 0.1,        "periodValueLimit": 0.1,        "usageLimit": 0,        "limitPeriod": 0,        "calendarPeriod": true,        "imageUrl": "string",        "includedSegmentIds": [          0        ],        "excludedSegmentIds": [          0        ],        "includedUtmLinkIds": [          0        ],        "excludedUtmLinkIds": [          0        ]      }    ],    "appearance": {      "barcodeType": "string",      "textColor": "string",      "backgroundColor": "string",      "activeStampColor": "string",      "inactiveStampColor": "string",      "stampBackgroundColor": "string",      "stampStrokeColor": "string",      "stampsAreaBackgroundColor": "string",      "logoImageUrl": "string",      "iconImageUrl": "string",      "backgroundImageUrl": "string",      "activeStampImageUrl": "string",      "inactiveStampImageUrl": "string"    },    "installLink": "string",    "qrLink": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "utmLinks": [      {        "id": 0,        "templateId": 0,        "type": "string",        "name": "string",        "utmSource": "string",        "shortLink": "string",        "welcomeBonusesNumber": 0,        "welcomeStampsNumber": 0,        "welcomeExpiryPeriodInUnits": 0,        "welcomeExpiryPeriodUnits": "string",        "formTitle": "string",        "formImageUrl": "string"      }    ],    "systemUtmLinks": [      {        "id": 0,        "templateId": 0,        "type": "string",        "name": "string",        "utmSource": "string",        "shortLink": "string",        "welcomeBonusesNumber": 0,        "welcomeStampsNumber": 0,        "welcomeExpiryPeriodInUnits": 0,        "welcomeExpiryPeriodUnits": "string",        "formTitle": "string",        "formImageUrl": "string"      }    ]  }}
PATCH/api/v2/templates/{templateId}/feedback-links/{id}

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Path Parameters

templateId*string
id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PATCH "https://example.com/api/v2/templates/string/feedback-links/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "responseId": "ed662de2-39c1-4e7d-a6bf-6980511adfaf",  "createdAt": "2019-08-24T14:15:22Z",  "code": 0,  "data": {}}
DELETE/api/v2/templates/{templateId}/feedback-links/{id}

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Path Parameters

templateId*string
id*string

Response Body

application/json

curl -X DELETE "https://example.com/api/v2/templates/string/feedback-links/string"
{  "responseId": "ed662de2-39c1-4e7d-a6bf-6980511adfaf",  "createdAt": "2019-08-24T14:15:22Z",  "code": 0,  "data": {    "id": 0  }}

Update membership tier

PATCH/api/v2/templates/{templateId}/membership-tiers/{id}

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Path Parameters

templateId*string
Match\d+
id*string
Match\d+

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PATCH "https://example.com/api/v2/templates/string/membership-tiers/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "responseId": "ed662de2-39c1-4e7d-a6bf-6980511adfaf",  "createdAt": "2019-08-24T14:15:22Z",  "code": 0,  "data": {    "id": 0,    "templateId": 0,    "name": "string",    "description": "string",    "dailyParameters": {      "price": 0.1,      "limit": 0,      "perFilialLimit": 0,      "active": true,      "recommended": true    },    "weeklyParameters": {      "price": 0.1,      "limit": 0,      "perFilialLimit": 0,      "active": true,      "recommended": true    },    "monthlyParameters": {      "price": 0.1,      "limit": 0,      "perFilialLimit": 0,      "active": true,      "recommended": true    },    "yearlyParameters": {      "price": 0.1,      "limit": 0,      "perFilialLimit": 0,      "active": true,      "recommended": true    },    "benefits": [      "string"    ]  }}

Delete membership tier

DELETE/api/v2/templates/{templateId}/membership-tiers/{id}

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Path Parameters

templateId*string
Match\d+
id*string
Match\d+

Response Body

application/json

curl -X DELETE "https://example.com/api/v2/templates/string/membership-tiers/string"
{  "responseId": "ed662de2-39c1-4e7d-a6bf-6980511adfaf",  "createdAt": "2019-08-24T14:15:22Z",  "code": 0,  "data": {    "id": 0  }}

Update reward tier

PATCH/api/v2/templates/{templateId}/reward-tiers/{id}

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Path Parameters

templateId*string
id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PATCH "https://example.com/api/v2/templates/string/reward-tiers/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "responseId": "ed662de2-39c1-4e7d-a6bf-6980511adfaf",  "createdAt": "2019-08-24T14:15:22Z",  "code": 0,  "data": {    "id": 0,    "templateId": 0,    "name": "string",    "type": 0,    "threshold": 0,    "value": 0.1,    "valueLimit": 0.1,    "periodValueLimit": 0.1,    "usageLimit": 0,    "limitPeriod": 0,    "calendarPeriod": true,    "imageUrl": "string",    "includedSegmentIds": [      0    ],    "excludedSegmentIds": [      0    ],    "includedUtmLinkIds": [      0    ],    "excludedUtmLinkIds": [      0    ]  }}

Delete reward tier

DELETE/api/v2/templates/{templateId}/reward-tiers/{id}

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Path Parameters

templateId*string
id*string

Response Body

application/json

curl -X DELETE "https://example.com/api/v2/templates/string/reward-tiers/string"
{  "responseId": "ed662de2-39c1-4e7d-a6bf-6980511adfaf",  "createdAt": "2019-08-24T14:15:22Z",  "code": 0,  "data": {    "id": 0  }}

Get template

GET/api/v2/templates/{id}

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Path Parameters

id*string

Response Body

application/json

curl -X GET "https://example.com/api/v2/templates/string"
{  "responseId": "ed662de2-39c1-4e7d-a6bf-6980511adfaf",  "createdAt": "2019-08-24T14:15:22Z",  "code": 0,  "data": {    "id": 0,    "idHash": "string",    "companyId": 0,    "type": 0,    "name": "string",    "customFields": [      {        "id": 0,        "name": "string",        "type": "string",        "order": 0,        "value": "string",        "required": true,        "unique": true      }    ],    "membershipTiers": [      {        "id": 0,        "templateId": 0,        "name": "string",        "description": "string",        "dailyParameters": {          "price": 0.1,          "limit": 0,          "perFilialLimit": 0,          "active": true,          "recommended": true        },        "weeklyParameters": {          "price": 0.1,          "limit": 0,          "perFilialLimit": 0,          "active": true,          "recommended": true        },        "monthlyParameters": {          "price": 0.1,          "limit": 0,          "perFilialLimit": 0,          "active": true,          "recommended": true        },        "yearlyParameters": {          "price": 0.1,          "limit": 0,          "perFilialLimit": 0,          "active": true,          "recommended": true        },        "benefits": [          "string"        ]      }    ],    "rewardTiers": [      {        "id": 0,        "templateId": 0,        "name": "string",        "type": 0,        "threshold": 0,        "value": 0.1,        "valueLimit": 0.1,        "periodValueLimit": 0.1,        "usageLimit": 0,        "limitPeriod": 0,        "calendarPeriod": true,        "imageUrl": "string",        "includedSegmentIds": [          0        ],        "excludedSegmentIds": [          0        ],        "includedUtmLinkIds": [          0        ],        "excludedUtmLinkIds": [          0        ]      }    ],    "appearance": {      "barcodeType": "string",      "textColor": "string",      "backgroundColor": "string",      "activeStampColor": "string",      "inactiveStampColor": "string",      "stampBackgroundColor": "string",      "stampStrokeColor": "string",      "stampsAreaBackgroundColor": "string",      "logoImageUrl": "string",      "iconImageUrl": "string",      "backgroundImageUrl": "string",      "activeStampImageUrl": "string",      "inactiveStampImageUrl": "string"    },    "installLink": "string",    "qrLink": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "utmLinks": [      {        "id": 0,        "templateId": 0,        "type": "string",        "name": "string",        "utmSource": "string",        "shortLink": "string",        "welcomeBonusesNumber": 0,        "welcomeStampsNumber": 0,        "welcomeExpiryPeriodInUnits": 0,        "welcomeExpiryPeriodUnits": "string",        "formTitle": "string",        "formImageUrl": "string"      }    ],    "systemUtmLinks": [      {        "id": 0,        "templateId": 0,        "type": "string",        "name": "string",        "utmSource": "string",        "shortLink": "string",        "welcomeBonusesNumber": 0,        "welcomeStampsNumber": 0,        "welcomeExpiryPeriodInUnits": 0,        "welcomeExpiryPeriodUnits": "string",        "formTitle": "string",        "formImageUrl": "string"      }    ]  }}

Partially update a template

PATCH/api/v2/templates/{id}

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PATCH "https://example.com/api/v2/templates/string" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "type": "stamp",    "customFields": [      {        "name": "string",        "type": "number"      }    ]  }'
{  "responseId": "ed662de2-39c1-4e7d-a6bf-6980511adfaf",  "createdAt": "2019-08-24T14:15:22Z",  "code": 0,  "data": {    "id": 0,    "idHash": "string",    "companyId": 0,    "type": 0,    "name": "string",    "customFields": [      {        "id": 0,        "name": "string",        "type": "string",        "order": 0,        "value": "string",        "required": true,        "unique": true      }    ],    "membershipTiers": [      {        "id": 0,        "templateId": 0,        "name": "string",        "description": "string",        "dailyParameters": {          "price": 0.1,          "limit": 0,          "perFilialLimit": 0,          "active": true,          "recommended": true        },        "weeklyParameters": {          "price": 0.1,          "limit": 0,          "perFilialLimit": 0,          "active": true,          "recommended": true        },        "monthlyParameters": {          "price": 0.1,          "limit": 0,          "perFilialLimit": 0,          "active": true,          "recommended": true        },        "yearlyParameters": {          "price": 0.1,          "limit": 0,          "perFilialLimit": 0,          "active": true,          "recommended": true        },        "benefits": [          "string"        ]      }    ],    "rewardTiers": [      {        "id": 0,        "templateId": 0,        "name": "string",        "type": 0,        "threshold": 0,        "value": 0.1,        "valueLimit": 0.1,        "periodValueLimit": 0.1,        "usageLimit": 0,        "limitPeriod": 0,        "calendarPeriod": true,        "imageUrl": "string",        "includedSegmentIds": [          0        ],        "excludedSegmentIds": [          0        ],        "includedUtmLinkIds": [          0        ],        "excludedUtmLinkIds": [          0        ]      }    ],    "appearance": {      "barcodeType": "string",      "textColor": "string",      "backgroundColor": "string",      "activeStampColor": "string",      "inactiveStampColor": "string",      "stampBackgroundColor": "string",      "stampStrokeColor": "string",      "stampsAreaBackgroundColor": "string",      "logoImageUrl": "string",      "iconImageUrl": "string",      "backgroundImageUrl": "string",      "activeStampImageUrl": "string",      "inactiveStampImageUrl": "string"    },    "installLink": "string",    "qrLink": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "utmLinks": [      {        "id": 0,        "templateId": 0,        "type": "string",        "name": "string",        "utmSource": "string",        "shortLink": "string",        "welcomeBonusesNumber": 0,        "welcomeStampsNumber": 0,        "welcomeExpiryPeriodInUnits": 0,        "welcomeExpiryPeriodUnits": "string",        "formTitle": "string",        "formImageUrl": "string"      }    ],    "systemUtmLinks": [      {        "id": 0,        "templateId": 0,        "type": "string",        "name": "string",        "utmSource": "string",        "shortLink": "string",        "welcomeBonusesNumber": 0,        "welcomeStampsNumber": 0,        "welcomeExpiryPeriodInUnits": 0,        "welcomeExpiryPeriodUnits": "string",        "formTitle": "string",        "formImageUrl": "string"      }    ]  }}

Delete template

DELETE/api/v2/templates/{id}

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Path Parameters

id*string

Response Body

application/json

curl -X DELETE "https://example.com/api/v2/templates/string"
{  "responseId": "ed662de2-39c1-4e7d-a6bf-6980511adfaf",  "createdAt": "2019-08-24T14:15:22Z",  "code": 0,  "data": {    "id": 0  }}
GET/api/v2/templates/{templateId}/utm-links

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Path Parameters

templateId*string

Query Parameters

page?integer

Page number

Range1 <= value
Default1
itemsPerPage?integer

Items per page

Range1 <= value <= 1000
Default30

Response Body

application/json

curl -X GET "https://example.com/api/v2/templates/string/utm-links"
{  "responseId": "ed662de2-39c1-4e7d-a6bf-6980511adfaf",  "createdAt": "2019-08-24T14:15:22Z",  "code": 0,  "meta": {    "totalItems": 0,    "itemsPerPage": 0,    "currentPage": 0  },  "data": [    {      "id": 0,      "templateId": 0,      "type": "string",      "name": "string",      "utmSource": "string",      "shortLink": "string",      "welcomeBonusesNumber": 0,      "welcomeStampsNumber": 0,      "welcomeExpiryPeriodInUnits": 0,      "welcomeExpiryPeriodUnits": "string",      "formTitle": "string",      "formImageUrl": "string"    }  ]}
POST/api/v2/templates/{templateId}/utm-links

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Path Parameters

templateId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/api/v2/templates/string/utm-links" \  -H "Content-Type: application/json" \  -d '{    "name": ""  }'
{  "responseId": "ed662de2-39c1-4e7d-a6bf-6980511adfaf",  "createdAt": "2019-08-24T14:15:22Z",  "code": 0,  "data": {    "id": 0,    "templateId": 0,    "type": "string",    "name": "string",    "utmSource": "string",    "shortLink": "string",    "welcomeBonusesNumber": 0,    "welcomeStampsNumber": 0,    "welcomeExpiryPeriodInUnits": 0,    "welcomeExpiryPeriodUnits": "string",    "formTitle": "string",    "formImageUrl": "string"  }}
GET/api/v2/templates/{templateId}/utm-links/{id}

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Path Parameters

templateId*string
id*string

Response Body

application/json

curl -X GET "https://example.com/api/v2/templates/string/utm-links/string"
{  "responseId": "ed662de2-39c1-4e7d-a6bf-6980511adfaf",  "createdAt": "2019-08-24T14:15:22Z",  "code": 0,  "data": {    "id": 0,    "templateId": 0,    "type": "string",    "name": "string",    "utmSource": "string",    "shortLink": "string",    "welcomeBonusesNumber": 0,    "welcomeStampsNumber": 0,    "welcomeExpiryPeriodInUnits": 0,    "welcomeExpiryPeriodUnits": "string",    "formTitle": "string",    "formImageUrl": "string"  }}
PATCH/api/v2/templates/{templateId}/utm-links/{id}

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Path Parameters

templateId*string
id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PATCH "https://example.com/api/v2/templates/string/utm-links/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "responseId": "ed662de2-39c1-4e7d-a6bf-6980511adfaf",  "createdAt": "2019-08-24T14:15:22Z",  "code": 0,  "data": {    "id": 0,    "templateId": 0,    "type": "string",    "name": "string",    "utmSource": "string",    "shortLink": "string",    "welcomeBonusesNumber": 0,    "welcomeStampsNumber": 0,    "welcomeExpiryPeriodInUnits": 0,    "welcomeExpiryPeriodUnits": "string",    "formTitle": "string",    "formImageUrl": "string"  }}
DELETE/api/v2/templates/{templateId}/utm-links/{id}

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Path Parameters

templateId*string
id*string

Response Body

application/json

curl -X DELETE "https://example.com/api/v2/templates/string/utm-links/string"
{  "responseId": "ed662de2-39c1-4e7d-a6bf-6980511adfaf",  "createdAt": "2019-08-24T14:15:22Z",  "code": 0,  "data": {    "id": 0  }}

Tarjetas

Las tarjetas emitidas a cada cliente: acreditar compras, sumar sellos o puntos, canjear premios y consultar saldo.

Clientes

Tu base de clientes: alta, consulta y actualización de datos.