Skip to main content
Put Shipment Message Block Entity

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Path Parameters

id
integer<int32>
required

The ShipmentMessageBlockEntity id to update.

Query Parameters

$select
string

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.

Body

The ShipmentMessageBlockEntity to be saved.

This entity contains information about design blocks that can be used in a shipment/mailing message Carrier object for ShipmentMessageBlockEntity. Services for the ShipmentMessageBlockEntity Carrier is available from the Marketing Agent.

ShipmentMessageBlockId
integer<int32>

Primary key

AssociateId
integer<int32>

The associate that owns this block

Block
string

The block definition. Normally this will be a json structure

Registered
string<date-time>

Registered when in UTC.

RegisteredAssociateId
integer<int32>

Registered by whom

Updated
string<date-time>

Last updated when in UTC.

UpdatedAssociateId
integer<int32>

Last updated by whom

UpdatedCount
integer<int32>

Number of updates made to this record

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.

Response

ShipmentMessageBlockEntity updated.

This entity contains information about design blocks that can be used in a shipment/mailing message ShipmentMessageBlockEntity entity with API _Links added.

ShipmentMessageBlockId
integer<int32>

Primary key

AssociateId
integer<int32>

The associate that owns this block

Block
string

The block definition. Normally this will be a json structure

Registered
string<date-time>

Registered when in UTC.

RegisteredAssociateId
integer<int32>

Registered by whom

Updated
string<date-time>

Last updated when in UTC.

UpdatedAssociateId
integer<int32>

Last updated by whom

UpdatedCount
integer<int32>

Number of updates made to this record

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.