external_messaging API reference

GET

/v1/external_messaging/get_billing_settings

#

Returns billing settings and the selected default AT funding account.

Parameters

Name	Type	Required	Default	Description
`channel`	`string`	`No`	`"all"`	Billing channel. Use all for the default setting.

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/external_messaging/get_billing_settings' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'channel={{channel}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`external_messaging_get_billing_settings_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.ID`	`DatabaseInteger`	`No`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.ID.oneOf[0]`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.ID.oneOf[1]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.CreatedDate`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.LastUpdateDate`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.DeletedDate`		`No`
`$.oneOf[0].allOf[1].Payload.DeletedDate.anyOf[0]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.DeletedDate.anyOf[1]`	`null`	`No`
`$.oneOf[0].allOf[1].Payload.ATUser_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.ATUser_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ATUser_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Channel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.DefaultFunding-ATAccounts_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.DefaultFunding-ATAccounts_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.DefaultFunding-ATAccounts_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.DefaultFunding-ATAccounts_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.DefaultFunding-ATAccounts_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.LastSetBy-ATUser_ID`		`No`
`$.oneOf[0].allOf[1].Payload.LastSetBy-ATUser_ID.anyOf[0]`	`DatabaseInteger`	`No`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.LastSetBy-ATUser_ID.anyOf[0].oneOf[0]`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.LastSetBy-ATUser_ID.anyOf[0].oneOf[1]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.LastSetBy-ATUser_ID.anyOf[1]`	`null`	`No`
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount`		`Yes`
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].Currency`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].CurrencySymbol`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].CreatedDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].LastUpdateDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].Name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].Description`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].ATUser_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].ATUser_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].ATUser_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].CurrencyCreditLimit`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].CurrencyCreditLimit.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].CurrencyCreditLimit.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].PayoutDefaultBasisPoints`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].PayoutDefaultBasisPoints.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].PayoutDefaultBasisPoints.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].PointsCreditLimit`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].PointsCreditLimit.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].PointsCreditLimit.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].IsATCorporateAccount`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].IsATCorporateAccount.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].IsATCorporateAccount.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].IsDefault`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].IsDefault.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].IsDefault.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].IsDepositAccount`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].IsDepositAccount.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].IsDepositAccount.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].CurrencyBalance`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].CurrencyBalance.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].CurrencyBalance.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].PointsBalance`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].PointsBalance.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].PointsBalance.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[1]`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.PriceSettings`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.PriceSettings.PricePerMessage`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.PriceSettings.PriceUnit`	`string ["USD","Traderpoint"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.PriceSettings.RateLimitPerHour`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.PriceSettings.RecipientLimitPerMessage`	`integer`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/external_messaging/get_billing_settings",
    "RequestUserAlias": "example-user",
    "Payload": {
        "ATUser_ID": 0,
        "Channel": "synthetic-example",
        "DefaultFunding-ATAccounts_ID": 0,
        "DefaultFundingAccount": {
            "Currency": "synthetic-example",
            "CurrencySymbol": "synthetic-example",
            "CreatedDate": "synthetic-example",
            "LastUpdateDate": "synthetic-example",
            "Name": "synthetic-example",
            "Description": "synthetic-example",
            "ID": 0,
            "ATUser_ID": 0,
            "CurrencyCreditLimit": 0,
            "PayoutDefaultBasisPoints": 0,
            "PointsCreditLimit": 0,
            "IsATCorporateAccount": 0,
            "IsDefault": 0,
            "IsDepositAccount": 0,
            "CurrencyBalance": 0,
            "PointsBalance": 0
        },
        "PriceSettings": {
            "PricePerMessage": 0,
            "PriceUnit": "USD",
            "RateLimitPerHour": 0,
            "RecipientLimitPerMessage": 0
        }
    }
}

Machine-readable endpoint documentation

GET

/v1/external_messaging/get_channels

#

Returns supported external messaging channels.

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/external_messaging/get_channels' \
  --data-urlencode 'key={{API_KEY}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`external_messaging_get_channels_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.channels`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.channels[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.channels[].channel`	`= "email"`	`Yes`
`$.oneOf[0].allOf[1].Payload.channels[].name`	`= "Email"`	`Yes`
`$.oneOf[0].allOf[1].Payload.channels[].enabled`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.channels[].streams`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.channels[].streams[]`	`string ["auth","transactional","community","bulk","sandbox"]`	`No`
`$.oneOf[0].allOf[1].Payload.priceSettings`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.priceSettings.PricePerMessage`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.priceSettings.PriceUnit`	`string ["USD","Traderpoint"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.priceSettings.RateLimitPerHour`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.priceSettings.RecipientLimitPerMessage`	`integer`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/external_messaging/get_channels",
    "RequestUserAlias": "example-user",
    "Payload": {
        "channels": [],
        "priceSettings": {
            "PricePerMessage": 0,
            "PriceUnit": "USD",
            "RateLimitPerHour": 0,
            "RecipientLimitPerMessage": 0
        }
    }
}

Machine-readable endpoint documentation

GET

/v1/external_messaging/get_delivery_health

#

Returns delivery health counters for the API user.

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/external_messaging/get_delivery_health' \
  --data-urlencode 'key={{API_KEY}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`external_messaging_get_delivery_health_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.window`	`= "7 days"`	`Yes`
`$.oneOf[0].allOf[1].Payload.messageCounts`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.messageCounts.Queued`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.messageCounts.Sending`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.messageCounts.Sent`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.messageCounts.Deferred`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.messageCounts.Suppressed`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.messageCounts.Failed`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.identityCounts`		`Yes`
`$.oneOf[0].allOf[1].Payload.identityCounts.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.identityCounts.anyOf[0].*`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.identityCounts.anyOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.suppressionCount`	`integer`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/external_messaging/get_delivery_health",
    "RequestUserAlias": "example-user",
    "Payload": {
        "window": "7 days",
        "messageCounts": {
            "Queued": 0,
            "Sending": 0,
            "Sent": 0,
            "Deferred": 0,
            "Suppressed": 0,
            "Failed": 0
        },
        "identityCounts": [],
        "suppressionCount": 0
    }
}

Machine-readable endpoint documentation

GET

/v1/external_messaging/get_events

#

Returns the event timeline for a message.

Parameters

Name	Type	Required	Default	Description
`messageID`	`string`	`No`	`""`	Message numeric ID or UUID.

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/external_messaging/get_events' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'messageID={{messageID}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`external_messaging_get_events_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.events`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.events[].ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.events[].ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].CreatedDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].ATExternalMessagingMessages_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.events[].ATExternalMessagingMessages_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].ATExternalMessagingMessages_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].Channel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventType`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].Severity`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].RecipientAddress`		`Yes`
`$.oneOf[0].allOf[1].Payload.events[].RecipientAddress.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].RecipientAddress.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].ProviderMessageID`		`Yes`
`$.oneOf[0].allOf[1].Payload.events[].ProviderMessageID.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].ProviderMessageID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].ATExternalMessagingChannelConfigs_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.events[].ATExternalMessagingChannelConfigs_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.events[].ATExternalMessagingChannelConfigs_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].ATExternalMessagingChannelConfigs_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].ATExternalMessagingChannelConfigs_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload`		`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[0]`	`= null`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[1]`	`= ""`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].CreatedDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].LastUpdateDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].DeletedDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].DeletedDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].DeletedDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].ATUser_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].ATUser_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].ATUser_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].ATUser_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].ATUser_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].Channel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].Scope`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].ATExternalMessagingIdentities_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].ATExternalMessagingIdentities_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].ATExternalMessagingIdentities_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].ATExternalMessagingIdentities_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].ATExternalMessagingIdentities_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].RecipientAddress`		`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].RecipientAddress.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].RecipientAddress.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].RecipientHash`		`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].RecipientHash.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].RecipientHash.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].SuppressionType`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].Reason`		`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].Reason.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].Reason.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].ExpiresDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].ExpiresDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].ExpiresDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].CreatedBy-ATUser_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].CreatedBy-ATUser_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].CreatedBy-ATUser_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].CreatedBy-ATUser_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].CreatedBy-ATUser_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].DeletedBy-ATUser_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].DeletedBy-ATUser_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].DeletedBy-ATUser_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].DeletedBy-ATUser_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].DeletedBy-ATUser_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[3]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[3].endpoint`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[4]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[4].reason`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[4].delayMinutes`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[5]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[5].accepted`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[5].providerMessageID`		`No`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[5].providerMessageID.anyOf[0]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[5].providerMessageID.anyOf[1]`	`null`	`No`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[5].statusCode`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[5].response`	`ExternalMessageProviderValue`	`No`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[5].response.oneOf[0]`	`string \| number \| boolean \| null`	`No`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[5].response.oneOf[1]`	`array`	`No`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[5].response.oneOf[1][]`	`ExternalMessageProviderValue`	`No`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[5].response.oneOf[2]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[5].response.oneOf[2].*`	`ExternalMessageProviderValue`	`No`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[5].error`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[6]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[6].ledgerID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[6].ledgerID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[6].ledgerID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[6].priceAmount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[6].priceUnit`	`string ["USD","Traderpoint"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[7]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[7].*`	`ExternalMessageProviderValue`	`No`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[7].*.oneOf[0]`	`string \| number \| boolean \| null`	`No`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[7].*.oneOf[1]`	`array`	`No`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[7].*.oneOf[1][]`	`ExternalMessageProviderValue`	`No`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[7].*.oneOf[2]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[7]..oneOf[2].`	`ExternalMessageProviderValue`	`No`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[8]`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[9]`	`array`	`Yes`	Provider callback arrays are preserved when supplied.
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[9][]`	`ExternalMessageProviderValue`	`No`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[9][].oneOf[0]`	`string \| number \| boolean \| null`	`No`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[9][].oneOf[1]`	`array`	`No`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[9][].oneOf[1][]`	`ExternalMessageProviderValue`	`No`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[9][].oneOf[2]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[9][].oneOf[2].*`	`ExternalMessageProviderValue`	`No`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/external_messaging/get_events",
    "RequestUserAlias": "example-user",
    "Payload": {
        "events": []
    }
}

Machine-readable endpoint documentation

GET

/v1/external_messaging/get_identities

#

Returns sender identities owned by the API user.

Parameters

Name	Type	Required	Default	Description
`channel`	`string`	`No`	`"email"`	Channel to list. Phase one supports email.

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/external_messaging/get_identities' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'channel={{channel}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`external_messaging_get_identities_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.identities`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.identities[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.identities[].ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.identities[].ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].IdentityUUID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].CreatedDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].LastUpdateDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].ATUser_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.identities[].ATUser_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].ATUser_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].Channel`	`= "email"`	`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].Stream`	`string ["auth","transactional","community","bulk","sandbox"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].Status`	`string ["PendingDNS","Verified","Suspended"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].Name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].FromName`		`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].FromName.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].FromName.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].FromAddress`		`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].FromAddress.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].FromAddress.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].DomainName`		`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].DomainName.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].DomainName.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].ReturnPathDomain`		`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].ReturnPathDomain.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].ReturnPathDomain.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].DKIMSelector`		`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].DKIMSelector.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].DKIMSelector.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].DNSLastCheckTime`		`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].DNSLastCheckTime.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].DNSLastCheckTime.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].LastVerifiedTime`		`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].LastVerifiedTime.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].LastVerifiedTime.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].ATUser_Alias`		`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].ATUser_Alias.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identities[].ATUser_Alias.anyOf[1]`	`null`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/external_messaging/get_identities",
    "RequestUserAlias": "example-user",
    "Payload": {
        "identities": []
    }
}

Machine-readable endpoint documentation

GET

/v1/external_messaging/get_identity_dns_status

#

Returns expected and last observed DNS state for an identity.

Parameters

Name	Type	Required	Default	Description
`identityID`	`int`	`No`	`0`	Sender identity ID.

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/external_messaging/get_identity_dns_status' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'identityID={{identityID}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`external_messaging_get_identity_dns_status_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.identity.ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.CreatedDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.LastUpdateDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DeletedDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DeletedDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DeletedDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.IdentityUUID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.ATUser_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.identity.ATUser_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.ATUser_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.CreatedBy-ATUser_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.identity.CreatedBy-ATUser_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.identity.CreatedBy-ATUser_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.CreatedBy-ATUser_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.CreatedBy-ATUser_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.Channel`	`= "email"`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.Stream`	`string ["auth","transactional","community","bulk","sandbox"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.Status`	`string ["PendingDNS","Verified","Suspended"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.Name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.FromName`		`Yes`
`$.oneOf[0].allOf[1].Payload.identity.FromName.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.FromName.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.FromAddress`		`Yes`
`$.oneOf[0].allOf[1].Payload.identity.FromAddress.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.FromAddress.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DomainName`		`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DomainName.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DomainName.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.ReturnPathDomain`		`Yes`
`$.oneOf[0].allOf[1].Payload.identity.ReturnPathDomain.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.ReturnPathDomain.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DKIMSelector`		`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DKIMSelector.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DKIMSelector.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DKIMPublicKey`		`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DKIMPublicKey.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DKIMPublicKey.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DKIMPrivateKeyEnvironmentKey`		`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DKIMPrivateKeyEnvironmentKey.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DKIMPrivateKeyEnvironmentKey.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.VerificationToken`		`Yes`
`$.oneOf[0].allOf[1].Payload.identity.VerificationToken.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.VerificationToken.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DNSExpectedPayload`		`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DNSExpectedPayload.anyOf[0]`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DNSExpectedPayload.anyOf[0][]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.identity.DNSExpectedPayload.anyOf[0][].key`	`string ["ownership","dkim","dmarc","return_path","mta_sts","tls_reporting"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DNSExpectedPayload.anyOf[0][].label`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DNSExpectedPayload.anyOf[0][].type`	`string ["TXT","MX"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DNSExpectedPayload.anyOf[0][].host`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DNSExpectedPayload.anyOf[0][].value`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DNSExpectedPayload.anyOf[0][].required`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DNSExpectedPayload.anyOf[0][].status`	`string ["pending","verified","missing","advisory"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DNSExpectedPayload.anyOf[0][].observedValue`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.identity.DNSExpectedPayload.anyOf[1]`	`= ""`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DNSExpectedPayload.anyOf[2]`	`= null`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DNSLastCheckPayload`		`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DNSLastCheckPayload.anyOf[0]`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DNSLastCheckPayload.anyOf[0][]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.identity.DNSLastCheckPayload.anyOf[0][].key`	`string ["ownership","dkim","dmarc","return_path","mta_sts","tls_reporting"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DNSLastCheckPayload.anyOf[0][].label`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DNSLastCheckPayload.anyOf[0][].type`	`string ["TXT","MX"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DNSLastCheckPayload.anyOf[0][].host`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DNSLastCheckPayload.anyOf[0][].value`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DNSLastCheckPayload.anyOf[0][].required`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DNSLastCheckPayload.anyOf[0][].status`	`string ["pending","verified","missing","advisory"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DNSLastCheckPayload.anyOf[0][].observedValue`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.identity.DNSLastCheckPayload.anyOf[1]`	`= ""`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DNSLastCheckPayload.anyOf[2]`	`= null`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DNSLastCheckTime`		`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DNSLastCheckTime.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.DNSLastCheckTime.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.LastVerifiedTime`		`Yes`
`$.oneOf[0].allOf[1].Payload.identity.LastVerifiedTime.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.LastVerifiedTime.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.LastVerifiedBy-ATUser_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.identity.LastVerifiedBy-ATUser_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.identity.LastVerifiedBy-ATUser_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.LastVerifiedBy-ATUser_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.LastVerifiedBy-ATUser_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.ATUser_Alias`		`Yes`
`$.oneOf[0].allOf[1].Payload.identity.ATUser_Alias.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.identity.ATUser_Alias.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.dnsRecords`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.dnsRecords[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.dnsRecords[].key`	`string ["ownership","dkim","dmarc","return_path","mta_sts","tls_reporting"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.dnsRecords[].label`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.dnsRecords[].type`	`string ["TXT","MX"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.dnsRecords[].host`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.dnsRecords[].value`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.dnsRecords[].required`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.dnsRecords[].status`	`string ["pending","verified","missing","advisory"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.dnsRecords[].observedValue`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.lastCheck`		`Yes`
`$.oneOf[0].allOf[1].Payload.lastCheck.anyOf[0]`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.lastCheck.anyOf[0][]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.lastCheck.anyOf[0][].key`	`string ["ownership","dkim","dmarc","return_path","mta_sts","tls_reporting"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.lastCheck.anyOf[0][].label`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.lastCheck.anyOf[0][].type`	`string ["TXT","MX"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.lastCheck.anyOf[0][].host`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.lastCheck.anyOf[0][].value`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.lastCheck.anyOf[0][].required`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.lastCheck.anyOf[0][].status`	`string ["pending","verified","missing","advisory"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.lastCheck.anyOf[0][].observedValue`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.lastCheck.anyOf[1]`	`= ""`	`Yes`
`$.oneOf[0].allOf[1].Payload.lastCheck.anyOf[2]`	`= null`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/external_messaging/get_identity_dns_status",
    "RequestUserAlias": "example-user",
    "Payload": {
        "identity": {
            "ID": 0,
            "CreatedDate": "synthetic-example",
            "LastUpdateDate": "synthetic-example",
            "DeletedDate": "synthetic-example",
            "IdentityUUID": "synthetic-example",
            "ATUser_ID": 0,
            "CreatedBy-ATUser_ID": 0,
            "Channel": "email",
            "Stream": "auth",
            "Status": "PendingDNS",
            "Name": "synthetic-example",
            "FromName": "synthetic-example",
            "FromAddress": "synthetic-example",
            "DomainName": "synthetic-example",
            "ReturnPathDomain": "synthetic-example",
            "DKIMSelector": "synthetic-example",
            "DKIMPublicKey": "synthetic-example",
            "DKIMPrivateKeyEnvironmentKey": "synthetic-example",
            "VerificationToken": "synthetic-example",
            "DNSExpectedPayload": [],
            "DNSLastCheckPayload": [],
            "DNSLastCheckTime": "synthetic-example",
            "LastVerifiedTime": "synthetic-example",
            "LastVerifiedBy-ATUser_ID": 0,
            "ATUser_Alias": "synthetic-example"
        },
        "dnsRecords": [],
        "lastCheck": []
    }
}

Machine-readable endpoint documentation

GET

/v1/external_messaging/get_message

#

Returns a queued/sent message by numeric ID or UUID.

Parameters

Name	Type	Required	Default	Description
`messageID`	`string`	`No`	`""`	Message numeric ID or UUID.

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/external_messaging/get_message' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'messageID={{messageID}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`external_messaging_get_message_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.message`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.message.ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.CreatedDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.LastUpdateDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.DeletedDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.message.DeletedDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.DeletedDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.MessageUUID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.ATUser_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.message.ATUser_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.ATUser_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.ImpersonatedBy-ATUser_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.message.ImpersonatedBy-ATUser_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.message.ImpersonatedBy-ATUser_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.ImpersonatedBy-ATUser_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.ImpersonatedBy-ATUser_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.Channel`	`= "email"`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.Stream`	`string ["auth","transactional","community","bulk","sandbox"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.Mode`	`string ["sandbox","production"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.Status`	`string ["Queued","Sending","Sent","Deferred","Suppressed","Failed"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.ATExternalMessagingIdentities_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.message.ATExternalMessagingIdentities_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.message.ATExternalMessagingIdentities_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.ATExternalMessagingIdentities_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.ATExternalMessagingIdentities_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.Funding-ATAccounts_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.message.Funding-ATAccounts_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.message.Funding-ATAccounts_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.Funding-ATAccounts_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.Funding-ATAccounts_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.Settlement-ATAccountsLedger_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.message.Settlement-ATAccountsLedger_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.message.Settlement-ATAccountsLedger_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.Settlement-ATAccountsLedger_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.Settlement-ATAccountsLedger_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.ATAPIAccessLog_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.message.ATAPIAccessLog_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.message.ATAPIAccessLog_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.ATAPIAccessLog_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.ATAPIAccessLog_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.Subject`		`Yes`
`$.oneOf[0].allOf[1].Payload.message.Subject.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.Subject.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.RecipientsPayload`		`Yes`
`$.oneOf[0].allOf[1].Payload.message.RecipientsPayload.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.RecipientsPayload.anyOf[0].to`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.RecipientsPayload.anyOf[0].to[]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.message.RecipientsPayload.anyOf[1]`	`= ""`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.RecipientsPayload.anyOf[2]`	`= null`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.ContentPayload`		`Yes`
`$.oneOf[0].allOf[1].Payload.message.ContentPayload.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.ContentPayload.anyOf[0].htmlBody`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.ContentPayload.anyOf[0].textBody`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.ContentPayload.anyOf[1]`	`= ""`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.ContentPayload.anyOf[2]`	`= null`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.HeadersPayload`		`Yes`
`$.oneOf[0].allOf[1].Payload.message.HeadersPayload.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.HeadersPayload.anyOf[0].From`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.HeadersPayload.anyOf[0].X-AT-External-Messaging-Stream`	`string ["auth","transactional","community","bulk","sandbox"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.HeadersPayload.anyOf[0].List-Unsubscribe`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.message.HeadersPayload.anyOf[0].List-Unsubscribe-Post`	`= "List-Unsubscribe=One-Click"`	`No`
`$.oneOf[0].allOf[1].Payload.message.HeadersPayload.anyOf[1]`	`= ""`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.HeadersPayload.anyOf[2]`	`= null`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.PriceAmount`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.message.PriceAmount.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.PriceAmount.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.PriceUnit`		`Yes`
`$.oneOf[0].allOf[1].Payload.message.PriceUnit.anyOf[0]`	`string ["USD","Traderpoint"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.PriceUnit.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.RecipientCount`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.message.RecipientCount.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.RecipientCount.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.AttemptCount`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.message.AttemptCount.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.AttemptCount.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.NextAttemptDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.message.NextAttemptDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.NextAttemptDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.QueuedDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.message.QueuedDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.QueuedDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.SentDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.message.SentDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.SentDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.LastEventDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.message.LastEventDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.LastEventDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.ProviderMessageID`		`Yes`
`$.oneOf[0].allOf[1].Payload.message.ProviderMessageID.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.ProviderMessageID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.FailureReason`		`Yes`
`$.oneOf[0].allOf[1].Payload.message.FailureReason.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.FailureReason.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.FromAddress`		`Yes`
`$.oneOf[0].allOf[1].Payload.message.FromAddress.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.FromAddress.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.DomainName`		`Yes`
`$.oneOf[0].allOf[1].Payload.message.DomainName.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.DomainName.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.ATUser_Alias`		`Yes`
`$.oneOf[0].allOf[1].Payload.message.ATUser_Alias.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.message.ATUser_Alias.anyOf[1]`	`null`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/external_messaging/get_message",
    "RequestUserAlias": "example-user",
    "Payload": {
        "message": {
            "ID": 0,
            "CreatedDate": "synthetic-example",
            "LastUpdateDate": "synthetic-example",
            "DeletedDate": "synthetic-example",
            "MessageUUID": "synthetic-example",
            "ATUser_ID": 0,
            "ImpersonatedBy-ATUser_ID": 0,
            "Channel": "email",
            "Stream": "auth",
            "Mode": "sandbox",
            "Status": "Queued",
            "ATExternalMessagingIdentities_ID": 0,
            "Funding-ATAccounts_ID": 0,
            "Settlement-ATAccountsLedger_ID": 0,
            "ATAPIAccessLog_ID": 0,
            "Subject": "synthetic-example",
            "RecipientsPayload": {
                "to": []
            },
            "ContentPayload": {
                "htmlBody": "synthetic-example",
                "textBody": "synthetic-example"
            },
            "HeadersPayload": {
                "From": "synthetic-example",
                "X-AT-External-Messaging-Stream": "auth"
            },
            "PriceAmount": 0,
            "PriceUnit": "USD",
            "RecipientCount": 0,
            "AttemptCount": 0,
            "NextAttemptDate": "synthetic-example",
            "QueuedDate": "synthetic-example",
            "SentDate": "synthetic-example",
            "LastEventDate": "synthetic-example",
            "ProviderMessageID": "synthetic-example",
            "FailureReason": "synthetic-example",
            "FromAddress": "synthetic-example",
            "DomainName": "synthetic-example",
            "ATUser_Alias": "synthetic-example"
        }
    }
}

Machine-readable endpoint documentation

GET

/v1/external_messaging/get_messages

#

Returns recent messages for the API user.

Parameters

Name	Type	Required	Default	Description
`channel`	`string`	`No`	`"email"`	Channel filter.
`status`	`string`	`No`	`""`	Optional status filter.
`limit`	`int`	`No`	`50`	Maximum rows to return.

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/external_messaging/get_messages' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'channel={{channel}}' \
  --data-urlencode 'status={{status}}' \
  --data-urlencode 'limit={{limit}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`external_messaging_get_messages_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.messages[].ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.messages[].ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].MessageUUID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].CreatedDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].LastUpdateDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].Channel`	`= "email"`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].Stream`	`string ["auth","transactional","community","bulk","sandbox"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].Mode`	`string ["sandbox","production"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].Status`	`string ["Queued","Sending","Sent","Deferred","Suppressed","Failed"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].Subject`		`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].Subject.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].Subject.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].RecipientCount`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.messages[].RecipientCount.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].RecipientCount.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].PriceAmount`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.messages[].PriceAmount.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].PriceAmount.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].PriceUnit`		`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].PriceUnit.anyOf[0]`	`string ["USD","Traderpoint"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].PriceUnit.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].AttemptCount`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.messages[].AttemptCount.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].AttemptCount.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].QueuedDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].QueuedDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].QueuedDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].SentDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].SentDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].SentDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].LastEventDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].LastEventDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].LastEventDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].ProviderMessageID`		`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].ProviderMessageID.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].ProviderMessageID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].FailureReason`		`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].FailureReason.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].FailureReason.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].FromAddress`		`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].FromAddress.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].FromAddress.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].DomainName`		`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].DomainName.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.messages[].DomainName.anyOf[1]`	`null`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/external_messaging/get_messages",
    "RequestUserAlias": "example-user",
    "Payload": {
        "messages": []
    }
}

Machine-readable endpoint documentation

GET

/v1/external_messaging/get_suppressions

#

Returns active suppressions for the API user.

Parameters

Name	Type	Required	Default	Description
`channel`	`string`	`No`	`"email"`	Channel filter.
`limit`	`int`	`No`	`50`	Maximum rows to return.

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/external_messaging/get_suppressions' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'channel={{channel}}' \
  --data-urlencode 'limit={{limit}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`external_messaging_get_suppressions_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.suppressions[].ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.suppressions[].ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].CreatedDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].LastUpdateDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].DeletedDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].DeletedDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].DeletedDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].ATUser_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].ATUser_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.suppressions[].ATUser_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].ATUser_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].ATUser_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].Channel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].Scope`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].ATExternalMessagingIdentities_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].ATExternalMessagingIdentities_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.suppressions[].ATExternalMessagingIdentities_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].ATExternalMessagingIdentities_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].ATExternalMessagingIdentities_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].RecipientAddress`		`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].RecipientAddress.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].RecipientAddress.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].RecipientHash`		`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].RecipientHash.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].RecipientHash.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].SuppressionType`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].Reason`		`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].Reason.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].Reason.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].ExpiresDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].ExpiresDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].ExpiresDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].CreatedBy-ATUser_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].CreatedBy-ATUser_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.suppressions[].CreatedBy-ATUser_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].CreatedBy-ATUser_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].CreatedBy-ATUser_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].DeletedBy-ATUser_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].DeletedBy-ATUser_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.suppressions[].DeletedBy-ATUser_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].DeletedBy-ATUser_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.suppressions[].DeletedBy-ATUser_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/external_messaging/get_suppressions",
    "RequestUserAlias": "example-user",
    "Payload": {
        "suppressions": []
    }
}

Machine-readable endpoint documentation

POST

/v1/external_messaging/set_billing_account

#

Sets the default AT account used to pay for accepted production messages.

Parameters

Name	Type	Required	Default	Description
`fundingAccountID`	`int`	`No`	`0`	AT account ID owned by the API user.
`channel`	`string`	`No`	`"all"`	Billing channel. Use all for the default setting.
`isWritingRequest`	`bool`	`No`	`false`	Must be true to update billing settings.

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/external_messaging/set_billing_account' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'fundingAccountID={{fundingAccountID}}' \
  --data-urlencode 'channel={{channel}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`external_messaging_set_billing_account_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.Succeeded`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.ID`	`DatabaseInteger`	`No`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.BillingSettings.ID.oneOf[0]`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.BillingSettings.ID.oneOf[1]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.BillingSettings.CreatedDate`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.BillingSettings.LastUpdateDate`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DeletedDate`		`No`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DeletedDate.anyOf[0]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DeletedDate.anyOf[1]`	`null`	`No`
`$.oneOf[0].allOf[1].Payload.BillingSettings.ATUser_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.BillingSettings.ATUser_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.ATUser_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.Channel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFunding-ATAccounts_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFunding-ATAccounts_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFunding-ATAccounts_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFunding-ATAccounts_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFunding-ATAccounts_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.LastSetBy-ATUser_ID`		`No`
`$.oneOf[0].allOf[1].Payload.BillingSettings.LastSetBy-ATUser_ID.anyOf[0]`	`DatabaseInteger`	`No`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.BillingSettings.LastSetBy-ATUser_ID.anyOf[0].oneOf[0]`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.BillingSettings.LastSetBy-ATUser_ID.anyOf[0].oneOf[1]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.BillingSettings.LastSetBy-ATUser_ID.anyOf[1]`	`null`	`No`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount`		`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].Currency`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].CurrencySymbol`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].CreatedDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].LastUpdateDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].Name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].Description`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].ATUser_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].ATUser_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].ATUser_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].CurrencyCreditLimit`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].CurrencyCreditLimit.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].CurrencyCreditLimit.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].PayoutDefaultBasisPoints`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].PayoutDefaultBasisPoints.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].PayoutDefaultBasisPoints.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].PointsCreditLimit`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].PointsCreditLimit.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].PointsCreditLimit.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].IsATCorporateAccount`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].IsATCorporateAccount.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].IsATCorporateAccount.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].IsDefault`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].IsDefault.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].IsDefault.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].IsDepositAccount`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].IsDepositAccount.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].IsDepositAccount.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].CurrencyBalance`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].CurrencyBalance.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].CurrencyBalance.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].PointsBalance`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].PointsBalance.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].PointsBalance.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[1]`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.PriceSettings`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.PriceSettings.PricePerMessage`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.PriceSettings.PriceUnit`	`string ["USD","Traderpoint"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.PriceSettings.RateLimitPerHour`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.BillingSettings.PriceSettings.RecipientLimitPerMessage`	`integer`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/external_messaging/set_billing_account",
    "RequestUserAlias": "example-user",
    "Payload": {
        "Succeeded": true,
        "BillingSettings": {
            "ATUser_ID": 0,
            "Channel": "synthetic-example",
            "DefaultFunding-ATAccounts_ID": 0,
            "DefaultFundingAccount": {
                "Currency": "synthetic-example",
                "CurrencySymbol": "synthetic-example",
                "CreatedDate": "synthetic-example",
                "LastUpdateDate": "synthetic-example",
                "Name": "synthetic-example",
                "Description": "synthetic-example",
                "ID": 0,
                "ATUser_ID": 0,
                "CurrencyCreditLimit": 0,
                "PayoutDefaultBasisPoints": 0,
                "PointsCreditLimit": 0,
                "IsATCorporateAccount": 0,
                "IsDefault": 0,
                "IsDepositAccount": 0,
                "CurrencyBalance": 0,
                "PointsBalance": 0
            },
            "PriceSettings": {
                "PricePerMessage": 0,
                "PriceUnit": "USD",
                "RateLimitPerHour": 0,
                "RecipientLimitPerMessage": 0
            }
        }
    }
}

Machine-readable endpoint documentation

POST

/v1/external_messaging/set_identity

#

Creates an email sender identity and returns the DNS records needed for verification.

Parameters

Name	Type	Required	Default	Description
`channel`	`string`	`No`	`"email"`	Channel to create. Phase one supports email.
`fromAddress`	`string`	`No`	`""`	Sender email address.
`fromName`	`string`	`No`	`""`	Human readable sender name.
`name`	`string`	`No`	`""`	Internal identity label.
`stream`	`string`	`No`	`"transactional"`	Email stream: auth, transactional, community, or bulk.
`isWritingRequest`	`bool`	`No`	`false`	Must be true to create the identity.

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/external_messaging/set_identity' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'channel={{channel}}' \
  --data-urlencode 'fromAddress={{fromAddress}}' \
  --data-urlencode 'fromName={{fromName}}' \
  --data-urlencode 'name={{name}}' \
  --data-urlencode 'stream={{stream}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`external_messaging_set_identity_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.Succeeded`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity`		`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].CreatedDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].LastUpdateDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DeletedDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DeletedDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DeletedDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].IdentityUUID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].ATUser_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].ATUser_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].ATUser_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].CreatedBy-ATUser_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].CreatedBy-ATUser_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].CreatedBy-ATUser_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].CreatedBy-ATUser_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].CreatedBy-ATUser_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].Channel`	`= "email"`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].Stream`	`string ["auth","transactional","community","bulk","sandbox"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].Status`	`string ["PendingDNS","Verified","Suspended"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].Name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].FromName`		`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].FromName.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].FromName.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].FromAddress`		`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].FromAddress.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].FromAddress.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DomainName`		`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DomainName.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DomainName.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].ReturnPathDomain`		`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].ReturnPathDomain.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].ReturnPathDomain.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DKIMSelector`		`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DKIMSelector.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DKIMSelector.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DKIMPublicKey`		`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DKIMPublicKey.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DKIMPublicKey.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DKIMPrivateKeyEnvironmentKey`		`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DKIMPrivateKeyEnvironmentKey.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DKIMPrivateKeyEnvironmentKey.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].VerificationToken`		`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].VerificationToken.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].VerificationToken.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSExpectedPayload`		`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSExpectedPayload.anyOf[0]`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSExpectedPayload.anyOf[0][]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSExpectedPayload.anyOf[0][].key`	`string ["ownership","dkim","dmarc","return_path","mta_sts","tls_reporting"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSExpectedPayload.anyOf[0][].label`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSExpectedPayload.anyOf[0][].type`	`string ["TXT","MX"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSExpectedPayload.anyOf[0][].host`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSExpectedPayload.anyOf[0][].value`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSExpectedPayload.anyOf[0][].required`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSExpectedPayload.anyOf[0][].status`	`string ["pending","verified","missing","advisory"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSExpectedPayload.anyOf[0][].observedValue`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSExpectedPayload.anyOf[1]`	`= ""`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSExpectedPayload.anyOf[2]`	`= null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSLastCheckPayload`		`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSLastCheckPayload.anyOf[0]`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSLastCheckPayload.anyOf[0][]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSLastCheckPayload.anyOf[0][].key`	`string ["ownership","dkim","dmarc","return_path","mta_sts","tls_reporting"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSLastCheckPayload.anyOf[0][].label`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSLastCheckPayload.anyOf[0][].type`	`string ["TXT","MX"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSLastCheckPayload.anyOf[0][].host`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSLastCheckPayload.anyOf[0][].value`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSLastCheckPayload.anyOf[0][].required`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSLastCheckPayload.anyOf[0][].status`	`string ["pending","verified","missing","advisory"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSLastCheckPayload.anyOf[0][].observedValue`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSLastCheckPayload.anyOf[1]`	`= ""`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSLastCheckPayload.anyOf[2]`	`= null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSLastCheckTime`		`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSLastCheckTime.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSLastCheckTime.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].LastVerifiedTime`		`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].LastVerifiedTime.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].LastVerifiedTime.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].LastVerifiedBy-ATUser_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].LastVerifiedBy-ATUser_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].LastVerifiedBy-ATUser_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].LastVerifiedBy-ATUser_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].LastVerifiedBy-ATUser_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].ATUser_Alias`		`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].ATUser_Alias.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].ATUser_Alias.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Identity.anyOf[1]`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.DNSRecords`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.DNSRecords[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.DNSRecords[].key`	`string ["ownership","dkim","dmarc","return_path","mta_sts","tls_reporting"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.DNSRecords[].label`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.DNSRecords[].type`	`string ["TXT","MX"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.DNSRecords[].host`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.DNSRecords[].value`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.DNSRecords[].required`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.DNSRecords[].status`	`string ["pending","verified","missing","advisory"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.DNSRecords[].observedValue`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.DKIMPrivateKeyEnvironmentKey`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.DKIMPrivateKeyOneTime`	`string`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/external_messaging/set_identity",
    "RequestUserAlias": "example-user",
    "Payload": {
        "Succeeded": true,
        "Identity": {
            "ID": 0,
            "CreatedDate": "synthetic-example",
            "LastUpdateDate": "synthetic-example",
            "DeletedDate": "synthetic-example",
            "IdentityUUID": "synthetic-example",
            "ATUser_ID": 0,
            "CreatedBy-ATUser_ID": 0,
            "Channel": "email",
            "Stream": "auth",
            "Status": "PendingDNS",
            "Name": "synthetic-example",
            "FromName": "synthetic-example",
            "FromAddress": "synthetic-example",
            "DomainName": "synthetic-example",
            "ReturnPathDomain": "synthetic-example",
            "DKIMSelector": "synthetic-example",
            "DKIMPublicKey": "synthetic-example",
            "DKIMPrivateKeyEnvironmentKey": "synthetic-example",
            "VerificationToken": "synthetic-example",
            "DNSExpectedPayload": [],
            "DNSLastCheckPayload": [],
            "DNSLastCheckTime": "synthetic-example",
            "LastVerifiedTime": "synthetic-example",
            "LastVerifiedBy-ATUser_ID": 0,
            "ATUser_Alias": "synthetic-example"
        },
        "DNSRecords": [],
        "DKIMPrivateKeyEnvironmentKey": "FAKE_DKIM_ENVIRONMENT_KEY",
        "DKIMPrivateKeyOneTime": "FAKE_PRIVATE_KEY_PLACEHOLDER"
    }
}

Machine-readable endpoint documentation

POST

/v1/external_messaging/set_identity_verify_dns

#

Checks DNS records for an email sender identity and marks it verified when required records are present.

Parameters

Name	Type	Required	Default	Description
`identityID`	`int`	`No`	`0`	Sender identity ID.
`isWritingRequest`	`bool`	`No`	`false`	Must be true to record the DNS check.

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/external_messaging/set_identity_verify_dns' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'identityID={{identityID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`external_messaging_set_identity_verify_dns_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.Succeeded`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.Status`	`string ["PendingDNS","Verified"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.DNSRecords`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.DNSRecords[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.DNSRecords[].key`	`string ["ownership","dkim","dmarc","return_path","mta_sts","tls_reporting"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.DNSRecords[].label`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.DNSRecords[].type`	`string ["TXT","MX"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.DNSRecords[].host`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.DNSRecords[].value`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.DNSRecords[].required`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.DNSRecords[].status`	`string ["pending","verified","missing","advisory"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.DNSRecords[].observedValue`	`string`	`No`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/external_messaging/set_identity_verify_dns",
    "RequestUserAlias": "example-user",
    "Payload": {
        "Succeeded": true,
        "Status": "PendingDNS",
        "DNSRecords": []
    }
}

Machine-readable endpoint documentation

POST

/v1/external_messaging/set_send

#

Queues an external message. Phase one supports email only. Production email requires a verified sender identity and is charged after the first-party MTA records smtp_accepted. Sandbox messages are free and do not submit to the MTA.

Parameters

Name	Type	Required	Default	Description
`channel`	`string`	`No`	`"email"`	Channel. Phase one supports email.
`identityID`	`int`	`No`	`0`	Sender identity ID.
`to`	`string`	`No`	`""`	Comma-separated recipient email addresses.
`subject`	`string`	`No`	`""`	Message subject.
`htmlBody`	`string`	`No`	`""`	HTML body.
`textBody`	`string`	`No`	`""`	Plain text body.
`stream`	`string`	`No`	`"transactional"`	Email stream: auth, transactional, community, bulk, or sandbox.
`mode`	`string`	`No`	`"sandbox"`	sandbox or production.
`fundingAccountID`	`int`	`No`	`0`	Optional per-message AT funding account override.
`isWritingRequest`	`bool`	`No`	`false`	Must be true to queue the message.

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/external_messaging/set_send' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'channel={{channel}}' \
  --data-urlencode 'identityID={{identityID}}' \
  --data-urlencode 'to={{to}}' \
  --data-urlencode 'subject={{subject}}' \
  --data-urlencode 'htmlBody={{htmlBody}}' \
  --data-urlencode 'textBody={{textBody}}' \
  --data-urlencode 'stream={{stream}}' \
  --data-urlencode 'mode={{mode}}' \
  --data-urlencode 'fundingAccountID={{fundingAccountID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`external_messaging_set_send_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.Succeeded`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].CreatedDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].LastUpdateDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].DeletedDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].DeletedDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].DeletedDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].MessageUUID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ATUser_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ATUser_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ATUser_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ImpersonatedBy-ATUser_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ImpersonatedBy-ATUser_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ImpersonatedBy-ATUser_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ImpersonatedBy-ATUser_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ImpersonatedBy-ATUser_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Channel`	`= "email"`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Stream`	`string ["auth","transactional","community","bulk","sandbox"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Mode`	`string ["sandbox","production"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Status`	`string ["Queued","Sending","Sent","Deferred","Suppressed","Failed"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ATExternalMessagingIdentities_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ATExternalMessagingIdentities_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ATExternalMessagingIdentities_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ATExternalMessagingIdentities_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ATExternalMessagingIdentities_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Funding-ATAccounts_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Funding-ATAccounts_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Funding-ATAccounts_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Funding-ATAccounts_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Funding-ATAccounts_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Settlement-ATAccountsLedger_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Settlement-ATAccountsLedger_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Settlement-ATAccountsLedger_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Settlement-ATAccountsLedger_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Settlement-ATAccountsLedger_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ATAPIAccessLog_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ATAPIAccessLog_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ATAPIAccessLog_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ATAPIAccessLog_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ATAPIAccessLog_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Subject`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Subject.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Subject.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].RecipientsPayload`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].RecipientsPayload.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].RecipientsPayload.anyOf[0].to`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].RecipientsPayload.anyOf[0].to[]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].RecipientsPayload.anyOf[1]`	`= ""`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].RecipientsPayload.anyOf[2]`	`= null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ContentPayload`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ContentPayload.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ContentPayload.anyOf[0].htmlBody`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ContentPayload.anyOf[0].textBody`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ContentPayload.anyOf[1]`	`= ""`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ContentPayload.anyOf[2]`	`= null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].HeadersPayload`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].HeadersPayload.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].HeadersPayload.anyOf[0].From`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].HeadersPayload.anyOf[0].X-AT-External-Messaging-Stream`	`string ["auth","transactional","community","bulk","sandbox"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].HeadersPayload.anyOf[0].List-Unsubscribe`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].HeadersPayload.anyOf[0].List-Unsubscribe-Post`	`= "List-Unsubscribe=One-Click"`	`No`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].HeadersPayload.anyOf[1]`	`= ""`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].HeadersPayload.anyOf[2]`	`= null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].PriceAmount`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].PriceAmount.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].PriceAmount.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].PriceUnit`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].PriceUnit.anyOf[0]`	`string ["USD","Traderpoint"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].PriceUnit.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].RecipientCount`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].RecipientCount.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].RecipientCount.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].AttemptCount`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].AttemptCount.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].AttemptCount.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].NextAttemptDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].NextAttemptDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].NextAttemptDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].QueuedDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].QueuedDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].QueuedDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].SentDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].SentDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].SentDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].LastEventDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].LastEventDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].LastEventDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ProviderMessageID`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ProviderMessageID.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ProviderMessageID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].FailureReason`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].FailureReason.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].FailureReason.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].FromAddress`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].FromAddress.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].FromAddress.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].DomainName`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].DomainName.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].DomainName.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ATUser_Alias`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ATUser_Alias.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ATUser_Alias.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1]`	`= false`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/external_messaging/set_send",
    "RequestUserAlias": "example-user",
    "Payload": {
        "Succeeded": true,
        "Message": {
            "ID": 0,
            "CreatedDate": "synthetic-example",
            "LastUpdateDate": "synthetic-example",
            "DeletedDate": "synthetic-example",
            "MessageUUID": "synthetic-example",
            "ATUser_ID": 0,
            "ImpersonatedBy-ATUser_ID": 0,
            "Channel": "email",
            "Stream": "auth",
            "Mode": "sandbox",
            "Status": "Queued",
            "ATExternalMessagingIdentities_ID": 0,
            "Funding-ATAccounts_ID": 0,
            "Settlement-ATAccountsLedger_ID": 0,
            "ATAPIAccessLog_ID": 0,
            "Subject": "synthetic-example",
            "RecipientsPayload": {
                "to": []
            },
            "ContentPayload": {
                "htmlBody": "synthetic-example",
                "textBody": "synthetic-example"
            },
            "HeadersPayload": {
                "From": "synthetic-example",
                "X-AT-External-Messaging-Stream": "auth"
            },
            "PriceAmount": 0,
            "PriceUnit": "USD",
            "RecipientCount": 0,
            "AttemptCount": 0,
            "NextAttemptDate": "synthetic-example",
            "QueuedDate": "synthetic-example",
            "SentDate": "synthetic-example",
            "LastEventDate": "synthetic-example",
            "ProviderMessageID": "synthetic-example",
            "FailureReason": "synthetic-example",
            "FromAddress": "synthetic-example",
            "DomainName": "synthetic-example",
            "ATUser_Alias": "synthetic-example"
        }
    }
}

Machine-readable endpoint documentation

POST

/v1/external_messaging/set_suppression

#

Adds a user-level suppression for a recipient.

Parameters

Name	Type	Required	Default	Description
`channel`	`string`	`No`	`"email"`	Channel. Phase one supports email.
`recipient`	`string`	`No`	`""`	Recipient email address.
`type`	`string`	`No`	`"manual"`	Suppression type.
`reason`	`string`	`No`	`""`	Operator or application reason.
`isWritingRequest`	`bool`	`No`	`false`	Must be true to create the suppression.

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/external_messaging/set_suppression' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'channel={{channel}}' \
  --data-urlencode 'recipient={{recipient}}' \
  --data-urlencode 'type={{type}}' \
  --data-urlencode 'reason={{reason}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`external_messaging_set_suppression_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.Succeeded`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.SuppressionID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.SuppressionID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.SuppressionID.oneOf[1]`	`string`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/external_messaging/set_suppression",
    "RequestUserAlias": "example-user",
    "Payload": {
        "Succeeded": true,
        "SuppressionID": 0
    }
}

Machine-readable endpoint documentation