Text
https://api.repliq.co/v2/launchTemplateRequirements
On each request you need to provide your Bearer authentication token. See the Authentication section for more details.
| Authorization | Bearer Token |
|---|---|
| Token | <token> |
POST /launchTemplate
This API call launch a request to generate emails copy/personalized lines/ps... from a "Ai Email" RepliQ template. See RepliQ dashboard (opens in a new tab) about the options you have access for this type of template.
Mandatory Parameters
On each request, this endpoint requires the following parameters:
| Parameters | Type | Description |
|---|---|---|
| templateId | string | The id of the template you want to use. Id can be found on here (opens in a new tab) |
| url | string | The url of the website you want to use to create personalized text. |
| firstName | string | The name of the person you create personalized text for |
| companyName | string | The name of the company you create personalized text for |
| custom | string | An additional specific variable you can use to create personalized text |
Optional Parameters
Here is the list of optional parameters you can use with this endpoint to control the personalized lines generation:
| Parameters | Type | Description |
|---|---|---|
| string | The account email you want to send those personalized lines to. | |
| webhook | string | Attach a webhook url that will trigger when the personalized lines are ready for you to use. You cannot use multiple url. Zapier, make or pabbly webhooks are automaticaly added, so no need to include them in the request. |
Response Parameters
Depending of the traffic, personalized lines gets generated in around 1min. Following is the list of parameters you will receive in the response if you get a 200 status code:
| Parameters | Type | Description |
|---|---|---|
| id | string | The id of the personalized lines that are being generated |
| placeholder | object | Various data that you can use as placeholder before the personalized lines are ready for you to use as well as data you provided when doing your personalized text |
Inside the placeholder object you will receive:
| Parameters | Type | Description |
|---|---|---|
| status | string | The status of the personalized text, "pending" meaning that the text are in the creation process |
| date | string | The date when the personalized text process started |
| originUrl | string | The originUrl you use for your personalized text |
| firstName | string | The firstName you use for your personalized text |
| companyName | string | The companyName you use for your personalized text |
| custom | string | The custom variable you use for your personalized text |
| string | The email you use for your personalized text | |
| type | string | To help you filter automation, this variable will always be equal to "email" |
| templateName | string | To help you filter automation, this variable will always be equal to your selected template name |
Webhook Response Parameters
If you have attached a webhook url to your request OR you are using Zapier / Make or Pabbly automation trigger, you will receive the following response on a successfull request:
| Parameters | Type | Description |
|---|---|---|
| id | string | The id of your process |
| fullRepliqEmail | string | The result text that was generated for you |
| status | string | The status of the process, "pending" meaning that the personalized text is in the creation process |
| date | string | The date when the personalized text process started |
| originUrl | string | The url you used for your personalized text |
| firstName | string | The firstname you used for your personalized text |
| companyName | string | The companyName you used for your personalized text |
| custom | string | The custom variable you used for your personalized text |
| string | The email you used for your your personalized text | |
| type | string | To help you filter automation, this variable will always be equal to "email" |
| templateName | string | To help you filter automation, this variable will always be equal to your selected template name |