logo
enes

HTTP connection

Last update: 5 hours ago by Irais Aguirre

HTTP request, headers and body to send an email.


URL testing<To be defined>/broadcaster-endpoint-web/services/mailing/sendMail
URL production<To be defined>/services/mailing/sendMail
MethodPOST
Typeapplication/json

Headers


NameDescriptionValue
Content-TypeContent type of the request.application/json
authorizationHash of the account username and password.Provided by Concepto Móvil.

Parameters


NameDescriptionTypeRequirements
apiKeyClient identifier.Number
  • Required.
mailFromUsername of the sender email address.String
  • Required.
  • Maximum 255 characters.
  • E.g.: for the email "marketing@empresa.com", specify only "marketing".
mailFromNameSender name.String
  • Maximum 255 characters.
  • "," (comma) and ";" (semicolon) are not allowed.
toRecipient.Destination[]
  • Required.
subjectEmail subject.String
  • Maximum 100 characters.
templateIdIdentifier of the email template to use.Number
  • Required.
dataObject with arbitrary properties that are assigned a value; these values are of type String. The properties correspond to placeholders in the template that will be replaced by the corresponding value.Object
  • Maximum 100 properties.
  • Maximum combined size of all values: 5 KB.
mailTypeIndicates whether the email is marketing or transactional.Number
  • Required
  • 1: Marketing
  • 2: Transactional
campaignIdCampaign to associate the email with.Number
  • Required if mailType is 1
Mail — Previous
Email sending
Next — Mail
Objects