Back to SuperOfficeCreates a new ShipmentMessageEntity
Calls the Marketing agent service SaveShipmentMessageEntity.
Input
type: object
properties:
parameters:
type: object
properties:
newEntity:
description: "A shipment message, that contains the actual message being sent out in a mailing\r\n<para />\r\nCarrier object for ShipmentMessageEntity.\r\nServices for the ShipmentMessageEntity Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IMarketingAgent\">Marketing Agent</see>."
type: object
properties:
ShipmentMessageId:
format: int32
description: Primary key
type: integer
PlainMessage:
description: Plain message text of this message
type: string
HtmlMessage:
description: HTML formatted text of this message
type: string
SmsMessage:
description: SMS version of this message
type: string
Description:
description: Describes this message
type: string
Subject:
description: The mail subject field of the message
type: string
FolderId:
format: int32
description: >-
The folder which this message belongs to. -1 indicates that the
message is on the root
type: integer
HeaderField:
description: Extra header fields added to mail. Must be formatted correctly
type: string
Design:
description: >-
Will contain the design part of a message. The format will vary
based on the type of designer used to create the message
type: string
Designtype:
description: Enum containing the type of the design
enum:
- Unknown
- SOEditor
- Unlayer
type: string
Flags:
description: Identifies if HTML or plain message is included in message.
enum:
- Plain
- Html
- SourceView
- Sms
- Document
type: string
RegisterViews:
description: Register message views?
type: boolean
InlineImages:
description: Should images be included inline?
type: boolean
LongDescription:
description: A field for a long description of this template
type: string
AccessKey:
description: Key used for access verification
type: string
DocumentMessage:
format: int32
description: The SM document used as template for this mailing
type: integer
Registered:
format: date-time
description: Registered when in UTC.
type: string
RegisteredAssociateId:
format: int32
description: Registered by whom
type: integer
Updated:
format: date-time
description: Last updated when in UTC.
type: string
UpdatedAssociateId:
format: int32
description: Last updated by whom
type: integer
UpdatedCount:
format: int32
description: Number of updates made to this record
type: integer
TableRight:
type: object
properties:
Mask:
enum:
- None
- Select
- Update
- Insert
- Delete
- Filtering
- RestrictedUpdate
- Unused1
- Uninitialized
- FULL
- WRITE
- URU
- UDR
- UR
- URI
- R
- RI
- RF
- F
- FI
type: string
Reason:
type: string
FieldProperties:
type: object
additionalProperties:
type: object
properties:
FieldRight:
type: object
properties:
Mask:
enum:
- None
- Read
- Write
- Update
- Unused1
- Unused2
- Unused3
- Unused4
- Nullable
- UIHintMandatory
- UIHintReadOnly
- FULL
- UIHints
type: string
Reason:
type: string
FieldType:
type: string
FieldLength:
format: int32
type: integer
$select:
type: string
description: >-
Optional comma separated list of properties to include in the result.
Other fields are then nulled out to reduce payload size:
"Name,department,category" Default = show all fields.
Accept-Language:
type: string
description: >-
Convert string references and multi-language values into a specified
language (iso2) code.
SO-Language:
type: string
description: >-
Convert string references and multi-language values into a specified
language (iso2) code. Overrides Accept-Language value.
SO-Culture:
type: string
description: >-
Number, date formatting in a specified culture (iso2 language) code.
Partially overrides SO-Language/Accept-Language value. Ignored if no
Language set.
SO-TimeZone:
type: string
description: >-
Specify the timezone code that you would like date/time responses
converted to.
SO-AppToken:
type: string
description: >-
The application token that identifies the partner app. Used when
calling Online WebAPI from a server.
required:
- newEntity
title: Parameters