> ## 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. # Create Default Shipment Message Entity > Loading default values into a new ShipmentMessageEntity. NsApiSlow threshold: 5000 ms. ## OpenAPI ````yaml /openapi/agent/openapi-v3-MarketingAgent.json post /api/v1/Agents/Marketing/CreateDefaultShipmentMessageEntity openapi: 3.0.0 info: version: v1-Agents title: SuperOffice Agent API v1 description: SuperOffice Agent API - MarketingAgent contact: name: SuperOffice DevNet url: https://docs.superoffice.com/en/api/index.html email: sdk@superoffice.com servers: - url: http://localhost:56350 - url: https://localhost:56350 security: [] tags: [] externalDocs: description: >- The SuperOffice DevNet Community has more documentation, examples, and discussion forums. url: https://community.superoffice.com/en/developer/ paths: /api/v1/Agents/Marketing/CreateDefaultShipmentMessageEntity: post: tags: - Marketing_Agent summary: Create Default Shipment Message Entity description: |- Loading default values into a new ShipmentMessageEntity. NsApiSlow threshold: 5000 ms. operationId: v1MarketingAgent_CreateDefaultShipmentMessageEntity parameters: - name: Accept-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. required: false schema: type: string - name: SO-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. required: false schema: type: string - name: SO-Culture in: header description: >- Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. required: false schema: type: string - name: SO-TimeZone in: header description: >- Specify the timezone code that you would like date/time responses converted to. required: false schema: type: string - name: SO-AppToken in: header description: >- The application token that identifies the partner app. Used when calling Online WebAPI from a server. required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.ShipmentMessageEntity text/json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.ShipmentMessageEntity application/xml: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.ShipmentMessageEntity text/xml: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.ShipmentMessageEntity application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.ShipmentMessageEntity application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.ShipmentMessageEntity security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.CRM.Services.ShipmentMessageEntity: description: "A shipment message, that contains the actual message being sent out in a mailing\r\n\r\nCarrier object for ShipmentMessageEntity.\r\nServices for the ShipmentMessageEntity Carrier is available from the Marketing Agent." 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: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Security.TableRight: description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted." type: object properties: Mask: type: string Reason: type: string SuperOffice.CRM.Security.FieldProperty: description: >- Class holding properties like field length, field type about a field in the carrier. type: object properties: FieldRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight' FieldType: type: string FieldLength: format: int32 description: '' type: integer SuperOffice.CRM.Security.FieldRight: description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined." type: object properties: Mask: type: string Reason: type: string ```` ## Related topics - [Default Shipment Message Entity](/en/api/reference/restful/rest/shipmentmessage/default-shipment-message-entity.md) - [NSMarketingAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSMarketingAgent.md) - [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) - [Create Default Shipment Message Block Entity](/en/api/reference/restful/agent/marketing_agent/create-default-shipment-message-block-entity.md) - [Default Shipment Message Block Entity](/en/api/reference/restful/rest/shipmentmessageblock/default-shipment-message-block-entity.md)