post

/v5/provisioning/account

Create an account. Accounts can only be created using customer-level authentication.

When creating an account, a referenceAccount must be supplied. A reference account’s values are used for any values that are left null by the request. Additionally, it is also used to set suppression and deliverability settings.

If the eventTypes parameter is null, the reference account’s eventTypes will be used. If the eventTypes is empty, then no events will be set for the account.

Authorization

apiKey - Authorization

Request Parameters

1 Path Parameter

Request Body

1 Example
Schema
object
referenceAccount
integer

The id of the account used to apply deliverability and suppression settings. It will also be used to provide default values for any null parameters in this request

required
name
string

The name of the account

2 validations + required
includeUnsubscribeHeader
boolean

Boolean flag indicating whether email mailings with tihs account should include the List-Unsubscribe header.

This value is able to be overridden at the job-level.

1 validation
spamComplaintForwardingAddress
string

The email address that all email replies will be forwarded to.

2 validations
suppressOpenBeacon
boolean

Boolean flag indicating whether email mailings should include an open beacon or not.

1 validation
deepLinkTracking
boolean

Boolean flag indicating whether email mailings for this account should track links using deep link tracking.

If true, then autoTrack must also be true

1 validation
customTrackingDomain
string

The default custom tracking domain to use for all mailings from this account. The domain should begin with either http:// or https://.

This value is able to be overridden at the job-level.

2 validations
customSigningDomain
string

The default DKIM signing domain to use for email mailings from this account. If provided, it should be DNS-compliant.

autoTrack
boolean

Boolean flag indicating whether mailings from this account should automatically wrap <a/> HTML links with Gears.track()

1 validation
ampAutoTrack
boolean

Boolean flag indicating whether mailings from this account should automatically track links and add an open beacon to AMP templates.

If this value is true, then autoTrack should also be true.

urlAppend
string

A value to append to all rendered links in an email mailing. If this value is not empty, then autoTrack must be true.

This value is able to be overridden at the job-level.

1 validation
eventFormat
string

The format in which events should be returned. Valid values are XML and CSV. The default value is XML.

1 validation
eventTypes
array[string]

A list of event types to which to subscribe the account.

Valid values are

  • CLICK
  • OPEN
  • UNSUB
  • BOUNCE
  • JOB_ERROR
  • RENDER_ERROR
  • DELIVERED
  • FBL
  • INBOUND_EMAIL
  • SMS_RENDER_ERROR
  • SMS_DELIVERED
  • SMS_INBOUND
  • SMS_DELIVERY_FAILURE
  • MOBILE_PUSH_DELIVERY
  • MOBILE_PUSH_DELIVERY_FAILURE
  • MOBILE_PUSH_RENDER_ERROR
  • MOBILE_PUSH_CLICK
1 validation
eventQueueIdentifier
string

The Amazon SQS queue to which real-time events will be sent. If this value is not provided, MessageGears will provision one for this account along with the credentials needed to access it.

Also, if this value is provided, please ensure MessageGears’ AWS account is able to access it. Contact support for more information

1 validation
eventVersion
string

The version of MessageGears events the account should receive. Valid values are 3.1 and 3.2

2 validations

Responses

1 Example
Schema
object
id
integer
name
string
apiKey
string
locked
boolean
events
boolean
eventVersion
string
eventQueueIdentifier
string
eventFormat
string
eventTypes
array[string]
spamComplaintForwardingAddress
string
defaultSmsCode
object

This is a simple key-value mapping of the country code to the default sms code for that country

Example:

"defaultSmsCode": {
                    "1": "your-code",
                    "7": "your-code",
                    "254": "your-code"
}
defaultApplicationId
string
ipSelector
object
autoTrack
boolean
ampAutoTrack
boolean
urlAppend
string
customTrackingDomain
string
customSigningDomain
string
includeUnsubscribeHeader
boolean
suppressOpenBeacon
boolean
deepLinkTracking
boolean
dynamicLinkTracking
boolean
contextDataLinkTracking
boolean
dateCreated
string
dateLastModified
string
hardbounceSuppression
boolean
unsubscribeSuppression
boolean
inactive
boolean
_links
object

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
2 variables not set
host
Authorization