Skip to content

ReachTemplatesApi.md

Latest commit

 

History

History
103 lines (68 loc) · 3.82 KB

ReachTemplatesApi.md

File metadata and controls

103 lines (68 loc) · 3.82 KB
Raw

Hostinger\ReachTemplatesApi

All URIs are relative to https://developers.hostinger.com, except if the operation defines another base path.

Method HTTP request Description
createAnEmailTemplateV1() POST /api/reach/v1/profiles/{profileUuid}/templates Create an email template
listEmailTemplatesV1() GET /api/reach/v1/profiles/{profileUuid}/templates List email templates

createAnEmailTemplateV1()

createAnEmailTemplateV1($profileUuid, $reachV1TemplatesStoreRequest): \Hostinger\Model\ReachV1TemplatesTemplateResource

Create an email template

Create an email template in a profile. The template holds the HTML body a campaign reuses, so it can be created before any campaign exists. Only the template metadata comes back - keep the returned uuid to reference it as the template_uuid of a campaign.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: apiToken
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Hostinger\Api\ReachTemplatesApi(config: $config);
$profileUuid = 550e8400-e09b-41d4-a716-400055000000; // string | Profile uuid parameter
$reachV1TemplatesStoreRequest = new \Hostinger\Model\ReachV1TemplatesStoreRequest(); // \Hostinger\Model\ReachV1TemplatesStoreRequest

try {
    $result = $apiInstance->createAnEmailTemplateV1($profileUuid, $reachV1TemplatesStoreRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReachTemplatesApi->createAnEmailTemplateV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
profileUuid string Profile uuid parameter
reachV1TemplatesStoreRequest \Hostinger\Model\ReachV1TemplatesStoreRequest

Return type

\Hostinger\Model\ReachV1TemplatesTemplateResource

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listEmailTemplatesV1()

listEmailTemplatesV1($profileUuid): \Hostinger\Model\ReachV1TemplatesTemplateResource[]

List email templates

Get a list of the email templates in a profile, most recently updated first. Templates are the reusable email bodies a campaign is built from. The list is not paginated and only the metadata is returned - the template content itself is not exposed. Use the uuid of a template as the template_uuid when creating a campaign.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: apiToken
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Hostinger\Api\ReachTemplatesApi(config: $config);
$profileUuid = 550e8400-e09b-41d4-a716-400055000000; // string | Profile uuid parameter

try {
    $result = $apiInstance->listEmailTemplatesV1($profileUuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReachTemplatesApi->listEmailTemplatesV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
profileUuid string Profile uuid parameter

Return type

\Hostinger\Model\ReachV1TemplatesTemplateResource[]

[Back to top] [Back to API list] [Back to Model list] [Back to README]