> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.es/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Get the details of a specified marketing email
> Obtén los detalles de un correo de marketing.
export const ScopesList = ({scopes = [], description = "Esta API requiere uno de los siguientes ámbitos:"}) => {
if (!scopes || scopes.length === 0) {
return null;
}
const sortedScopes = scopes.sort((a, b) => a.localeCompare(b));
return
{description}
{sortedScopes.map((scope, index) =>
{scope}
)}
;
};
export const SupportedProducts = ({marketing, sales, service, cms, marketingLevel, salesLevel, serviceLevel, cmsLevel}) => {
const translations = {
header: "Productos compatibles",
description: "Se requiere uno de los siguientes productos o productos de ediciones superiores.",
productNames: {
marketing: "Marketing Hub",
sales: "Sales Hub",
service: "Service Hub",
cms: "Content Hub"
},
tiers: {
free: "Gratuito",
starter: "Starter",
professional: "Pro",
enterprise: "Enterprise"
}
};
const translateTier = tier => {
if (!tier) return '';
const lowerTier = tier.toLowerCase();
return translations.tiers[lowerTier] || tier;
};
const products = [{
name: marketing ? translations.productNames.marketing : '',
level: translateTier(marketingLevel),
icon: "https://mintlify-assets.b-cdn.net/Icons/marketing-bolt.svg",
alt: "Marketing Hub"
}, {
name: sales ? translations.productNames.sales : '',
level: translateTier(salesLevel),
icon: "https://mintlify-assets.b-cdn.net/Icons/sales-star.svg",
alt: "Sales Hub"
}, {
name: service ? translations.productNames.service : '',
level: translateTier(serviceLevel),
icon: "https://mintlify-assets.b-cdn.net/Icons/service-heart.svg",
alt: "Service Hub"
}, {
name: cms ? translations.productNames.cms : '',
level: translateTier(cmsLevel),
icon: "https://mintlify-assets.b-cdn.net/Icons/content-play.svg",
alt: "Content Hub"
}].filter(product => product.name && product.level);
if (products.length === 0) return null;
return
{translations.description}
{products.map((product, index) =>
{product.name} -
{product.level}
)}
;
};
## OpenAPI
````yaml specs/legacy/v3/marketing-marketing-emails-v3.json GET /marketing/v3/emails/{emailId}
openapi: 3.0.1
info:
title: Correos de marketing
version: v3
x-hubspot-product-tier-requirements:
marketing: FREE
sales: FREE
service: FREE
cms: FREE
commerce: FREE
crmHub: FREE
dataHub: FREE
x-hubspot-api-use-case: >-
Deseas crear correos de marketing de forma programática para luego recuperar
sus estadísticas de envío más adelante.
x-hubspot-related-documentation:
- name: Marketing Emails Guide
url: >-
https://developers.hubspot.com/docs/guides/api/marketing/emails/marketing-emails
x-hubspot-introduction: >-
Usa la API de correo de marketing para crear, gestionar y recuperar detalles
sobre los correos de marketing. También puedes usar esta API para recuperar
estadísticas relacionadas con los envíos de correo, similares a las que
puedes ver en HubSpot.
servers:
- url: https://api.hubapi.com
security: []
tags:
- name: Basic
- name: Emails
paths:
/marketing/v3/emails/{emailId}:
get:
tags:
- Emails
summary: Obtener los detalles de un correo de marketing especificado
description: Obtén los detalles de un correo de marketing.
operationId: get-/marketing/v3/emails/{emailId}_getById
parameters:
- name: emailId
in: path
description: El ID del correo de marketing.
required: true
style: simple
explode: false
schema:
type: string
- name: archived
in: query
description: Si se devolverán solo los resultados que se han archivado.
required: false
style: form
explode: true
schema:
type: boolean
- name: includedProperties
in: query
description: ''
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: includeStats
in: query
description: Incluir estadísticas con correo
required: false
style: form
explode: true
schema:
type: boolean
- name: marketingCampaignNames
in: query
description: ''
required: false
style: form
explode: true
schema:
type: boolean
- name: variantStats
in: query
description: ''
required: false
style: form
explode: true
schema:
type: boolean
- name: workflowNames
in: query
description: ''
required: false
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/PublicEmail'
default:
$ref: '#/components/responses/Error'
description: ''
security:
- oauth2:
- content
components:
schemas:
PublicEmail:
required:
- isAb
type: object
properties:
activeDomain:
type: string
description: El dominio activo del correo.
allEmailCampaignIds:
type: array
description: Lista de emailCampaignIds.
items:
type: string
archived:
type: boolean
description: Determina si el correo se archiva o no.
businessUnitId:
type: string
campaign:
type: string
description: El ID de la campaña con la que está asociado este correo.
campaignName:
type: string
description: El nombre de la campaña.
campaignUtm:
type: string
clonedFrom:
type: string
description: El ID del correo del que se clonó este correo.
content:
$ref: '#/components/schemas/PublicEmailContent'
createdAt:
type: string
description: La fecha y hora de la creación del correo, en formato ISO8601.
format: date-time
createdById:
type: string
description: El ID del usuario que creó el correo.
deletedAt:
type: string
description: La fecha y hora de la eliminación del correo, en formato ISO8601.
format: date-time
emailCampaignGroupId:
type: string
emailTemplateMode:
type: string
enum:
- DESIGN_MANAGER
- DRAG_AND_DROP
feedbackSurveyId:
type: string
description: El ID de la encuesta de comentarios vinculada al correo.
folderId:
type: integer
format: int64
folderIdV2:
type: integer
format: int64
from:
$ref: '#/components/schemas/PublicEmailFromDetails'
id:
type: string
description: El ID del correo.
isAb:
type: boolean
isPublished:
type: boolean
description: >-
Devuelve el estado de publicación del correo. Esto es de solo
lectura.
isTransactional:
type: boolean
description: >-
Devuelve si el correo es transaccional o no. Esto es de solo
lectura.
jitterSendTime:
type: boolean
language:
type: string
enum:
- aa
- ab
- ae
- af
- af-na
- af-za
- agq
- agq-cm
- ak
- ak-gh
- am
- am-et
- an
- ann
- ann-ng
- ar
- ar-001
- ar-ae
- ar-bh
- ar-dj
- ar-dz
- ar-eg
- ar-eh
- ar-er
- ar-il
- ar-iq
- ar-jo
- ar-km
- ar-kw
- ar-lb
- ar-ly
- ar-ma
- ar-mr
- ar-om
- ar-ps
- ar-qa
- ar-sa
- ar-sd
- ar-so
- ar-ss
- ar-sy
- ar-td
- ar-tn
- ar-ye
- as
- as-in
- asa
- asa-tz
- ast
- ast-es
- av
- ay
- az
- az-az
- ba
- bal
- bal-pk
- bas
- bas-cm
- be
- be-by
- bem
- bem-zm
- bez
- bez-tz
- bg
- bg-bg
- bgc
- bgc-in
- bho
- bho-in
- bi
- blo
- blo-bj
- bm
- bm-ml
- bn
- bn-bd
- bn-in
- bo
- bo-cn
- bo-in
- br
- br-fr
- brx
- brx-in
- bs
- bs-ba
- ca
- ca-ad
- ca-es
- ca-fr
- ca-it
- ccp
- ccp-bd
- ccp-in
- ce
- ce-ru
- ceb
- ceb-ph
- cgg
- cgg-ug
- ch
- chr
- chr-us
- ckb
- ckb-iq
- ckb-ir
- co
- cr
- cs
- cs-cz
- csw
- csw-ca
- cu
- cu-ru
- cv
- cv-ru
- cy
- cy-gb
- da
- da-dk
- da-gl
- dav
- dav-ke
- de
- de-at
- de-be
- de-ch
- de-de
- de-gr
- de-it
- de-li
- de-lu
- dje
- dje-ne
- doi
- doi-in
- dsb
- dsb-de
- dua
- dua-cm
- dv
- dyo
- dyo-sn
- dz
- dz-bt
- ebu
- ebu-ke
- ee
- ee-gh
- ee-tg
- el
- el-cy
- el-gr
- en
- en-001
- en-150
- en-ae
- en-ag
- en-ai
- en-as
- en-at
- en-au
- en-bb
- en-be
- en-bi
- en-bm
- en-bs
- en-bw
- en-bz
- en-ca
- en-cc
- en-ch
- en-ck
- en-cm
- en-cn
- en-cx
- en-cy
- en-cz
- en-de
- en-dg
- en-dk
- en-dm
- en-ee
- en-eg
- en-er
- en-es
- en-fi
- en-fj
- en-fk
- en-fm
- en-fr
- en-gb
- en-gd
- en-gg
- en-gh
- en-gi
- en-gm
- en-gs
- en-gu
- en-gy
- en-hk
- en-hu
- en-id
- en-ie
- en-il
- en-im
- en-in
- en-io
- en-it
- en-je
- en-jm
- en-ke
- en-ki
- en-kn
- en-ky
- en-lc
- en-lr
- en-ls
- en-lu
- en-mg
- en-mh
- en-mo
- en-mp
- en-ms
- en-mt
- en-mu
- en-mv
- en-mw
- en-mx
- en-my
- en-na
- en-nf
- en-ng
- en-nl
- en-no
- en-nr
- en-nu
- en-nz
- en-pg
- en-ph
- en-pk
- en-pl
- en-pn
- en-pr
- en-pt
- en-pw
- en-ro
- en-rw
- en-sb
- en-sc
- en-sd
- en-se
- en-sg
- en-sh
- en-si
- en-sk
- en-sl
- en-ss
- en-sx
- en-sz
- en-tc
- en-th
- en-tk
- en-tn
- en-to
- en-tt
- en-tv
- en-tz
- en-ug
- en-um
- en-us
- en-vc
- en-vg
- en-vi
- en-vn
- en-vu
- en-ws
- en-za
- en-zm
- en-zw
- eo
- eo-001
- es
- es-419
- es-ar
- es-bo
- es-br
- es-bz
- es-cl
- es-co
- es-cr
- es-cu
- es-do
- es-ea
- es-ec
- es-es
- es-gq
- es-gt
- es-hn
- es-ic
- es-mx
- es-ni
- es-pa
- es-pe
- es-ph
- es-pr
- es-py
- es-sv
- es-us
- es-uy
- es-ve
- et
- et-ee
- eu
- eu-es
- ewo
- ewo-cm
- fa
- fa-af
- fa-ir
- ff
- ff-bf
- ff-cm
- ff-gh
- ff-gm
- ff-gn
- ff-gw
- ff-lr
- ff-mr
- ff-ne
- ff-ng
- ff-sl
- ff-sn
- fi
- fi-fi
- fil
- fil-ph
- fj
- fo
- fo-dk
- fo-fo
- fr
- fr-be
- fr-bf
- fr-bi
- fr-bj
- fr-bl
- fr-ca
- fr-cd
- fr-cf
- fr-cg
- fr-ch
- fr-ci
- fr-cm
- fr-dj
- fr-dz
- fr-fr
- fr-ga
- fr-gf
- fr-gn
- fr-gp
- fr-gq
- fr-ht
- fr-km
- fr-lu
- fr-ma
- fr-mc
- fr-mf
- fr-mg
- fr-ml
- fr-mq
- fr-mr
- fr-mu
- fr-nc
- fr-ne
- fr-pf
- fr-pm
- fr-re
- fr-rw
- fr-sc
- fr-sn
- fr-sy
- fr-td
- fr-tg
- fr-tn
- fr-vu
- fr-wf
- fr-yt
- frr
- frr-de
- fur
- fur-it
- fy
- fy-nl
- ga
- ga-gb
- ga-ie
- gaa
- gaa-gh
- gd
- gd-gb
- gl
- gl-es
- gn
- gsw
- gsw-ch
- gsw-fr
- gsw-li
- gu
- gu-in
- guz
- guz-ke
- gv
- gv-im
- ha
- ha-gh
- ha-ne
- ha-ng
- haw
- haw-us
- he
- he-il
- hi
- hi-in
- hmn
- ho
- hr
- hr-ba
- hr-hr
- hsb
- hsb-de
- ht
- ht-ht
- hu
- hu-hu
- hy
- hy-am
- hz
- ia
- ia-001
- id
- id-id
- ie
- ie-ee
- ig
- ig-ng
- ii
- ii-cn
- ik
- io
- is
- is-is
- it
- it-ch
- it-it
- it-sm
- it-va
- iu
- ja
- ja-jp
- jgo
- jgo-cm
- jmc
- jmc-tz
- jv
- jv-id
- ka
- ka-ge
- kab
- kab-dz
- kam
- kam-ke
- kar
- kde
- kde-tz
- kea
- kea-cv
- kg
- kgp
- kgp-br
- kh
- khq
- khq-ml
- ki
- ki-ke
- kj
- kk
- kk-kz
- kkj
- kkj-cm
- kl
- kl-gl
- kln
- kln-ke
- km
- km-kh
- kn
- kn-in
- ko
- ko-cn
- ko-kp
- ko-kr
- kok
- kok-in
- kr
- ks
- ks-in
- ksb
- ksb-tz
- ksf
- ksf-cm
- ksh
- ksh-de
- ku
- ku-tr
- kv
- kw
- kw-gb
- kxv
- kxv-in
- ky
- ky-kg
- la
- lag
- lag-tz
- lb
- lb-lu
- lg
- lg-ug
- li
- lij
- lij-it
- lkt
- lkt-us
- lmo
- lmo-it
- ln
- ln-ao
- ln-cd
- ln-cf
- ln-cg
- lo
- lo-la
- lrc
- lrc-iq
- lrc-ir
- lt
- lt-lt
- lu
- lu-cd
- luo
- luo-ke
- luy
- luy-ke
- lv
- lv-lv
- mai
- mai-in
- mas
- mas-ke
- mas-tz
- mdf
- mdf-ru
- mer
- mer-ke
- mfe
- mfe-mu
- mg
- mg-mg
- mgh
- mgh-mz
- mgo
- mgo-cm
- mh
- mi
- mi-nz
- mk
- mk-mk
- ml
- ml-in
- mn
- mn-mn
- mni
- mni-in
- mr
- mr-in
- ms
- ms-bn
- ms-id
- ms-my
- ms-sg
- mt
- mt-mt
- mua
- mua-cm
- my
- my-mm
- mzn
- mzn-ir
- na
- naq
- naq-na
- nb
- nb-no
- nb-sj
- nd
- nd-zw
- nds
- nds-de
- nds-nl
- ne
- ne-in
- ne-np
- ng
- nl
- nl-aw
- nl-be
- nl-bq
- nl-ch
- nl-cw
- nl-lu
- nl-nl
- nl-sr
- nl-sx
- nmg
- nmg-cm
- nn
- nn-no
- nnh
- nnh-cm
- 'no'
- no-no
- nqo
- nqo-gn
- nr
- nso
- nso-za
- nus
- nus-ss
- nv
- ny
- nyn
- nyn-ug
- oc
- oc-es
- oc-fr
- oj
- om
- om-et
- om-ke
- or
- or-in
- os
- os-ge
- os-ru
- pa
- pa-in
- pa-pk
- pcm
- pcm-ng
- pi
- pis
- pis-sb
- pl
- pl-pl
- prg
- prg-001
- ps
- ps-af
- ps-pk
- pt
- pt-ao
- pt-br
- pt-ch
- pt-cv
- pt-gq
- pt-gw
- pt-lu
- pt-mo
- pt-mz
- pt-pt
- pt-st
- pt-tl
- qu
- qu-bo
- qu-ec
- qu-pe
- raj
- raj-in
- rm
- rm-ch
- rn
- rn-bi
- ro
- ro-md
- ro-ro
- rof
- rof-tz
- ru
- ru-by
- ru-kg
- ru-kz
- ru-md
- ru-ru
- ru-ua
- rw
- rw-rw
- rwk
- rwk-tz
- sa
- sa-in
- sah
- sah-ru
- saq
- saq-ke
- sat
- sat-in
- sbp
- sbp-tz
- sc
- sc-it
- sd
- sd-in
- sd-pk
- se
- se-fi
- se-no
- se-se
- seh
- seh-mz
- ses
- ses-ml
- sg
- sg-cf
- shi
- shi-ma
- si
- si-lk
- sk
- sk-sk
- sl
- sl-si
- sm
- smn
- smn-fi
- sms
- sms-fi
- sn
- sn-zw
- so
- so-dj
- so-et
- so-ke
- so-so
- sq
- sq-al
- sq-mk
- sq-xk
- sr
- sr-ba
- sr-cs
- sr-me
- sr-rs
- sr-xk
- ss
- st
- st-ls
- st-za
- su
- su-id
- sv
- sv-ax
- sv-fi
- sv-se
- sw
- sw-cd
- sw-ke
- sw-tz
- sw-ug
- sy
- syr
- syr-iq
- syr-sy
- szl
- szl-pl
- ta
- ta-in
- ta-lk
- ta-my
- ta-sg
- te
- te-in
- teo
- teo-ke
- teo-ug
- tg
- tg-tj
- th
- th-th
- ti
- ti-er
- ti-et
- tk
- tk-tm
- tl
- tn
- tn-bw
- tn-za
- to
- to-to
- tok
- tok-001
- tr
- tr-cy
- tr-tr
- ts
- tt
- tt-ru
- tw
- twq
- twq-ne
- ty
- tzm
- tzm-ma
- ug
- ug-cn
- uk
- uk-ua
- ur
- ur-in
- ur-pk
- uz
- uz-af
- uz-uz
- vai
- vai-lr
- ve
- vec
- vec-it
- vi
- vi-vn
- vmw
- vmw-mz
- vo
- vo-001
- vun
- vun-tz
- wa
- wae
- wae-ch
- wo
- wo-sn
- xh
- xh-za
- xnr
- xnr-in
- xog
- xog-ug
- yav
- yav-cm
- yi
- yi-001
- yi-ua
- yo
- yo-bj
- yo-ng
- yrl
- yrl-br
- yrl-co
- yrl-ve
- yue
- yue-cn
- yue-hk
- yue-mo
- za
- za-cn
- zgh
- zgh-ma
- zh
- zh-cn
- zh-hans
- zh-hant
- zh-hk
- zh-mo
- zh-my
- zh-sg
- zh-tw
- zu
- zu-za
name:
type: string
description: El nombre del correo, tal y como aparece en el panel de correo.
previewKey:
type: string
primaryEmailCampaignId:
type: string
publishDate:
type: string
description: >-
La fecha y hora para la que está programado el correo, en formato
ISO8601. Esto solo se utiliza en la hora local o en correos
programados.
format: date-time
publishedAt:
type: string
description: La fecha y hora de la publicación del correo, en formato ISO8601.
format: date-time
publishedByEmail:
type: string
description: Correo del usuario que publicó/envió el correo.
publishedById:
type: string
description: El ID del usuario que publicó el correo.
publishedByName:
type: string
description: Nombre del usuario que publicó el correo.
rssData:
$ref: '#/components/schemas/PublicRssEmailDetails'
sendOnPublish:
type: boolean
description: >-
Determina si el correo se enviará inmediatamente después de la
publicación.
state:
type: string
description: El estado del correo.
enum:
- AGENT_GENERATED
- AUTOMATED
- AUTOMATED_AB
- AUTOMATED_AB_VARIANT
- AUTOMATED_DRAFT
- AUTOMATED_DRAFT_AB
- AUTOMATED_DRAFT_ABVARIANT
- AUTOMATED_FOR_FORM
- AUTOMATED_FOR_FORM_BUFFER
- AUTOMATED_FOR_FORM_DRAFT
- AUTOMATED_FOR_FORM_LEGACY
- AUTOMATED_LOSER_ABVARIANT
- AUTOMATED_SENDING
- BLOG_EMAIL_DRAFT
- BLOG_EMAIL_PUBLISHED
- DRAFT
- DRAFT_AB
- DRAFT_AB_VARIANT
- ERROR
- LOSER_AB_VARIANT
- PAGE_STUB
- PRE_PROCESSING
- PROCESSING
- PUBLISHED
- PUBLISHED_AB
- PUBLISHED_AB_VARIANT
- PUBLISHED_OR_SCHEDULED
- RSS_TO_EMAIL_DRAFT
- RSS_TO_EMAIL_PUBLISHED
- SCHEDULED
- SCHEDULED_AB
- SCHEDULED_OR_PUBLISHED
stats:
$ref: '#/components/schemas/EmailStatisticsData'
subcategory:
type: string
description: La subcategoría del correo.
subject:
type: string
description: El asunto del correo.
subscriptionDetails:
$ref: '#/components/schemas/PublicEmailSubscriptionDetails'
teamsWithAccess:
type: array
items:
type: string
testing:
$ref: '#/components/schemas/PublicEmailTestingDetails'
to:
$ref: '#/components/schemas/PublicEmailToDetails'
type:
type: string
description: >-
El tipo de correo, esto se deriva de otras propiedades del correo
como la subcategoría.
enum:
- AB_EMAIL
- AUTOMATED_AB_EMAIL
- AUTOMATED_EMAIL
- BATCH_EMAIL
- BLOG_EMAIL
- BLOG_EMAIL_CHILD
- FEEDBACK_CES_EMAIL
- FEEDBACK_CUSTOM_EMAIL
- FEEDBACK_CUSTOM_SURVEY_EMAIL
- FEEDBACK_NPS_EMAIL
- FOLLOWUP_EMAIL
- LEADFLOW_EMAIL
- LOCALTIME_EMAIL
- MANAGE_PREFERENCES_EMAIL
- MARKETING_SINGLE_SEND_API
- MEMBERSHIP_EMAIL_VERIFICATION_EMAIL
- MEMBERSHIP_FOLLOW_UP_EMAIL
- MEMBERSHIP_OTP_LOGIN_EMAIL
- MEMBERSHIP_PASSWORD_RESET_EMAIL
- MEMBERSHIP_PASSWORD_SAVED_EMAIL
- MEMBERSHIP_PASSWORDLESS_AUTH_EMAIL
- MEMBERSHIP_REGISTRATION_EMAIL
- MEMBERSHIP_REGISTRATION_FOLLOW_UP_EMAIL
- MEMBERSHIP_VERIFICATION_EMAIL
- OPTIN_EMAIL
- OPTIN_FOLLOWUP_EMAIL
- RESUBSCRIBE_EMAIL
- RSS_EMAIL
- RSS_EMAIL_CHILD
- SINGLE_SEND_API
- SMTP_TOKEN
- TICKET_EMAIL
unpublishedAt:
type: string
format: date-time
updatedAt:
type: string
description: >-
La fecha y hora de la última actualización del correo, en formato
ISO8601.
format: date-time
updatedById:
type: string
description: El ID del usuario que actualizó el correo por última vez.
usersWithAccess:
type: array
items:
type: string
webversion:
$ref: '#/components/schemas/PublicWebversionDetails'
workflowNames:
type: array
description: >-
Nombres de los workflows en los que se utiliza el correo dentro de
una acción "enviar correo".
items:
type: string
description: A marketing email
example:
activeDomain: test.hs-sites.com
archived: false
campaign: 1b7f51a6-33c1-44d6-ba28-fe81f655dced
content:
flexAreas:
main:
boxed: false
isSingleColumnFullWidth: false
sections:
- columns:
- id: column_1606761806181_0
widgets:
- module_160676180617911
width: 12
id: section_1606761806181
style:
backgroundColor: ''
backgroundType: CONTENT
- columns:
- id: column-0-1
widgets:
- module-0-1-1
width: 12
id: section-0
style:
backgroundType: CONTENT
paddingBottom: 40px
paddingTop: 40px
- columns:
- id: column-1-1
widgets:
- module-1-1-1
width: 12
id: section-1
style:
backgroundColor: ''
backgroundType: CONTENT
paddingBottom: 0px
paddingTop: 0px
plainTextVersion: >-
This is custom! View in browser ({{view_as_page_url}})
Hello {{ contact.firstname }},
Plain text emails have minimal formatting so your reader can really
focus on what you have to say. Introduce yourself and explain why
you’re reaching out.
Every email should try to lead the reader to some kind of action.
Use this space to describe why the reader should want to click on
the link below. Put the link on its own line to really draw their
eye to it.
Link text
Now it’s time to wrap up your email. Before your signature, thank
the recipient for reading. You can also invite them to send this
email to any of their colleagues who might be interested.
All the best,
Your full name
Your job title
Other contact information
{{site_settings.company_name}},
{{site_settings.company_street_address_1}},
{{site_settings.company_street_address_2}},
{{site_settings.company_city}}, {{site_settings.company_state}}
{{site_settings.company_zip}}, {{site_settings.company_country}},
{{site_settings.company_phone}}
Unsubscribe ({{unsubscribe_link_all}})
Manage preferences ({{unsubscribe_link}})
styleSettings: {}
templatePath: '@hubspot/email/dnd/plain_text.html'
widgets:
module-0-1-1:
body:
css_class: dnd-module
html: >-
Hello {{ contact.firstname
}},
Plain text emails have minimal formatting so your
reader can really focus on what you have to say. Introduce
yourself and explain why you’re reaching out.
Every email should try to lead the
reader to some kind of action. Use this space to describe why
the reader should want to click on the link below. Put the
link on its own line to really draw their eye to it.
Link text
Now it’s time to wrap up your
email. Before your signature, thank the recipient for reading.
You can also invite them to send this email to any of their
colleagues who might be interested.
All the best,
Your full
name
Your job title
Other contact information
i18nKey: richText.plainText
path: '@hubspot/rich_text'
schema_version: 2
child_css: {}
css: {}
id: module-0-1-1
module_id: 1155639
name: module-0-1-1
order: 2
styles: {}
type: module
module-1-1-1:
body:
align: center
css_class: dnd-module
font:
color: '#23496d'
font: Arial, sans-serif
size:
units: px
value: 12
link_font:
color: '#00a4bd'
font: Helvetica,Arial,sans-serif
size:
units: px
value: 12
styles:
bold: false
italic: false
underline: true
path: '@hubspot/email_footer'
schema_version: 2
unsubscribe_link_type: both
child_css: {}
css: {}
id: module-1-1-1
module_id: 2869621
name: module-1-1-1
order: 3
styles: {}
type: module
module_160676180617911:
body:
font:
color: '#00a4bd'
font: Arial, sans-serif
size:
units: px
value: 12
styles:
bold: false
italic: false
underline: true
hs_enable_module_padding: false
hs_wrapper_css: {}
child_css: {}
css: {}
id: module_160676180617911
module_id: 2794854
name: module_160676180617911
styles: {}
type: module
preview_text:
body:
value: ''
child_css: {}
css: {}
id: preview_text
label: >-
Preview Text This will be used as the
preview text that displays in some email clients
name: preview_text
order: 0
styles: {}
type: text
createdAt: '2020-11-30T18:43:17.136Z'
createdById: 3739732
from:
fromName: Bruce Wayne
replyTo: test@hubspot.com
id: '38175169118'
isPublished: false
isTransactional: false
language: en
name: My subject
publishDate: '2020-11-30T18:44:20.387Z'
sendOnPublish: true
state: DRAFT
subcategory: batch
subject: My subject
subscriptionDetails:
officeLocationId: '5449392956'
to:
contactIds: {}
contactIlsLists:
exclude:
- 1
include:
- 5
suppressGraymail: true
type: BATCH_EMAIL
updatedAt: '2020-11-30T18:44:20.384Z'
updatedById: 3739732
webversion:
expiresAt: '2020-11-30T18:44:20.387Z'
metaDescription: ''
redirectToPageId: 0
redirectToUrl: http://www.example.org
PublicEmailContent:
type: object
properties:
flexAreas:
type: object
additionalProperties:
type: object
properties: {}
plainTextVersion:
type: string
smartFields:
type: object
additionalProperties:
$ref: '#/components/schemas/SmartEmailField'
styleSettings:
$ref: '#/components/schemas/PublicEmailStyleSettings'
templatePath:
type: string
themeSettingsValues:
type: object
additionalProperties:
type: object
properties: {}
widgetContainers:
type: object
additionalProperties:
type: object
properties: {}
widgets:
type: object
additionalProperties:
type: object
properties: {}
description: Data structure representing the content of the email.
PublicEmailFromDetails:
type: object
properties:
customReplyTo:
type: string
description: La respuesta que verán los destinatarios.
fromName:
type: string
description: El nombre que verán los destinatarios.
replyTo:
type: string
description: >-
La dirección del remitente y la dirección de respuesta (si no se ha
definido customReplyTo) que verán los destinatarios.
description: Data structure representing the from fields on the email.
PublicRssEmailDetails:
type: object
properties:
blogEmailType:
type: string
blogImageMaxWidth:
type: integer
format: int32
blogLayout:
type: string
enum:
- FULL_POST
- SUMMARY_NO_FEATURED_IMAGE
- SUMMARY_WITH_FEATURED_IMAGE
hubspotBlogId:
type: string
maxEntries:
type: integer
format: int32
rssEntryTemplate:
type: string
timing:
type: object
additionalProperties:
type: object
properties: {}
url:
type: string
useHeadlineAsSubject:
type: boolean
description: RSS related data if it is a blog or rss email.
EmailStatisticsData:
required:
- counters
- deviceBreakdown
- qualifierStats
- ratios
type: object
properties:
counters:
type: object
additionalProperties:
type: integer
format: int64
description: Contadores como el número de "enviados", "abiertos" o "entregados".
deviceBreakdown:
type: object
additionalProperties:
type: object
additionalProperties:
type: integer
format: int64
description: Estadísticas por dispositivo.
qualifierStats:
type: object
additionalProperties:
type: object
additionalProperties:
type: integer
format: int64
description: Número de correos que fueron descartados y rebotados.
ratios:
type: object
additionalProperties:
type: number
description: Índices como `openratio` o `clickratio`
PublicEmailSubscriptionDetails:
type: object
properties:
officeLocationId:
type: string
description: ID de la ubicación de oficina seleccionada.
preferencesGroupId:
type: string
subscriptionId:
type: string
description: ID de la suscripción.
subscriptionName:
type: string
description: Data structure representing the subscription fields of the email.
PublicEmailTestingDetails:
type: object
properties:
abSampleSizeDefault:
type: string
description: >-
Versión del correo que se debe enviar si hay muy pocos destinatarios
para realizar una prueba AB.
enum:
- automated_loser_variant
- automated_master
- automated_variant
- loser_variant
- mab_master
- mab_variant
- master
- variant
abSamplingDefault:
type: string
description: >-
Versión del correo electrónico que debe enviarse si los resultados
son inconclusos después del período de prueba, principal o variante.
enum:
- automated_loser_variant
- automated_master
- automated_variant
- loser_variant
- mab_master
- mab_variant
- master
- variant
abStatus:
type: string
description: Estado de la prueba AB.
enum:
- automated_loser_variant
- automated_master
- automated_variant
- loser_variant
- mab_master
- mab_variant
- master
- variant
abSuccessMetric:
type: string
description: >-
Métrica para determinar la versión que se enviará a los contactos
restantes.
enum:
- CLICKS_BY_DELIVERED
- CLICKS_BY_OPENS
- OPENS_BY_DELIVERED
abTestPercentage:
type: integer
description: El tamaño de tu grupo de prueba.
format: int32
hoursToWait:
type: integer
description: >-
Plazo para recabar los resultados de la prueba. Al terminar ese
plazo, la versión ganadora se enviará a los contactos restantes.
format: int32
isAbVariation:
type: boolean
testId:
type: string
description: El ID de la prueba AB.
description: >-
AB testing related data. This property is only returned for AB type
emails.
PublicEmailToDetails:
type: object
properties:
contactIds:
$ref: '#/components/schemas/PublicEmailRecipients'
contactIlsLists:
$ref: '#/components/schemas/PublicEmailRecipients'
contactLists:
$ref: '#/components/schemas/PublicEmailRecipients'
limitSendFrequency:
type: boolean
suppressGraymail:
type: boolean
description: Si enviar a contactos sin interacciones (falso) o no (verdadero).
description: Data structure representing the to fields of the email.
PublicWebversionDetails:
type: object
properties:
domain:
type: string
enabled:
type: boolean
expiresAt:
type: string
format: date-time
isPageRedirected:
type: boolean
metaDescription:
type: string
pageExpiryEnabled:
type: boolean
redirectToPageId:
type: string
redirectToUrl:
type: string
slug:
type: string
title:
type: string
url:
type: string
Error:
required:
- category
- correlationId
- message
type: object
properties:
category:
type: string
description: La categoría del error
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Contexto de la condición de error
example: >-
{invalidPropertyName=[propertyValue], missingScopes=[scope1,
scope2]}
correlationId:
type: string
description: >-
Un identificador único para la solicitud. Incluye este valor con
cualquier informe de error o ticket de asistencia.
format: uuid
example: aeb5f871-7f07-4993-9211-075dc63e7cbf
errors:
type: array
description: información adicional acerca del error
items:
$ref: '#/components/schemas/ErrorDetail'
links:
type: object
additionalProperties:
type: string
description: >-
Un mapa de nombres de enlaces a las URI asociadas que contienen
documentación sobre el error o los pasos recomendados para
solucionarlo
message:
type: string
description: >-
Un mensaje legible en el que se describa el error y los pasos para
solucionarlo, si procede
example: An error occurred
subCategory:
type: string
description: >-
Una categoría específica que contiene detalles más concretos acerca
del error
example:
message: Invalid input (details will vary based on the error)
correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
category: VALIDATION_ERROR
links:
knowledge-base: https://www.hubspot.com/products/service/knowledge-base
SmartEmailField:
type: object
properties: {}
description: An email field whose value is controlled by one or more smart rules.
PublicEmailStyleSettings:
type: object
properties:
backgroundColor:
type: string
backgroundImage:
type: string
backgroundImageType:
type: string
enum:
- REPEAT
- SINGLE
- STRETCH
bodyBorderColor:
type: string
bodyBorderColorChoice:
type: string
bodyBorderWidth:
type: number
bodyColor:
type: string
buttonStyleSettings:
$ref: '#/components/schemas/PublicButtonStyleSettings'
colorPickerFavorite1:
type: string
colorPickerFavorite2:
type: string
colorPickerFavorite3:
type: string
colorPickerFavorite4:
type: string
colorPickerFavorite5:
type: string
colorPickerFavorite6:
type: string
dividerStyleSettings:
$ref: '#/components/schemas/PublicDividerStyleSettings'
emailBodyPadding:
type: string
emailBodyWidth:
type: string
headingOneFont:
$ref: '#/components/schemas/PublicFontStyle'
headingTwoFont:
$ref: '#/components/schemas/PublicFontStyle'
linksFont:
$ref: '#/components/schemas/PublicFontStyle'
primaryAccentColor:
type: string
primaryFont:
type: string
primaryFontColor:
type: string
primaryFontLineHeight:
type: string
primaryFontSize:
type: number
secondaryAccentColor:
type: string
secondaryFont:
type: string
secondaryFontColor:
type: string
secondaryFontLineHeight:
type: string
secondaryFontSize:
type: number
PublicEmailRecipients:
type: object
properties:
exclude:
type: array
description: Los ID excluidos.
items:
type: string
include:
type: array
description: Los ID incluidos.
items:
type: string
description: >-
Data structure representing lists of IDs that should be included and
excluded.
ErrorDetail:
required:
- message
type: object
properties:
code:
type: string
description: El código de estado asociado al detalle del error
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Contexto de la condición de error
example: '{missingScopes=[scope1, scope2]}'
in:
type: string
description: El nombre del campo o parámetro en el que se encontró el error.
message:
type: string
description: >-
Un mensaje legible en el que se describa el error y los pasos para
solucionarlo, si procede
subCategory:
type: string
description: >-
Una categoría específica que contiene detalles más concretos acerca
del error
PublicButtonStyleSettings:
type: object
properties:
backgroundColor:
type: object
properties: {}
cornerRadius:
type: integer
format: int32
fontStyle:
$ref: '#/components/schemas/PublicFontStyle'
PublicDividerStyleSettings:
type: object
properties:
color:
type: object
properties: {}
height:
type: integer
format: int32
lineType:
type: string
PublicFontStyle:
type: object
properties:
bold:
type: boolean
color:
type: string
font:
type: string
italic:
type: boolean
size:
type: integer
format: int32
underline:
type: boolean
responses:
Error:
description: An error occurred.
content:
'*/*':
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://app.hubspot.com/oauth/authorize
tokenUrl: https://api.hubapi.com/oauth/v1/token
scopes:
content: ''
transactional-email: ''
````