> ## 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.

# Put Shipment Message Block Entity

> Updates the existing ShipmentMessageBlockEntity

NsApiSlow threshold: 5000 ms.



## OpenAPI

````yaml /openapi/rest/openapi-v3-ShipmentMessageBlock.json put /api/v1/ShipmentMessageBlock/{id}
openapi: 3.0.0
info:
  version: v1-REST
  title: SuperOffice REST API v1
  description: SuperOffice REST API - ShipmentMessageBlock
  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/ShipmentMessageBlock/{id}:
    put:
      tags:
        - ShipmentMessageBlock
      summary: Put Shipment Message Block Entity
      description: |-
        Updates the existing ShipmentMessageBlockEntity

        NsApiSlow threshold: 5000 ms.
      operationId: v1ShipmentMessageBlockEntity_PutShipmentMessageBlockEntity
      parameters:
        - name: id
          in: path
          description: The ShipmentMessageBlockEntity id to update.
          required: true
          schema:
            type: integer
            format: int32
        - name: $select
          in: query
          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.
          required: false
          schema:
            type: string
        - 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
      requestBody:
        $ref: >-
          #/components/requestBodies/SuperOffice.CRM.Services.ShipmentMessageBlockEntity
      responses:
        '200':
          description: ShipmentMessageBlockEntity updated.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.WebApi.v1.Carriers.MarketingCarriers.ShipmentMessageBlockEntityWithLinks
            text/json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.WebApi.v1.Carriers.MarketingCarriers.ShipmentMessageBlockEntityWithLinks
            application/xml:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.WebApi.v1.Carriers.MarketingCarriers.ShipmentMessageBlockEntityWithLinks
            text/xml:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.WebApi.v1.Carriers.MarketingCarriers.ShipmentMessageBlockEntityWithLinks
            application/json-patch+json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.WebApi.v1.Carriers.MarketingCarriers.ShipmentMessageBlockEntityWithLinks
            application/merge-patch+json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.WebApi.v1.Carriers.MarketingCarriers.ShipmentMessageBlockEntityWithLinks
        '400':
          description: Bad request. Entity to save is not in request body.
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  requestBodies:
    SuperOffice.CRM.Services.ShipmentMessageBlockEntity:
      content:
        application/json:
          schema:
            $ref: >-
              #/components/schemas/SuperOffice.CRM.Services.ShipmentMessageBlockEntity
        text/json:
          schema:
            $ref: >-
              #/components/schemas/SuperOffice.CRM.Services.ShipmentMessageBlockEntity
        application/xml:
          schema:
            $ref: >-
              #/components/schemas/SuperOffice.CRM.Services.ShipmentMessageBlockEntity
        text/xml:
          schema:
            $ref: >-
              #/components/schemas/SuperOffice.CRM.Services.ShipmentMessageBlockEntity
        application/x-www-form-urlencoded:
          schema:
            $ref: >-
              #/components/schemas/SuperOffice.CRM.Services.ShipmentMessageBlockEntity
        application/json-patch+json:
          schema:
            $ref: >-
              #/components/schemas/SuperOffice.CRM.Services.ShipmentMessageBlockEntity
        application/merge-patch+json:
          schema:
            $ref: >-
              #/components/schemas/SuperOffice.CRM.Services.ShipmentMessageBlockEntity
      description: The ShipmentMessageBlockEntity to be saved.
      required: true
  schemas:
    SuperOffice.WebApi.v1.Carriers.MarketingCarriers.ShipmentMessageBlockEntityWithLinks:
      description: "This entity contains information about design blocks that can be used in a shipment/mailing message\r\n<para />\r\nShipmentMessageBlockEntity entity with API _Links added."
      type: object
      properties:
        ShipmentMessageBlockId:
          format: int32
          description: Primary key
          type: integer
        AssociateId:
          format: int32
          description: The associate that owns this block
          type: integer
        Block:
          description: The block definition. Normally this will be a json structure
          type: string
        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'
        _Links:
          type: object
          additionalProperties:
            type: string
    SuperOffice.CRM.Services.ShipmentMessageBlockEntity:
      description: "This entity contains information about design blocks that can be used in a shipment/mailing message\r\n<para />\r\nCarrier object for ShipmentMessageBlockEntity.\r\nServices for the ShipmentMessageBlockEntity Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IMarketingAgent\">Marketing Agent</see>."
      type: object
      properties:
        ShipmentMessageBlockId:
          format: int32
          description: Primary key
          type: integer
        AssociateId:
          format: int32
          description: The associate that owns this block
          type: integer
        Block:
          description: The block definition. Normally this will be a json structure
          type: string
        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

- [Put Shipment Message Entity](/en/api/reference/restful/rest/shipmentmessage/put-shipment-message-entity.md)
- [Delete Shipment Message Block Entity](/en/api/reference/restful/rest/shipmentmessageblock/delete-shipment-message-block-entity.md)
- [NSShipmentMessageBlockEntity](/en/automation/crmscript/reference/CRMScript.NetServer.NSShipmentMessageBlockEntity.md)
- [Get Shipment Message Block Entity](/en/api/reference/restful/rest/shipmentmessageblock/get-shipment-message-block-entity.md)
- [Post Shipment Message Block Entity](/en/api/reference/restful/rest/shipmentmessageblock/post-shipment-message-block-entity.md)
- [Default Shipment Message Block Entity](/en/api/reference/restful/rest/shipmentmessageblock/default-shipment-message-block-entity.md)
