Productos compatibles
Productos compatibles
Ámbitos Requeridos
Ámbitos Requeridos
content
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
Response
successful operation
A marketing email
El asunto del correo.
"My subject"
Data structure representing the from fields on the email.
El ID del correo.
"38175169118"
El estado del correo.
AUTOMATED
, AUTOMATED_DRAFT
, AUTOMATED_SENDING
, AUTOMATED_FOR_FORM
, AUTOMATED_FOR_FORM_BUFFER
, AUTOMATED_FOR_FORM_DRAFT
, AUTOMATED_FOR_FORM_LEGACY
, 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
, AUTOMATED_AB
, AUTOMATED_AB_VARIANT
, AUTOMATED_DRAFT_AB
, AUTOMATED_DRAFT_ABVARIANT
, AUTOMATED_LOSER_ABVARIANT
, AGENT_GENERATED
"DRAFT"
El nombre del correo, tal y como aparece en el panel de correo.
"My subject"
La subcategoría del correo.
"batch"
Data structure representing the content of the email.
Data structure representing the to fields of the email.
Determina si el correo se enviará inmediatamente después de la publicación.
true
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.
"2020-11-30T18:44:20.387+00:00"
Devuelve si el correo es transaccional o no. Esto es de solo lectura.
false
af
, af-na
, af-za
, agq
, agq-cm
, ak
, ak-gh
, am
, am-et
, 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
, asa
, asa-tz
, ast
, ast-es
, as-in
, az
, az-az
, bas
, bas-cm
, be
, bem
, bem-zm
, bez
, bez-tz
, be-by
, bg
, bgc
, bgc-in
, bg-bg
, bho
, bho-in
, bm
, bm-ml
, bn
, bn-bd
, bn-in
, bo
, bo-cn
, bo-in
, br
, brx
, brx-in
, br-fr
, bs
, bs-ba
, ca
, ca-ad
, ca-es
, ca-fr
, ca-it
, ccp
, ccp-bd
, ccp-in
, ce
, ceb
, ceb-ph
, ce-ru
, cgg
, cgg-ug
, chr
, chr-us
, ckb
, ckb-iq
, ckb-ir
, cs
, cs-cz
, cu
, cu-ru
, cv
, cv-ru
, cy
, cy-gb
, da
, dav
, dav-ke
, da-dk
, da-gl
, 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
, 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-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-gu
, en-gy
, en-hk
, en-ie
, en-il
, en-im
, en-in
, en-io
, 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-nr
, en-nu
, en-nz
, en-pg
, en-ph
, en-pk
, en-pn
, en-pr
, en-pw
, en-rw
, en-sb
, en-sc
, en-sd
, en-se
, en-sg
, en-sh
, en-si
, en-sl
, en-ss
, en-sx
, en-sz
, en-tc
, 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-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
, fil
, fil-ph
, fi-fi
, fo
, fo-dk
, fo-fo
, fr
, frr
, frr-de
, 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
, fur
, fur-it
, fy
, fy-nl
, ga
, ga-gb
, ga-ie
, gd
, gd-gb
, gl
, gl-es
, gsw
, gsw-ch
, gsw-fr
, gsw-li
, gu
, guz
, guz-ke
, gu-in
, gv
, gv-im
, ha
, haw
, haw-us
, ha-gh
, ha-ne
, ha-ng
, he
, he-il
, hi
, hi-in
, hr
, hr-ba
, hr-hr
, hsb
, hsb-de
, hu
, hu-hu
, hy
, hy-am
, ia
, ia-001
, id
, ig
, ig-ng
, ii
, ii-cn
, id-id
, is
, is-is
, it
, it-ch
, it-it
, it-sm
, it-va
, ja
, ja-jp
, jgo
, jgo-cm
, yi
, yi-001
, jmc
, jmc-tz
, jv
, jv-id
, ka
, kab
, kab-dz
, kam
, kam-ke
, ka-ge
, kde
, kde-tz
, kea
, kea-cv
, kgp
, kgp-br
, khq
, khq-ml
, ki
, ki-ke
, kk
, kkj
, kkj-cm
, kk-kz
, kl
, kln
, kln-ke
, kl-gl
, km
, km-kh
, kn
, kn-in
, ko
, kok
, kok-in
, ko-kp
, ko-kr
, ks
, ksb
, ksb-tz
, ksf
, ksf-cm
, ksh
, ksh-de
, ks-in
, ku
, ku-tr
, kw
, kw-gb
, ky
, ky-kg
, lag
, lag-tz
, lb
, lb-lu
, lg
, lg-ug
, lkt
, lkt-us
, ln
, ln-ao
, ln-cd
, ln-cf
, ln-cg
, lo
, lo-la
, lrc
, lrc-iq
, lrc-ir
, lt
, lt-lt
, lu
, luo
, luo-ke
, luy
, luy-ke
, lu-cd
, lv
, lv-lv
, mai
, mai-in
, mas
, mas-ke
, mas-tz
, mdf
, mdf-ru
, mer
, mer-ke
, mfe
, mfe-mu
, mg
, mgh
, mgh-mz
, mgo
, mgo-cm
, mg-mg
, mi
, mi-nz
, mk
, mk-mk
, ml
, ml-in
, mn
, mni
, mni-in
, mn-mn
, mr
, mr-in
, ms
, ms-bn
, ms-id
, ms-my
, ms-sg
, mt
, mt-mt
, mua
, mua-cm
, my
, my-mm
, mzn
, mzn-ir
, naq
, naq-na
, nb
, nb-no
, nb-sj
, nd
, nds
, nds-de
, nds-nl
, nd-zw
, ne
, ne-in
, ne-np
, nl
, nl-aw
, nl-be
, nl-bq
, nl-ch
, nl-cw
, nl-lu
, nl-nl
, nl-sr
, nl-sx
, nmg
, nmg-cm
, nn
, nnh
, nnh-cm
, nn-no
, no
, no-no
, nus
, nus-ss
, nyn
, nyn-ug
, oc
, oc-es
, oc-fr
, om
, om-et
, om-ke
, or
, or-in
, os
, os-ge
, os-ru
, pa
, pa-in
, pa-pk
, pcm
, pcm-ng
, 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
, rof
, rof-tz
, ro-md
, ro-ro
, ru
, ru-by
, ru-kg
, ru-kz
, ru-md
, ru-ru
, ru-ua
, rw
, rwk
, rwk-tz
, rw-rw
, sa
, sah
, sah-ru
, saq
, saq-ke
, sat
, sat-in
, sa-in
, sbp
, sbp-tz
, sc
, sc-it
, sd
, sd-in
, sd-pk
, se
, seh
, seh-mz
, ses
, ses-ml
, se-fi
, se-no
, se-se
, sg
, sg-cf
, shi
, shi-ma
, si
, si-lk
, sk
, sk-sk
, sl
, sl-si
, 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
, su
, su-id
, sv
, sv-ax
, sv-fi
, sv-se
, sw
, sw-cd
, sw-ke
, sw-tz
, sw-ug
, sy
, ta
, ta-in
, ta-lk
, ta-my
, ta-sg
, te
, teo
, teo-ke
, teo-ug
, te-in
, tg
, tg-tj
, th
, th-th
, ti
, ti-er
, ti-et
, tk
, tk-tm
, tl
, to
, tok
, tok-001
, to-to
, tr
, tr-cy
, tr-tr
, tt
, tt-ru
, twq
, twq-ne
, tzm
, tzm-ma
, ug
, ug-cn
, uk
, uk-ua
, ur
, ur-in
, ur-pk
, uz
, uz-af
, uz-uz
, vai
, vai-lr
, vi
, vi-vn
, vo
, vo-001
, vun
, vun-tz
, wae
, wae-ch
, wo
, wo-sn
, xh
, xh-za
, xog
, xog-ug
, yav
, yav-cm
, yo
, yo-bj
, yo-ng
, yrl
, yrl-br
, yrl-co
, yrl-ve
, yue
, yue-cn
, yue-hk
, zgh
, zgh-ma
, zh
, zh-cn
, zh-hans
, zh-hant
, zh-hk
, zh-mo
, zh-sg
, zh-tw
, zu
, zu-za
"en"
El tipo de correo, esto se deriva de otras propiedades del correo como la subcategoría.
AB_EMAIL
, BATCH_EMAIL
, LOCALTIME_EMAIL
, AUTOMATED_AB_EMAIL
, BLOG_EMAIL
, BLOG_EMAIL_CHILD
, RSS_EMAIL
, RSS_EMAIL_CHILD
, RESUBSCRIBE_EMAIL
, OPTIN_EMAIL
, OPTIN_FOLLOWUP_EMAIL
, AUTOMATED_EMAIL
, FEEDBACK_CES_EMAIL
, FEEDBACK_CUSTOM_EMAIL
, FEEDBACK_CUSTOM_SURVEY_EMAIL
, FEEDBACK_NPS_EMAIL
, FOLLOWUP_EMAIL
, LEADFLOW_EMAIL
, SINGLE_SEND_API
, MARKETING_SINGLE_SEND_API
, SMTP_TOKEN
, TICKET_EMAIL
, MEMBERSHIP_REGISTRATION_EMAIL
, MEMBERSHIP_PASSWORD_SAVED_EMAIL
, MEMBERSHIP_PASSWORD_RESET_EMAIL
, MEMBERSHIP_EMAIL_VERIFICATION_EMAIL
, MEMBERSHIP_PASSWORDLESS_AUTH_EMAIL
, MEMBERSHIP_REGISTRATION_FOLLOW_UP_EMAIL
, MEMBERSHIP_OTP_LOGIN_EMAIL
, MEMBERSHIP_FOLLOW_UP_EMAIL
, MEMBERSHIP_VERIFICATION_EMAIL
"BATCH_EMAIL"
La fecha y hora de la creación del correo, en formato ISO8601.
"2020-11-30T18:43:17.136+00:00"
El ID del usuario que creó el correo.
"3739732"
La fecha y hora de la última actualización del correo, en formato ISO8601.
"2020-11-30T18:44:20.384+00:00"
El ID del correo del que se clonó este correo.
"3817552341"
RSS related data if it is a blog or rss email.
La fecha y hora de la publicación del correo, en formato ISO8601.
El ID del usuario que publicó el correo.
AB testing related data. This property is only returned for AB type emails.
El ID del usuario que actualizó el correo por última vez.
"3739732"
La fecha y hora de la eliminación del correo, en formato ISO8601.
El GUID de la campaña en el correo.
"1b7f51a6-33c1-44d6-ba28-fe81f655dced"
El ID de la encuesta de comentarios vinculada al correo.
Correo del usuario que publicó/envió el correo.
Nombres de los workflows en los que se utiliza el correo dentro de una acción "enviar correo".
Determina si el correo se archiva o no.
false
Nombre del usuario que publicó el correo.
Lista de emailCampaignIds.
DESIGN_MANAGER
, DRAG_AND_DROP
Devuelve el estado de publicación del correo. Esto es de solo lectura.
false
Data structure representing the subscription fields of the email.
El dominio activo del correo.
"test.hs-sites.com"
El nombre de la campaña.