Skip to main content
Create Default Mailing Entity

Authorizations

Authorization
string
header
required

SuperOffice username:password are passed in Base64-encoded.

You can also pass inn an unencoded ticket 7T:abc== with the HTTP Authenticate header.

Authorization
string
header
required

SuperOffice SuperId OAuth implicit flow. You need to issue a request to the SuperId authorization URL https://online.superoffice.com/login/common/oauth/authorize?response_type=token &client_id=670734e0-4c5a-11e3-be9e-a171392e81db &redirect_uri=https://example.com/spa/

passing in the application id and redirect URL.

SuperId will log the user in, and redirect to the requested redirect URL with a #payload containing the access token and claims. (The redirect URL must be registered with SuperId in advance)

https://example.com/spa#access_token=8A%3aCust12227.AXRrCITpPBvQX3UbIohb &token_type=bearer &state= &expires_in=3600 &ctx=Cust12227 &netserver_url=https%3a%2f%2fsod.superoffice.com%2fCust12227%2fRemote%2fServices82%2f

You can take the #access_token value and pass it as the Authenticate HTTP header as a BEARER token.

FlowImplicit
Authorization URL
https://online.superoffice.com/login/common/oauth/authorize

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.

Response

OK

A mailing (shipment) — the run that sends a message to a set of recipients Carrier object for MailingEntity. Services for the MailingEntity Carrier is available from the Marketing Agent.

MailingId
integer<int32>

Primary key

Description
string

Describes the shipment

MessageId
integer<int32>

The id of the message that is sent in this shipment

FolderId
integer<int32>

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

StartDate
string<date-time>

The date and time when to start this shipment

EndDate
string<date-time>

Is set when this shipment is ended

FromAddr
string

Email address to put in the From header of the messages

ReplyAddr
string

Email address to put in the Reply To: header of the messages

EnvelopeFrom
string

Email address for the MTA envelope (where bounces are returned)

Status
enum<string>

Sending/stopped/failed etc.

Available options:
None,
Ok,
Canceled,
Waiting,
Started,
StatusFailed,
Retry,
Populating,
Deleted,
AwaitPopulate,
PopulatingOnly,
PopulateAborted,
PopulateError,
TooManyRecipients
Recipients
integer<int32>

The total number of recipients to send message to.

Configuration
integer<int32>

This field indicates what kind of shipment this is.

SelectionId
integer<int32>

Set if this shipment should be related to a Selection

ProjectId
integer<int32>

Set if this shipment should be related to a Project

ShipmenttypeId
integer<int32>

Id of subscriptionType that this shipment has, so we may check for reservations

SentNum
integer<int32>

Number of mails sent

DeliveredNum
integer<int32>

Number of mails sent minus bounces

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.