Get published email template parameters
/v1/email/templates/{template_ref}/parametersconst discovery = await bird.email.templates.parameters(
"emt_01krdgeqcxet5s7t44vh8rt9mg",
);
console.log(discovery.parameters, discovery.variables);discovery = client.email.templates.parameters("emt_01krdgeqcxet5s7t44vh8rt9mg")
print(discovery.parameters, discovery.variables)discovery, err := client.Email.Templates.Parameters(context.Background(), "emt_01krdgeqcxet5s7t44vh8rt9mg", bird.EmailTemplatesParametersParams{})
if err != nil {
log.Fatal(err)
}
fmt.Println(discovery.Parameters, discovery.Variables)$discovery = $bird->email->templates->parameters('emt_01krdgeqcxet5s7t44vh8rt9mg');
echo json_encode($discovery->getParameters()), json_encode($discovery->getVariables());bird email templates parameters <template-ref>curl -X GET "https://us1.platform.bird.com/v1/email/templates/{template_ref}/parameters" \
-H "Authorization: Bearer $TOKEN"{
"template_id": "emt_01krdgeqcxet5s7t44vh8rt9mg",
"observed_version_id": "emv_01krdgeqcxet5s7t44vh8rt9mg",
"requested_language": "pt-BR",
"effective_language": "pt-BR",
"parameters": [
{
"name": "offer",
"type": "text",
"value_domain": "scalar",
"use_constraints": [
{
"kind": "value",
"site": "html"
}
]
}
],
"variables": [
{
"path": "bird.contact.first_name",
"source": "contact",
"use_constraints": [
{
"kind": "value",
"site": "html"
}
]
}
]
}
Get the parameters and variables used by the template's published content in one language. The result describes the template and holds no saved values. Parameters are the names a broadcast supplies in template.parameters, and variables are the bird. references Bird fills in. The result identifies list values, which broadcast parameters cannot supply. It also includes a fingerprint that identifies the published content without exposing contact values. You cannot select an older template version. Requires email_marketing read permission in addition to email_management read. Parameter sites cover template subject, HTML and text; envelope overrides are checked by broadcast validation.
पैरामीटर
template_refstringWorkspace template ID, workspace template slug, or built-in template slug.
Query पैरामीटर
languagestringLanguage of the template's published content. Omission uses the template's default language.
Response Payload
template_idThe template that was read.
observed_version_idThe published template version that was read.
requested_languageThe language requested with language. Absent when none was requested and the published version's default language is used.
effective_languageThe language whose content was read.
requirements_fingerprintAn opaque value that changes when this content or the parameters and variables it uses change, including for built-in templates whose version ID stays the same. Compare it with an earlier value to tell whether they are still the same. Do not parse it.
parametersThe parameters the broadcast supplies, sorted by name.
variablesThe bird. variables Bird fills in, sorted by path.
चाइल्ड एट्रिब्यूट दिखाएँ
variables.pathThe variable as the template writes it, such as bird.contact.first_name.
variables.sourceWhere Bird takes the value of a bird. variable from.
contact: a property of the recipient contact, read frombird.contact..bird: another value Bird fills in when it sends, such asbird.unsubscribe_url.
Possible values (may grow over time): contact, bird
variables.source_typeThe type of the contact property, from this workspace's current contact property definitions, such as string. Absent when the variable is not a defined contact property.
variables.use_constraintsEach place the content uses the variable.
चाइल्ड एट्रिब्यूट दिखाएँ
variables.use_constraints.kindHow the template uses a parameter or variable at one place in its content.
value: the template outputs or compares the value.iterable: the template loops over the value.
Possible values (may grow over time): value, iterable
variables.use_constraints.siteThe part of the published content where a parameter or variable is used.
subject: the subject line.html: the HTML body, including its inbox preview text.text: the plain-text body.
Possible values (may grow over time): subject, html, text
variables.use_constraints.pathThe parameter or variable path the template reads at this place, such as offer or bird.contact.first_name.
variables.use_constraints.operationHow the template uses the parameter or variable here, passed through from the template. output means it writes the value; other values name the Liquid tag that reads it, such as if, case, for or assign.
संबंधित संसाधन
इस विषय के लिए दस्तावेज़, गाइड और उदाहरणों के साथ आगे बढ़ें।