> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SuperOffice.WebApi.Data.ShipmentMessageEntity

# <a id="SuperOffice_WebApi_Data_ShipmentMessageEntity" /> Class ShipmentMessageEntity

Namespace: [SuperOffice.WebApi.Data](SuperOffice.WebApi.Data.md)\
Assembly: SuperOffice.WebApi.dll

Carrier object for ShipmentMessageEntity.
A shipment message, that contains the actual message being sent out in a mailing

```csharp theme={null}
public class ShipmentMessageEntity : Carrier
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[ShipmentMessageEntity](SuperOffice.WebApi.Data.ShipmentMessageEntity.md)

#### Inherited Members

[Carrier.TableRight](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_TableRight),
[Carrier.FieldProperties](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_FieldProperties),
[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring),
[object.Equals(object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object\)),
[object.Equals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object-system-object\)),
[object.ReferenceEquals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone)

## Examples

Get ShipmentMessageEntity 123 using the WebApi client:
<pre><code class="lang-csharp">var configuration = new WebApiConfiguration(url);
var agent = new MarketingAgent(configuration);
var shipmentMessageEntity = agent.GetShipmentMessageEntity( 123 );</code></pre>

## Constructors

### <a id="SuperOffice_WebApi_Data_ShipmentMessageEntity__ctor" /> ShipmentMessageEntity()

Default constructor - defaults any enum props to 0.

```csharp theme={null}
public ShipmentMessageEntity()
```

## Properties

### <a id="SuperOffice_WebApi_Data_ShipmentMessageEntity_AccessKey" /> AccessKey

Key used for access verification

```csharp theme={null}
public virtual string AccessKey { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_ShipmentMessageEntity_Description" /> Description

Describes this message

```csharp theme={null}
public virtual string Description { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_ShipmentMessageEntity_Design" /> Design

Will contain the design part of a message. The format will vary based on the type of designer used to create the message

```csharp theme={null}
public virtual string Design { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_ShipmentMessageEntity_Designtype" /> Designtype

Enum containing the type of the design
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public DesignType? Designtype { get; set; }
```

#### Property Value

[DesignType](SuperOffice.WebApi.Data.DesignType.md)?

#### See Also

[ShipmentMessageEntity](SuperOffice.WebApi.Data.ShipmentMessageEntity.md).[Designtype\_String](SuperOffice.WebApi.Data.ShipmentMessageEntity.md#SuperOffice_WebApi_Data_ShipmentMessageEntity_Designtype_String)

### <a id="SuperOffice_WebApi_Data_ShipmentMessageEntity_Designtype_String" /> Designtype\_String

Enum containing the type of the design
Raw string enum value.

```csharp theme={null}
[JsonProperty("Designtype")]
public string Designtype_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[ShipmentMessageEntity](SuperOffice.WebApi.Data.ShipmentMessageEntity.md).[Designtype](SuperOffice.WebApi.Data.ShipmentMessageEntity.md#SuperOffice_WebApi_Data_ShipmentMessageEntity_Designtype)

### <a id="SuperOffice_WebApi_Data_ShipmentMessageEntity_DocumentMessage" /> DocumentMessage

The SM document used as template for this mailing

```csharp theme={null}
public virtual int DocumentMessage { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_ShipmentMessageEntity_Flags" /> Flags

Identifies if HTML or plain message is included in message.
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public ShipmentMessageType? Flags { get; set; }
```

#### Property Value

[ShipmentMessageType](SuperOffice.WebApi.Data.ShipmentMessageType.md)?

#### See Also

[ShipmentMessageEntity](SuperOffice.WebApi.Data.ShipmentMessageEntity.md).[Flags\_String](SuperOffice.WebApi.Data.ShipmentMessageEntity.md#SuperOffice_WebApi_Data_ShipmentMessageEntity_Flags_String)

### <a id="SuperOffice_WebApi_Data_ShipmentMessageEntity_Flags_String" /> Flags\_String

Identifies if HTML or plain message is included in message.
Raw string enum value.

```csharp theme={null}
[JsonProperty("Flags")]
public string Flags_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[ShipmentMessageEntity](SuperOffice.WebApi.Data.ShipmentMessageEntity.md).[Flags](SuperOffice.WebApi.Data.ShipmentMessageEntity.md#SuperOffice_WebApi_Data_ShipmentMessageEntity_Flags)

### <a id="SuperOffice_WebApi_Data_ShipmentMessageEntity_FolderId" /> FolderId

The folder which this message belongs to. -1 indicates that the message is on the root

```csharp theme={null}
public virtual int FolderId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_ShipmentMessageEntity_HeaderField" /> HeaderField

Extra header fields added to mail. Must be formatted correctly

```csharp theme={null}
public virtual string HeaderField { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_ShipmentMessageEntity_HtmlMessage" /> HtmlMessage

HTML formatted text of this message

```csharp theme={null}
public virtual string HtmlMessage { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_ShipmentMessageEntity_InlineImages" /> InlineImages

Should images be included inline?

```csharp theme={null}
public virtual bool InlineImages { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="SuperOffice_WebApi_Data_ShipmentMessageEntity_LongDescription" /> LongDescription

A field for a long description of this template

```csharp theme={null}
public virtual string LongDescription { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_ShipmentMessageEntity_PlainMessage" /> PlainMessage

Plain message text of this message

```csharp theme={null}
public virtual string PlainMessage { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_ShipmentMessageEntity_RegisterViews" /> RegisterViews

Register message views?

```csharp theme={null}
public virtual bool RegisterViews { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="SuperOffice_WebApi_Data_ShipmentMessageEntity_Registered" /> Registered

Registered when

```csharp theme={null}
public virtual DateTime Registered { get; set; }
```

#### Property Value

[DateTime](https://learn.microsoft.com/dotnet/api/system.datetime)

### <a id="SuperOffice_WebApi_Data_ShipmentMessageEntity_RegisteredAssociateId" /> RegisteredAssociateId

Registered by whom

```csharp theme={null}
public virtual int RegisteredAssociateId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_ShipmentMessageEntity_ShipmentMessageId" /> ShipmentMessageId

Primary key

```csharp theme={null}
public virtual int ShipmentMessageId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_ShipmentMessageEntity_SmsMessage" /> SmsMessage

SMS version of this message

```csharp theme={null}
public virtual string SmsMessage { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_ShipmentMessageEntity_Subject" /> Subject

The mail subject field of the message

```csharp theme={null}
public virtual string Subject { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_ShipmentMessageEntity_Updated" /> Updated

Last updated when

```csharp theme={null}
public virtual DateTime Updated { get; set; }
```

#### Property Value

[DateTime](https://learn.microsoft.com/dotnet/api/system.datetime)

### <a id="SuperOffice_WebApi_Data_ShipmentMessageEntity_UpdatedAssociateId" /> UpdatedAssociateId

Last updated by whom

```csharp theme={null}
public virtual int UpdatedAssociateId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_ShipmentMessageEntity_UpdatedCount" /> UpdatedCount

Number of updates made to this record

```csharp theme={null}
public virtual short UpdatedCount { get; set; }
```

#### Property Value

[short](https://learn.microsoft.com/dotnet/api/system.int16)

## See Also

[MarketingAgent](SuperOffice.WebApi.Agents.MarketingAgent.md)


## Related topics

- [SuperOffice.WebApi.Agents.IMarketingAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IMarketingAgent.md)
- [SuperOffice.WebApi.Agents.MarketingAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.MarketingAgent.md)
- [SuperOffice.WebApi.Data.ShipmentMessageBlockEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.ShipmentMessageBlockEntity.md)
- [SuperOffice.WebApi.Data.ShipmentMessageType](/en/api/reference/webapi/SuperOffice.WebApi.Data.ShipmentMessageType.md)
- [SuperOffice.WebApi.Data.Marketing DeleteMessageAndShipmentRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Marketing_DeleteMessageAndShipmentRequest.md)
- [Delete Shipment Message Entity](/en/api/reference/restful/rest/shipmentmessage/delete-shipment-message-entity.md)