Administration endpoints give you the ability to see what mailing addresses are currently associated with your account as well as to retrieve information about the current user.
\nAccount Postal mailing addresses. Used for CAN SPAM compliance. Includes Address1, Address2, City, State and zip code
", "endpoints": [ { "id": "f471f438df49eda8d66cd4a4f9aee2ac", "name": "", "comments": "Create an account address.
", "methodName": "Post", "namespace": [ "Administration", "Addresses" ], "urlTemplate": "Administration/Addresses", "method": "POST", "urlParameters": [], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "d8954441369d0f705a2ad617d4a46125",
"name": "Address",
"logicalName": "Request",
"namespace": "Post",
"fullNamespace": [
"Post"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "IsDefault",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Attention",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Line1",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Line2",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Line3",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "City",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "State",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ZipCode",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Country",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "4ad04dee2c1d2bccda1f108843ba929b",
"name": "Address",
"logicalName": "Response",
"namespace": "Post",
"fullNamespace": [
"Post"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "IsDefault",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Attention",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Line1",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Line2",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Line3",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "City",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "State",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ZipCode",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Country",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "74944dd7140a4b4e57aa55b260d2fb2a",
"name": "",
"comments": "Get account addresses.
", "methodName": "Get_AccountId", "namespace": [ "Administration", "Addresses" ], "urlTemplate": "Administration/Addresses/{accountId}", "method": "GET", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "accept", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "Addresses",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Address",
"type": {
"id": "4ad04dee2c1d2bccda1f108843ba929b",
"name": "Address",
"logicalName": "Response",
"namespace": "Get_AccountId",
"fullNamespace": [
"Get_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "IsDefault",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Attention",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Line1",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Line2",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Line3",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "City",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "State",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ZipCode",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Country",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Administration/AuthenticationDomains",
"comments": "Authentication domains are used to manage DKIM key signatures for campaign sending. To create an authentication\r\ndomain, submit a domain name and optional sub-domain to the POST endpoint.
A DKIM key will automatically be generated and the model returned from the POST will include the KeyLabel and\r\nPublicDnsEntry values. The PublicDnsEntry value should be set as a DNS TXT\r\nrecord at the KeyLabel. Once the DNS changes have been completed, call the\r\nDkim/Status endpoint to check the installation. When the\r\nInstallationStatus value in that response is \"Installed\" the key is ready for use.
application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "ArrayOfAuthenticationDomainModel",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AuthenticationDomainModel",
"type": {
"id": "28c4bf510760aa053f6e0935b0116572",
"name": "AuthenticationDomainModel",
"logicalName": "Response",
"namespace": "Get",
"fullNamespace": [
"Get"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Domain",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Subdomain",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DkimKey",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "654e031ea53af13f4db6a850d789c53c",
"name": "DkimKeyModel",
"logicalName": "DkimKey",
"namespace": "DkimKey",
"fullNamespace": [
"Get",
"DkimKey"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CurrentRecord",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Domain",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Fqdn",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "KeyLabel",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "PublicDnsEntry",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Selector",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SubDomain",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "InstallationStatus",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "9903e9fbcdd4f4ce029d59358486edc4",
"name": "",
"methodName": "Post",
"namespace": [
"Administration",
"AuthenticationDomains"
],
"urlTemplate": "Administration/AuthenticationDomains",
"method": "POST",
"urlParameters": [],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "8b37ca41c3756f0aba531118d2e61777",
"name": "AuthenticationDomainRequestModel",
"logicalName": "Request",
"namespace": "Post",
"fullNamespace": [
"Post"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Domain",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Subdomain",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "28c4bf510760aa053f6e0935b0116572",
"name": "AuthenticationDomainModel",
"logicalName": "Response",
"namespace": "Post",
"fullNamespace": [
"Post"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Domain",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Subdomain",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DkimKey",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "654e031ea53af13f4db6a850d789c53c",
"name": "DkimKeyModel",
"logicalName": "DkimKey",
"namespace": "DkimKey",
"fullNamespace": [
"Post",
"DkimKey"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CurrentRecord",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Domain",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Fqdn",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "KeyLabel",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "PublicDnsEntry",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Selector",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SubDomain",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "InstallationStatus",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "8aa358c199e560f5015b1c48d1411c1c",
"name": "",
"methodName": "Get_Id",
"namespace": [
"Administration",
"AuthenticationDomains"
],
"urlTemplate": "Administration/AuthenticationDomains/{id}",
"method": "GET",
"urlParameters": [
{
"name": "id",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "28c4bf510760aa053f6e0935b0116572",
"name": "AuthenticationDomainModel",
"logicalName": "Response",
"namespace": "Get_Id",
"fullNamespace": [
"Get_Id"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Domain",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Subdomain",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DkimKey",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "654e031ea53af13f4db6a850d789c53c",
"name": "DkimKeyModel",
"logicalName": "DkimKey",
"namespace": "DkimKey",
"fullNamespace": [
"Get_Id",
"DkimKey"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CurrentRecord",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Domain",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Fqdn",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "KeyLabel",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "PublicDnsEntry",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Selector",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SubDomain",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "InstallationStatus",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "9b85f19b764730d4707b56b82dbbb755",
"name": "",
"methodName": "Delete_Id",
"namespace": [
"Administration",
"AuthenticationDomains"
],
"urlTemplate": "Administration/AuthenticationDomains/{id}",
"method": "DELETE",
"urlParameters": [
{
"name": "id",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [],
"isBinary": false,
"hasBody": false
}
}
]
},
{
"name": "/Administration/Dkim",
"comments": "These endpoints are read-only and are used to enumerate the DKIM keys in an account or check the DNS status\r\nvia the Dkim/Status endpoint.
\nCreating DKIM keys is done through the\r\nAuthenticationDomains endpoints.
", "endpoints": [ { "id": "536e9b754f7a7276775d78cac382d19d", "name": "", "methodName": "Get", "namespace": [ "Administration", "Dkim" ], "urlTemplate": "Administration/Dkim", "method": "GET", "urlParameters": [], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "accept", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "ArrayOfDkimKeyModel",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "DkimKeyModel",
"type": {
"id": "654e031ea53af13f4db6a850d789c53c",
"name": "DkimKeyModel",
"logicalName": "Response",
"namespace": "Get",
"fullNamespace": [
"Get"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CurrentRecord",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Domain",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Fqdn",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "KeyLabel",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "PublicDnsEntry",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Selector",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SubDomain",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "InstallationStatus",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "b5c3cb585b8fb61f05b4a5bdfc504f06",
"name": "",
"methodName": "Get_Id",
"namespace": [
"Administration",
"Dkim"
],
"urlTemplate": "Administration/Dkim/{id}",
"method": "GET",
"urlParameters": [
{
"name": "id",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "654e031ea53af13f4db6a850d789c53c",
"name": "DkimKeyModel",
"logicalName": "Response",
"namespace": "Get_Id",
"fullNamespace": [
"Get_Id"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CurrentRecord",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Domain",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Fqdn",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "KeyLabel",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "PublicDnsEntry",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Selector",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SubDomain",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "InstallationStatus",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Administration/Dkim/Status",
"endpoints": [
{
"id": "967c0af33aee1a76c9fa3c31acf84d29",
"name": "",
"methodName": "Get_Domain_Selector",
"namespace": [
"Administration",
"Dkim",
"Status"
],
"urlTemplate": "Administration/Dkim/Status/{domain}/{selector}",
"method": "GET",
"urlParameters": [
{
"name": "domain",
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "",
"isAuth": false
},
{
"name": "selector",
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "",
"isAuth": false
}
],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "6d788c4c2f0c47c4c379407dd91bec29",
"name": "DkimKeyMinimalModel",
"logicalName": "Response",
"namespace": "Get_Domain_Selector",
"fullNamespace": [
"Get_Domain_Selector"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "CurrentRecord",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "KeyLabel",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "InstallationStatus",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "6199c9254d0a1cac88ac1fc9d10e6aec",
"name": "",
"methodName": "Get_Id",
"namespace": [
"Administration",
"Dkim",
"Status"
],
"urlTemplate": "Administration/Dkim/Status/{id}",
"method": "GET",
"urlParameters": [
{
"name": "id",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "654e031ea53af13f4db6a850d789c53c",
"name": "DkimKeyModel",
"logicalName": "Response",
"namespace": "Get_Id",
"fullNamespace": [
"Get_Id"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CurrentRecord",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Domain",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Fqdn",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "KeyLabel",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "PublicDnsEntry",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Selector",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SubDomain",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "InstallationStatus",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Administration/Tokens",
"endpoints": [
{
"id": "ee9d6011801d5a1cb7d60470b32f0333",
"name": "",
"methodName": "Get",
"namespace": [
"Administration",
"Tokens"
],
"urlTemplate": "Administration/Tokens",
"method": "GET",
"urlParameters": [],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "ArrayOfAuthenticationTokenModel",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AuthenticationTokenModel",
"type": {
"id": "074a6d925a31b1c9f5b4bf1cb30669a3",
"name": "AuthenticationTokenModel",
"logicalName": "Response",
"namespace": "Get",
"fullNamespace": [
"Get"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Deleted",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Expires",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastUsed",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Revoked",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "0991cfca809cfba0b899b9bea3d05a37",
"name": "",
"methodName": "Post",
"namespace": [
"Administration",
"Tokens"
],
"urlTemplate": "Administration/Tokens",
"method": "POST",
"urlParameters": [],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "90029b39b27df4b0df902067e4d92064",
"name": "AuthenticationTokenRequestModel",
"logicalName": "Request",
"namespace": "Post",
"fullNamespace": [
"Post"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "38b48ac434478339ce904efc6e5ee3a8",
"name": "ResponseModel",
"logicalName": "Response",
"namespace": "Post",
"fullNamespace": [
"Post"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Secret",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Token",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "074a6d925a31b1c9f5b4bf1cb30669a3",
"name": "AuthenticationTokenModel",
"logicalName": "Token",
"namespace": "Token",
"fullNamespace": [
"Post",
"Token"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Deleted",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Expires",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastUsed",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Revoked",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "c3b351ac3535a3d1709608b3423033e6",
"name": "",
"methodName": "Get_Id",
"namespace": [
"Administration",
"Tokens"
],
"urlTemplate": "Administration/Tokens/{id}",
"method": "GET",
"urlParameters": [
{
"name": "id",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "074a6d925a31b1c9f5b4bf1cb30669a3",
"name": "AuthenticationTokenModel",
"logicalName": "Response",
"namespace": "Get_Id",
"fullNamespace": [
"Get_Id"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Deleted",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Expires",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastUsed",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Revoked",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "9511a00f68ff071d437ab23cac921ed6",
"name": "",
"methodName": "Delete_Id",
"namespace": [
"Administration",
"Tokens"
],
"urlTemplate": "Administration/Tokens/{id}",
"method": "DELETE",
"urlParameters": [
{
"name": "id",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [],
"isBinary": false,
"hasBody": false
}
}
]
},
{
"name": "/Administration/Tokens/Revoke",
"endpoints": [
{
"id": "7df0c7c4ccb86ecd3027e82fe4d42de5",
"name": "",
"methodName": "Put_Id_Revoke",
"namespace": [
"Administration",
"Tokens",
"Revoke"
],
"urlTemplate": "Administration/Tokens/{id}/Revoke",
"method": "PUT",
"urlParameters": [
{
"name": "id",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [],
"isBinary": false,
"hasBody": false
}
}
]
},
{
"name": "/Administration/Users/Current",
"comments": "Information about the current API user.
", "endpoints": [ { "id": "386666c69707932e662961982cd1325a", "name": "", "comments": "Get the currently logged in user.
", "methodName": "Get_Current", "namespace": [ "Administration", "Users", "Current" ], "urlTemplate": "Administration/Users/Current", "method": "GET", "urlParameters": [], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "accept", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "1f7cad4c79603657b73b1a991bc601b4",
"name": "User",
"logicalName": "Response",
"namespace": "Get_Current",
"fullNamespace": [
"Get_Current"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "AccountId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AccountKey",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Username",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CompanyName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Email",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
}
]
}
]
},
{
"name": "Campaigns",
"comments": "A campaign is used to send and track email sent to a list containing multiple email addresses. Reports can then be generated to evaluate the effectiveness of a given campaign. \n
\nA campaign has two required components. \n
\nOnce you have created a list and a mailing you can schedule a Campaign. Your campaign will be sent via ReachMail's SMTP servers after which you'll be able to \nrun Reports.
\nMore specific information about the campaign endpoint.
\nMessage Testing provides the ability to measure campaign effectiveness on a subset of a list prior to sending to the whole list.
", "resources": [ { "name": "/Campaigns", "comments": "Here's a sample scenario of what a campaign might look like:
\n\"Send this HTML message to these 2 lists, but exclude anyone in another list\"
\nTo send a campaign like this, follow these steps:
\n1. Create a Mailing: This will include the content (HTML, plain text, or both) you want to send.
\n2. Create List(s):
\nTwo lists should contain the email addresses of the recipients.
\nA third suppression list should contain the email addresses of those you want to exclude from receiving the email.
\nKeep in mind, the number of lists can be any number greater than 0, depending on your needs.\nA suppression list is optional.
\nOnce you have created the mailing and the lists, you will use their IDs as parameters for the campaign.
\nYou can further refine your campaign by specifying list field filters\nor tag filters to limit who within your chosen lists will receive the email. Expand the details below to see the format.
\nTo ensure everything looks right before the actual send, you can set\nthe campaign as a test using the IsTest option. \nYou can also specify the TestFormat option to have the HTML and text\nversions sent separately. Test campaigns won't appear in reporting\nand are limited to 50 recipients, allowing you to verify the final\nresult in your inbox.
Campaign management.
", "methodName": "Post_AccountId", "namespace": [ "Campaigns" ], "urlTemplate": "Campaigns/{accountId}", "method": "POST", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "2aadbd11c311d8aeeaf429298f3da52f",
"name": "QueueParameters",
"logicalName": "Request",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "ListIds",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "ListIds",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Id",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "MailingId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Properties",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "88dbf6baaf22b79b40a0d9c41e0c43bd",
"name": "MailingProperties",
"logicalName": "Properties",
"namespace": "Properties",
"fullNamespace": [
"Post_AccountId",
"Properties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "DeliveryTime",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "IsTest",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionLists",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "SuppressionLists",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Id",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TestFormat",
"optional": true,
"sampleValue": "HtmlOnly",
"deprecated": false,
"type": {
"id": "d27ebcf671ab49466c3a83a5f3b8cfcb",
"name": "string",
"namespace": "PropertiesTestFormat",
"fullNamespace": [
"Post_AccountId",
"Properties",
"PropertiesTestFormat"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "HtmlOnly",
"enumeration": {
"name": "TestFormat",
"options": [
{
"name": "HtmlOnly",
"value": "HtmlOnly"
},
{
"name": "TextAndHtml",
"value": "TextAndHtml"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Filter",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "438b86f509b956559efa1fc3ed9248ec",
"name": "Filter",
"logicalName": "Filter",
"namespace": "Filter",
"fullNamespace": [
"Post_AccountId",
"Properties",
"Filter"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Conditions",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Conditions",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Condition",
"type": {
"id": "90e095d1e3239db8d1ee7e9ad2acc797",
"name": "Condition",
"logicalName": "Conditions",
"namespace": "Conditions",
"fullNamespace": [
"Post_AccountId",
"Properties",
"Filter",
"Conditions"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Comparison",
"optional": false,
"sampleValue": "Contains",
"deprecated": false,
"type": {
"id": "089b970ee25465194615eb1c245d1492",
"name": "Comparison",
"namespace": "ConditionsComparison",
"fullNamespace": [
"Post_AccountId",
"Properties",
"Filter",
"Conditions",
"ConditionsComparison"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Contains",
"enumeration": {
"name": "Comparison",
"options": [
{
"name": "Contains",
"value": "Contains"
},
{
"name": "EndsWith",
"value": "EndsWith"
},
{
"name": "Equals",
"value": "Equals"
},
{
"name": "GreaterThan",
"value": "GreaterThan"
},
{
"name": "GreaterThanOrEqualTo",
"value": "GreaterThanOrEqualTo"
},
{
"name": "IsNull",
"value": "IsNull"
},
{
"name": "LessThan",
"value": "LessThan"
},
{
"name": "LessThanOrEqualTo",
"value": "LessThanOrEqualTo"
},
{
"name": "NotEqual",
"value": "NotEqual"
},
{
"name": "StartsWith",
"value": "StartsWith"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Property",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Value",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Operator",
"optional": false,
"sampleValue": "And",
"deprecated": false,
"type": {
"id": "7d4d97fb094c1c81383d8954d6eed781",
"name": "Operator",
"namespace": "FilterOperator",
"fullNamespace": [
"Post_AccountId",
"Properties",
"Filter",
"FilterOperator"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "And",
"enumeration": {
"name": "Operator",
"options": [
{
"name": "And",
"value": "And"
},
{
"name": "Or",
"value": "Or"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TagIds",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagIds",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "uuid",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagExclusionIds",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagExclusionIds",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "uuid",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "CampaignProfileId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "TagEvents",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagEvents",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "TagEvent",
"type": {
"id": "030b7729eb5bb1ecc311239f61f5376f",
"name": "TagEvent",
"logicalName": "TagEvents",
"namespace": "TagEvents",
"fullNamespace": [
"Post_AccountId",
"TagEvents"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "TagId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EventType",
"optional": false,
"sampleValue": "Open",
"deprecated": false,
"type": {
"id": "89c412814a529274451cd13b355e823d",
"name": "string",
"namespace": "TagEventsEventType",
"fullNamespace": [
"Post_AccountId",
"TagEvents",
"TagEventsEventType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "LinkClick",
"enumeration": {
"name": "TagEventTypes",
"options": [
{
"name": "LinkClick",
"value": "LinkClick"
},
{
"name": "Open",
"value": "Open"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "9150e36bd6f6703d4f073ddc86d95b66",
"name": "Queue",
"logicalName": "Response",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Campaigns/Approve",
"comments": "Approve campaigns that are in AwaitingApproval state.
Approve campaign.
", "methodName": "Post_CampaignId", "namespace": [ "Campaigns", "Approve" ], "urlTemplate": "Campaigns/Approve/{campaignId}", "method": "POST", "urlParameters": [ { "name": "campaignId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "4037672b691ae03d7e03084f257e0d73",
"name": "CampaignApproval",
"logicalName": "Request",
"namespace": "Post_CampaignId",
"fullNamespace": [
"Post_CampaignId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Action",
"optional": false,
"sampleValue": "Approve",
"deprecated": false,
"type": {
"id": "839e0b0373ec0ea2ebfad4f2c28948eb",
"name": "Action",
"namespace": "RequestAction",
"fullNamespace": [
"Post_CampaignId",
"RequestAction"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Approve",
"enumeration": {
"name": "Action",
"options": [
{
"name": "Approve",
"value": "Approve"
},
{
"name": "Decline",
"value": "Decline"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "9150e36bd6f6703d4f073ddc86d95b66",
"name": "Queue",
"logicalName": "Response",
"namespace": "Post_CampaignId",
"fullNamespace": [
"Post_CampaignId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Campaigns/AutoMessages",
"comments": "The AutoMessage endpoints can be used to configure recurring messages to a list. To schedule an\r\nauto message campaign, a recipient list, and mailing content are required.
\nEndpoints to create and access lists are documented in the Lists section.\r\nEndpoints to create and access mailings are documented in the Mailings\r\nsection.
\nWhen creating new AutoMessages the default active state is false. After reviewing the model\r\nreturned by the POST request, send a PUT request setting Active to true in the request\r\nmodel to activate the AutoMessage.
application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "ArrayOfAutoMessageModel",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageModel",
"type": {
"id": "89d70a60a6402d128080ae9613742bd1",
"name": "AutoMessageModel",
"logicalName": "Response",
"namespace": "Get",
"fullNamespace": [
"Get"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Active",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastRun",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AccountId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CampaignId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "RecipientList",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "e9ee2b472d3b384f1c3552b49f093dd0",
"name": "AutoMessageListModel",
"logicalName": "RecipientList",
"namespace": "RecipientList",
"fullNamespace": [
"Get",
"RecipientList"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailingContent",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "8f7227e53233ac33de5c4400ac457515",
"name": "AutoMessageContentModel",
"logicalName": "MailingContent",
"namespace": "MailingContent",
"fullNamespace": [
"Get",
"MailingContent"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionType",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "a46801ddad089872a01f7ae8b9577982",
"name": "string",
"namespace": "ResponseSuppressionType",
"fullNamespace": [
"Get",
"ResponseSuppressionType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "DomainName",
"enumeration": {
"name": "SuppressionType",
"options": [
{
"name": "DomainName",
"value": "DomainName"
},
{
"name": "EmailAddress",
"value": "EmailAddress"
},
{
"name": "Md5",
"value": "Md5"
},
{
"name": "None",
"value": "None"
},
{
"name": "Standard",
"value": "Standard"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionLists",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "SuppressionLists",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageListModel",
"type": {
"id": "e9ee2b472d3b384f1c3552b49f093dd0",
"name": "AutoMessageListModel",
"logicalName": "SuppressionLists",
"namespace": "SuppressionLists",
"fullNamespace": [
"Get",
"SuppressionLists"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Segments",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Segments",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageSegmentModel",
"type": {
"id": "55768ce022065f3014c94ddc304143c9",
"name": "AutoMessageSegmentModel",
"logicalName": "Segments",
"namespace": "Segments",
"fullNamespace": [
"Get",
"Segments"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagIncludes",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagIncludes",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageTagModel",
"type": {
"id": "9d9839846a62840adc90df08c820c326",
"name": "AutoMessageTagModel",
"logicalName": "TagIncludes",
"namespace": "TagIncludes",
"fullNamespace": [
"Get",
"TagIncludes"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagExcludes",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagExcludes",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageTagModel",
"type": {
"id": "9d9839846a62840adc90df08c820c326",
"name": "AutoMessageTagModel",
"logicalName": "TagExcludes",
"namespace": "TagExcludes",
"fullNamespace": [
"Get",
"TagExcludes"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TriggerType",
"optional": false,
"sampleValue": "RecipientDateFieldMatch",
"deprecated": false,
"type": {
"id": "0b8ffc92086f2c24559effd93dfdf44d",
"name": "string",
"namespace": "ResponseTriggerType",
"fullNamespace": [
"Get",
"ResponseTriggerType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "ImmediateRecipientCreated",
"enumeration": {
"name": "AutoMessageTriggerType",
"options": [
{
"name": "ImmediateRecipientCreated",
"value": "ImmediateRecipientCreated"
},
{
"name": "RecipientDateFieldMatch",
"value": "RecipientDateFieldMatch"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TriggerProperties",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "2d085c96346bfdffb8514a9e5f8639a9",
"name": "RecipientDateFieldTriggerModel",
"logicalName": "TriggerProperties",
"namespace": "TriggerProperties",
"fullNamespace": [
"Get",
"TriggerProperties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "CompareRecipientFieldName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DateScope",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "ac4b980691ec98804e11381aa6916fa7",
"name": "string",
"namespace": "TriggerPropertiesDateScope",
"fullNamespace": [
"Get",
"TriggerProperties",
"TriggerPropertiesDateScope"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Date",
"enumeration": {
"name": "DateScope",
"options": [
{
"name": "Date",
"value": "Date"
},
{
"name": "Month",
"value": "Month"
},
{
"name": "None",
"value": "None"
},
{
"name": "WeekOfYear",
"value": "WeekOfYear"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DayModifier",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ScheduledTime",
"comments": "Note: Time spans are formatted as d.hh:mm:ss.n.",
"optional": false,
"sampleValue": "0:00:00",
"deprecated": false,
"type": {
"name": "duration",
"isNullable": false,
"isSimple": true,
"sampleValue": "0:00:00",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "NextScheduledRun",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CurrentState",
"optional": false,
"sampleValue": "AwaitingFirstRun",
"deprecated": false,
"type": {
"id": "64c9db3ab85a9df76c1793b72d869994",
"name": "string",
"namespace": "TriggerPropertiesCurrentState",
"fullNamespace": [
"Get",
"TriggerProperties",
"TriggerPropertiesCurrentState"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "AwaitingFirstRun",
"enumeration": {
"name": "State",
"options": [
{
"name": "AwaitingFirstRun",
"value": "AwaitingFirstRun"
},
{
"name": "Complete",
"value": "Complete"
},
{
"name": "Executing",
"value": "Executing"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "f391b2fc5bb7ce5ab91ab0c95b67e09c",
"name": "",
"methodName": "Post",
"namespace": [
"Campaigns",
"AutoMessages"
],
"urlTemplate": "Campaigns/AutoMessages",
"method": "POST",
"urlParameters": [],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "0f29c8958974b9f2ed16427e9d0a2317",
"name": "AutoMessageRequestModel",
"logicalName": "Request",
"namespace": "Post",
"fullNamespace": [
"Post"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "RecipientList",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "e9ee2b472d3b384f1c3552b49f093dd0",
"name": "AutoMessageListModel",
"logicalName": "RecipientList",
"namespace": "RecipientList",
"fullNamespace": [
"Post",
"RecipientList"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailingContent",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "8f7227e53233ac33de5c4400ac457515",
"name": "AutoMessageContentModel",
"logicalName": "MailingContent",
"namespace": "MailingContent",
"fullNamespace": [
"Post",
"MailingContent"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionType",
"comments": "Required when using suppression lists.",
"optional": true,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "a46801ddad089872a01f7ae8b9577982",
"name": "string",
"namespace": "RequestSuppressionType",
"fullNamespace": [
"Post",
"RequestSuppressionType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "DomainName",
"enumeration": {
"name": "SuppressionType",
"options": [
{
"name": "DomainName",
"value": "DomainName"
},
{
"name": "EmailAddress",
"value": "EmailAddress"
},
{
"name": "Md5",
"value": "Md5"
},
{
"name": "None",
"value": "None"
},
{
"name": "Standard",
"value": "Standard"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionLists",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "SuppressionLists",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageListModel",
"type": {
"id": "e9ee2b472d3b384f1c3552b49f093dd0",
"name": "AutoMessageListModel",
"logicalName": "SuppressionLists",
"namespace": "SuppressionLists",
"fullNamespace": [
"Post",
"SuppressionLists"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Segments",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Segments",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageSegmentModel",
"type": {
"id": "55768ce022065f3014c94ddc304143c9",
"name": "AutoMessageSegmentModel",
"logicalName": "Segments",
"namespace": "Segments",
"fullNamespace": [
"Post",
"Segments"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagIncludes",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagIncludes",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageTagModel",
"type": {
"id": "9d9839846a62840adc90df08c820c326",
"name": "AutoMessageTagModel",
"logicalName": "TagIncludes",
"namespace": "TagIncludes",
"fullNamespace": [
"Post",
"TagIncludes"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagExcludes",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagExcludes",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageTagModel",
"type": {
"id": "9d9839846a62840adc90df08c820c326",
"name": "AutoMessageTagModel",
"logicalName": "TagExcludes",
"namespace": "TagExcludes",
"fullNamespace": [
"Post",
"TagExcludes"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TriggerType",
"optional": true,
"sampleValue": "RecipientDateFieldMatch",
"deprecated": false,
"type": {
"id": "0b8ffc92086f2c24559effd93dfdf44d",
"name": "string",
"namespace": "RequestTriggerType",
"fullNamespace": [
"Post",
"RequestTriggerType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "ImmediateRecipientCreated",
"enumeration": {
"name": "AutoMessageTriggerType",
"options": [
{
"name": "ImmediateRecipientCreated",
"value": "ImmediateRecipientCreated"
},
{
"name": "RecipientDateFieldMatch",
"value": "RecipientDateFieldMatch"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TriggerProperties",
"comments": "Required when trigger type is RecipientDateFieldMatch",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "610fb9c150a54eb6efb4a22f0123e19a",
"name": "RecipientDateFieldTriggerRequestModel",
"logicalName": "TriggerProperties",
"namespace": "TriggerProperties",
"fullNamespace": [
"Post",
"TriggerProperties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "CompareRecipientFieldName",
"comments": "The name of the recipient field to evaluate, e.g. birthday. This field must be in the chosen recipient list.",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DateScope",
"comments": "The date scope in which the auto message runs. E.g. use 'week' to run an auto message a week before the date stored in CompareRecipientFieldName.",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "ac4b980691ec98804e11381aa6916fa7",
"name": "string",
"namespace": "TriggerPropertiesDateScope",
"fullNamespace": [
"Post",
"TriggerProperties",
"TriggerPropertiesDateScope"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Date",
"enumeration": {
"name": "DateScope",
"options": [
{
"name": "Date",
"value": "Date"
},
{
"name": "Month",
"value": "Month"
},
{
"name": "None",
"value": "None"
},
{
"name": "WeekOfYear",
"value": "WeekOfYear"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DayModifier",
"comments": "An offset to the date scope which can be negative. E.g. use -2 with a DateScope of 'Date' to run an auto message 2 days before the date in CompareRecipientFieldName.",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ScheduledTime",
"comments": "The time of day at which to run the auto message. E.g. 09:00:00, 14:00:00, etc. Note: Time spans are formatted as d.hh:mm:ss.n.",
"optional": false,
"sampleValue": "0:00:00",
"deprecated": false,
"type": {
"name": "duration",
"isNullable": false,
"isSimple": true,
"sampleValue": "0:00:00",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "89d70a60a6402d128080ae9613742bd1",
"name": "AutoMessageModel",
"logicalName": "Response",
"namespace": "Post",
"fullNamespace": [
"Post"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Active",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastRun",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AccountId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CampaignId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "RecipientList",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "e9ee2b472d3b384f1c3552b49f093dd0",
"name": "AutoMessageListModel",
"logicalName": "RecipientList",
"namespace": "RecipientList",
"fullNamespace": [
"Post",
"RecipientList"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailingContent",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "8f7227e53233ac33de5c4400ac457515",
"name": "AutoMessageContentModel",
"logicalName": "MailingContent",
"namespace": "MailingContent",
"fullNamespace": [
"Post",
"MailingContent"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionType",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "a46801ddad089872a01f7ae8b9577982",
"name": "string",
"namespace": "ResponseSuppressionType",
"fullNamespace": [
"Post",
"ResponseSuppressionType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "DomainName",
"enumeration": {
"name": "SuppressionType",
"options": [
{
"name": "DomainName",
"value": "DomainName"
},
{
"name": "EmailAddress",
"value": "EmailAddress"
},
{
"name": "Md5",
"value": "Md5"
},
{
"name": "None",
"value": "None"
},
{
"name": "Standard",
"value": "Standard"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionLists",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "SuppressionLists",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageListModel",
"type": {
"id": "e9ee2b472d3b384f1c3552b49f093dd0",
"name": "AutoMessageListModel",
"logicalName": "SuppressionLists",
"namespace": "SuppressionLists",
"fullNamespace": [
"Post",
"SuppressionLists"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Segments",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Segments",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageSegmentModel",
"type": {
"id": "55768ce022065f3014c94ddc304143c9",
"name": "AutoMessageSegmentModel",
"logicalName": "Segments",
"namespace": "Segments",
"fullNamespace": [
"Post",
"Segments"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagIncludes",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagIncludes",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageTagModel",
"type": {
"id": "9d9839846a62840adc90df08c820c326",
"name": "AutoMessageTagModel",
"logicalName": "TagIncludes",
"namespace": "TagIncludes",
"fullNamespace": [
"Post",
"TagIncludes"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagExcludes",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagExcludes",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageTagModel",
"type": {
"id": "9d9839846a62840adc90df08c820c326",
"name": "AutoMessageTagModel",
"logicalName": "TagExcludes",
"namespace": "TagExcludes",
"fullNamespace": [
"Post",
"TagExcludes"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TriggerType",
"optional": false,
"sampleValue": "RecipientDateFieldMatch",
"deprecated": false,
"type": {
"id": "0b8ffc92086f2c24559effd93dfdf44d",
"name": "string",
"namespace": "ResponseTriggerType",
"fullNamespace": [
"Post",
"ResponseTriggerType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "ImmediateRecipientCreated",
"enumeration": {
"name": "AutoMessageTriggerType",
"options": [
{
"name": "ImmediateRecipientCreated",
"value": "ImmediateRecipientCreated"
},
{
"name": "RecipientDateFieldMatch",
"value": "RecipientDateFieldMatch"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TriggerProperties",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "2d085c96346bfdffb8514a9e5f8639a9",
"name": "RecipientDateFieldTriggerModel",
"logicalName": "TriggerProperties",
"namespace": "TriggerProperties",
"fullNamespace": [
"Post",
"TriggerProperties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "CompareRecipientFieldName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DateScope",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "ac4b980691ec98804e11381aa6916fa7",
"name": "string",
"namespace": "TriggerPropertiesDateScope",
"fullNamespace": [
"Post",
"TriggerProperties",
"TriggerPropertiesDateScope"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Date",
"enumeration": {
"name": "DateScope",
"options": [
{
"name": "Date",
"value": "Date"
},
{
"name": "Month",
"value": "Month"
},
{
"name": "None",
"value": "None"
},
{
"name": "WeekOfYear",
"value": "WeekOfYear"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DayModifier",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ScheduledTime",
"comments": "Note: Time spans are formatted as d.hh:mm:ss.n.",
"optional": false,
"sampleValue": "0:00:00",
"deprecated": false,
"type": {
"name": "duration",
"isNullable": false,
"isSimple": true,
"sampleValue": "0:00:00",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "NextScheduledRun",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CurrentState",
"optional": false,
"sampleValue": "AwaitingFirstRun",
"deprecated": false,
"type": {
"id": "64c9db3ab85a9df76c1793b72d869994",
"name": "string",
"namespace": "TriggerPropertiesCurrentState",
"fullNamespace": [
"Post",
"TriggerProperties",
"TriggerPropertiesCurrentState"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "AwaitingFirstRun",
"enumeration": {
"name": "State",
"options": [
{
"name": "AwaitingFirstRun",
"value": "AwaitingFirstRun"
},
{
"name": "Complete",
"value": "Complete"
},
{
"name": "Executing",
"value": "Executing"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "7be8610bdb88b1f2119cfda390d04899",
"name": "",
"methodName": "Get_Id",
"namespace": [
"Campaigns",
"AutoMessages"
],
"urlTemplate": "Campaigns/AutoMessages/{id}",
"method": "GET",
"urlParameters": [
{
"name": "id",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "89d70a60a6402d128080ae9613742bd1",
"name": "AutoMessageModel",
"logicalName": "Response",
"namespace": "Get_Id",
"fullNamespace": [
"Get_Id"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Active",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastRun",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AccountId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CampaignId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "RecipientList",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "e9ee2b472d3b384f1c3552b49f093dd0",
"name": "AutoMessageListModel",
"logicalName": "RecipientList",
"namespace": "RecipientList",
"fullNamespace": [
"Get_Id",
"RecipientList"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailingContent",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "8f7227e53233ac33de5c4400ac457515",
"name": "AutoMessageContentModel",
"logicalName": "MailingContent",
"namespace": "MailingContent",
"fullNamespace": [
"Get_Id",
"MailingContent"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionType",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "a46801ddad089872a01f7ae8b9577982",
"name": "string",
"namespace": "ResponseSuppressionType",
"fullNamespace": [
"Get_Id",
"ResponseSuppressionType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "DomainName",
"enumeration": {
"name": "SuppressionType",
"options": [
{
"name": "DomainName",
"value": "DomainName"
},
{
"name": "EmailAddress",
"value": "EmailAddress"
},
{
"name": "Md5",
"value": "Md5"
},
{
"name": "None",
"value": "None"
},
{
"name": "Standard",
"value": "Standard"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionLists",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "SuppressionLists",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageListModel",
"type": {
"id": "e9ee2b472d3b384f1c3552b49f093dd0",
"name": "AutoMessageListModel",
"logicalName": "SuppressionLists",
"namespace": "SuppressionLists",
"fullNamespace": [
"Get_Id",
"SuppressionLists"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Segments",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Segments",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageSegmentModel",
"type": {
"id": "55768ce022065f3014c94ddc304143c9",
"name": "AutoMessageSegmentModel",
"logicalName": "Segments",
"namespace": "Segments",
"fullNamespace": [
"Get_Id",
"Segments"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagIncludes",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagIncludes",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageTagModel",
"type": {
"id": "9d9839846a62840adc90df08c820c326",
"name": "AutoMessageTagModel",
"logicalName": "TagIncludes",
"namespace": "TagIncludes",
"fullNamespace": [
"Get_Id",
"TagIncludes"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagExcludes",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagExcludes",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageTagModel",
"type": {
"id": "9d9839846a62840adc90df08c820c326",
"name": "AutoMessageTagModel",
"logicalName": "TagExcludes",
"namespace": "TagExcludes",
"fullNamespace": [
"Get_Id",
"TagExcludes"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TriggerType",
"optional": false,
"sampleValue": "RecipientDateFieldMatch",
"deprecated": false,
"type": {
"id": "0b8ffc92086f2c24559effd93dfdf44d",
"name": "string",
"namespace": "ResponseTriggerType",
"fullNamespace": [
"Get_Id",
"ResponseTriggerType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "ImmediateRecipientCreated",
"enumeration": {
"name": "AutoMessageTriggerType",
"options": [
{
"name": "ImmediateRecipientCreated",
"value": "ImmediateRecipientCreated"
},
{
"name": "RecipientDateFieldMatch",
"value": "RecipientDateFieldMatch"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TriggerProperties",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "2d085c96346bfdffb8514a9e5f8639a9",
"name": "RecipientDateFieldTriggerModel",
"logicalName": "TriggerProperties",
"namespace": "TriggerProperties",
"fullNamespace": [
"Get_Id",
"TriggerProperties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "CompareRecipientFieldName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DateScope",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "ac4b980691ec98804e11381aa6916fa7",
"name": "string",
"namespace": "TriggerPropertiesDateScope",
"fullNamespace": [
"Get_Id",
"TriggerProperties",
"TriggerPropertiesDateScope"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Date",
"enumeration": {
"name": "DateScope",
"options": [
{
"name": "Date",
"value": "Date"
},
{
"name": "Month",
"value": "Month"
},
{
"name": "None",
"value": "None"
},
{
"name": "WeekOfYear",
"value": "WeekOfYear"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DayModifier",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ScheduledTime",
"comments": "Note: Time spans are formatted as d.hh:mm:ss.n.",
"optional": false,
"sampleValue": "0:00:00",
"deprecated": false,
"type": {
"name": "duration",
"isNullable": false,
"isSimple": true,
"sampleValue": "0:00:00",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "NextScheduledRun",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CurrentState",
"optional": false,
"sampleValue": "AwaitingFirstRun",
"deprecated": false,
"type": {
"id": "64c9db3ab85a9df76c1793b72d869994",
"name": "string",
"namespace": "TriggerPropertiesCurrentState",
"fullNamespace": [
"Get_Id",
"TriggerProperties",
"TriggerPropertiesCurrentState"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "AwaitingFirstRun",
"enumeration": {
"name": "State",
"options": [
{
"name": "AwaitingFirstRun",
"value": "AwaitingFirstRun"
},
{
"name": "Complete",
"value": "Complete"
},
{
"name": "Executing",
"value": "Executing"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "9992eb79ce46c5582dd7e34d81afdc1b",
"name": "",
"methodName": "Put_Id",
"namespace": [
"Campaigns",
"AutoMessages"
],
"urlTemplate": "Campaigns/AutoMessages/{id}",
"method": "PUT",
"urlParameters": [
{
"name": "id",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "c62133bbccddb1742381b2103b97816e",
"name": "AutoMessageUpdateModel",
"logicalName": "Request",
"namespace": "Put_Id",
"fullNamespace": [
"Put_Id"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Active",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailingContentId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionLists",
"comments": "Only used on /Campaigns/AutoMessages/{id}/Filter/Suppression. Lists in this collection replace existing suppression lists. An empty collection removes existing suppression.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "SuppressionLists",
"comments": "Only used on /Campaigns/AutoMessages/{id}/Filter/Suppression. Lists in this collection replace existing suppression lists. An empty collection removes existing suppression.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageListModel",
"type": {
"id": "e9ee2b472d3b384f1c3552b49f093dd0",
"name": "AutoMessageListModel",
"logicalName": "SuppressionLists",
"namespace": "SuppressionLists",
"fullNamespace": [
"Put_Id",
"SuppressionLists"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "SuppressionType",
"comments": "Only used on /Campaigns/AutoMessages/{id}/Filter/Suppression.",
"optional": true,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "a46801ddad089872a01f7ae8b9577982",
"name": "string",
"namespace": "RequestSuppressionType",
"fullNamespace": [
"Put_Id",
"RequestSuppressionType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "DomainName",
"enumeration": {
"name": "SuppressionType",
"options": [
{
"name": "DomainName",
"value": "DomainName"
},
{
"name": "EmailAddress",
"value": "EmailAddress"
},
{
"name": "Md5",
"value": "Md5"
},
{
"name": "None",
"value": "None"
},
{
"name": "Standard",
"value": "Standard"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Segments",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Segments. Segments in this collection replace existing segments. An empty collection removes existing segments.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Segments",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Segments. Segments in this collection replace existing segments. An empty collection removes existing segments.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageSegmentModel",
"type": {
"id": "55768ce022065f3014c94ddc304143c9",
"name": "AutoMessageSegmentModel",
"logicalName": "Segments",
"namespace": "Segments",
"fullNamespace": [
"Put_Id",
"Segments"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagIncludes",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Tags/Include. Tags in this collection replace existing include tags. An empty collection removes existing include tags.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagIncludes",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Tags/Include. Tags in this collection replace existing include tags. An empty collection removes existing include tags.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageTagModel",
"type": {
"id": "9d9839846a62840adc90df08c820c326",
"name": "AutoMessageTagModel",
"logicalName": "TagIncludes",
"namespace": "TagIncludes",
"fullNamespace": [
"Put_Id",
"TagIncludes"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagExcludes",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Tags/Exclude. Tags in this collection replace existing exclude tags. An empty collection removes existing exclude tags.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagExcludes",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Tags/Exclude. Tags in this collection replace existing exclude tags. An empty collection removes existing exclude tags.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageTagModel",
"type": {
"id": "9d9839846a62840adc90df08c820c326",
"name": "AutoMessageTagModel",
"logicalName": "TagExcludes",
"namespace": "TagExcludes",
"fullNamespace": [
"Put_Id",
"TagExcludes"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "89d70a60a6402d128080ae9613742bd1",
"name": "AutoMessageModel",
"logicalName": "Response",
"namespace": "Put_Id",
"fullNamespace": [
"Put_Id"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Active",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastRun",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AccountId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CampaignId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "RecipientList",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "e9ee2b472d3b384f1c3552b49f093dd0",
"name": "AutoMessageListModel",
"logicalName": "RecipientList",
"namespace": "RecipientList",
"fullNamespace": [
"Put_Id",
"RecipientList"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailingContent",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "8f7227e53233ac33de5c4400ac457515",
"name": "AutoMessageContentModel",
"logicalName": "MailingContent",
"namespace": "MailingContent",
"fullNamespace": [
"Put_Id",
"MailingContent"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionType",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "a46801ddad089872a01f7ae8b9577982",
"name": "string",
"namespace": "ResponseSuppressionType",
"fullNamespace": [
"Put_Id",
"ResponseSuppressionType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "DomainName",
"enumeration": {
"name": "SuppressionType",
"options": [
{
"name": "DomainName",
"value": "DomainName"
},
{
"name": "EmailAddress",
"value": "EmailAddress"
},
{
"name": "Md5",
"value": "Md5"
},
{
"name": "None",
"value": "None"
},
{
"name": "Standard",
"value": "Standard"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionLists",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "SuppressionLists",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageListModel",
"type": {
"id": "e9ee2b472d3b384f1c3552b49f093dd0",
"name": "AutoMessageListModel",
"logicalName": "SuppressionLists",
"namespace": "SuppressionLists",
"fullNamespace": [
"Put_Id",
"SuppressionLists"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Segments",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Segments",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageSegmentModel",
"type": {
"id": "55768ce022065f3014c94ddc304143c9",
"name": "AutoMessageSegmentModel",
"logicalName": "Segments",
"namespace": "Segments",
"fullNamespace": [
"Put_Id",
"Segments"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagIncludes",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagIncludes",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageTagModel",
"type": {
"id": "9d9839846a62840adc90df08c820c326",
"name": "AutoMessageTagModel",
"logicalName": "TagIncludes",
"namespace": "TagIncludes",
"fullNamespace": [
"Put_Id",
"TagIncludes"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagExcludes",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagExcludes",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageTagModel",
"type": {
"id": "9d9839846a62840adc90df08c820c326",
"name": "AutoMessageTagModel",
"logicalName": "TagExcludes",
"namespace": "TagExcludes",
"fullNamespace": [
"Put_Id",
"TagExcludes"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TriggerType",
"optional": false,
"sampleValue": "RecipientDateFieldMatch",
"deprecated": false,
"type": {
"id": "0b8ffc92086f2c24559effd93dfdf44d",
"name": "string",
"namespace": "ResponseTriggerType",
"fullNamespace": [
"Put_Id",
"ResponseTriggerType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "ImmediateRecipientCreated",
"enumeration": {
"name": "AutoMessageTriggerType",
"options": [
{
"name": "ImmediateRecipientCreated",
"value": "ImmediateRecipientCreated"
},
{
"name": "RecipientDateFieldMatch",
"value": "RecipientDateFieldMatch"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TriggerProperties",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "2d085c96346bfdffb8514a9e5f8639a9",
"name": "RecipientDateFieldTriggerModel",
"logicalName": "TriggerProperties",
"namespace": "TriggerProperties",
"fullNamespace": [
"Put_Id",
"TriggerProperties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "CompareRecipientFieldName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DateScope",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "ac4b980691ec98804e11381aa6916fa7",
"name": "string",
"namespace": "TriggerPropertiesDateScope",
"fullNamespace": [
"Put_Id",
"TriggerProperties",
"TriggerPropertiesDateScope"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Date",
"enumeration": {
"name": "DateScope",
"options": [
{
"name": "Date",
"value": "Date"
},
{
"name": "Month",
"value": "Month"
},
{
"name": "None",
"value": "None"
},
{
"name": "WeekOfYear",
"value": "WeekOfYear"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DayModifier",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ScheduledTime",
"comments": "Note: Time spans are formatted as d.hh:mm:ss.n.",
"optional": false,
"sampleValue": "0:00:00",
"deprecated": false,
"type": {
"name": "duration",
"isNullable": false,
"isSimple": true,
"sampleValue": "0:00:00",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "NextScheduledRun",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CurrentState",
"optional": false,
"sampleValue": "AwaitingFirstRun",
"deprecated": false,
"type": {
"id": "64c9db3ab85a9df76c1793b72d869994",
"name": "string",
"namespace": "TriggerPropertiesCurrentState",
"fullNamespace": [
"Put_Id",
"TriggerProperties",
"TriggerPropertiesCurrentState"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "AwaitingFirstRun",
"enumeration": {
"name": "State",
"options": [
{
"name": "AwaitingFirstRun",
"value": "AwaitingFirstRun"
},
{
"name": "Complete",
"value": "Complete"
},
{
"name": "Executing",
"value": "Executing"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Campaigns/AutoMessages/Filter/Segment",
"comments": "The AutoMessage endpoints can be used to configure recurring messages to a list. To schedule an\r\nauto message campaign, a recipient list, and mailing content are required.
\nEndpoints to create and access lists are documented in the Lists section.\r\nEndpoints to create and access mailings are documented in the Mailings\r\nsection.
\nWhen creating new AutoMessages the default active state is false. After reviewing the model\r\nreturned by the POST request, send a PUT request setting Active to true in the request\r\nmodel to activate the AutoMessage.
application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "c62133bbccddb1742381b2103b97816e",
"name": "AutoMessageUpdateModel",
"logicalName": "Request",
"namespace": "Put_Id_Filter_Segment",
"fullNamespace": [
"Put_Id_Filter_Segment"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Active",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailingContentId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionLists",
"comments": "Only used on /Campaigns/AutoMessages/{id}/Filter/Suppression. Lists in this collection replace existing suppression lists. An empty collection removes existing suppression.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "SuppressionLists",
"comments": "Only used on /Campaigns/AutoMessages/{id}/Filter/Suppression. Lists in this collection replace existing suppression lists. An empty collection removes existing suppression.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageListModel",
"type": {
"id": "e9ee2b472d3b384f1c3552b49f093dd0",
"name": "AutoMessageListModel",
"logicalName": "SuppressionLists",
"namespace": "SuppressionLists",
"fullNamespace": [
"Put_Id_Filter_Segment",
"SuppressionLists"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "SuppressionType",
"comments": "Only used on /Campaigns/AutoMessages/{id}/Filter/Suppression.",
"optional": true,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "a46801ddad089872a01f7ae8b9577982",
"name": "string",
"namespace": "RequestSuppressionType",
"fullNamespace": [
"Put_Id_Filter_Segment",
"RequestSuppressionType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "DomainName",
"enumeration": {
"name": "SuppressionType",
"options": [
{
"name": "DomainName",
"value": "DomainName"
},
{
"name": "EmailAddress",
"value": "EmailAddress"
},
{
"name": "Md5",
"value": "Md5"
},
{
"name": "None",
"value": "None"
},
{
"name": "Standard",
"value": "Standard"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Segments",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Segments. Segments in this collection replace existing segments. An empty collection removes existing segments.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Segments",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Segments. Segments in this collection replace existing segments. An empty collection removes existing segments.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageSegmentModel",
"type": {
"id": "55768ce022065f3014c94ddc304143c9",
"name": "AutoMessageSegmentModel",
"logicalName": "Segments",
"namespace": "Segments",
"fullNamespace": [
"Put_Id_Filter_Segment",
"Segments"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagIncludes",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Tags/Include. Tags in this collection replace existing include tags. An empty collection removes existing include tags.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagIncludes",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Tags/Include. Tags in this collection replace existing include tags. An empty collection removes existing include tags.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageTagModel",
"type": {
"id": "9d9839846a62840adc90df08c820c326",
"name": "AutoMessageTagModel",
"logicalName": "TagIncludes",
"namespace": "TagIncludes",
"fullNamespace": [
"Put_Id_Filter_Segment",
"TagIncludes"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagExcludes",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Tags/Exclude. Tags in this collection replace existing exclude tags. An empty collection removes existing exclude tags.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagExcludes",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Tags/Exclude. Tags in this collection replace existing exclude tags. An empty collection removes existing exclude tags.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageTagModel",
"type": {
"id": "9d9839846a62840adc90df08c820c326",
"name": "AutoMessageTagModel",
"logicalName": "TagExcludes",
"namespace": "TagExcludes",
"fullNamespace": [
"Put_Id_Filter_Segment",
"TagExcludes"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "89d70a60a6402d128080ae9613742bd1",
"name": "AutoMessageModel",
"logicalName": "Response",
"namespace": "Put_Id_Filter_Segment",
"fullNamespace": [
"Put_Id_Filter_Segment"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Active",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastRun",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AccountId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CampaignId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "RecipientList",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "e9ee2b472d3b384f1c3552b49f093dd0",
"name": "AutoMessageListModel",
"logicalName": "RecipientList",
"namespace": "RecipientList",
"fullNamespace": [
"Put_Id_Filter_Segment",
"RecipientList"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailingContent",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "8f7227e53233ac33de5c4400ac457515",
"name": "AutoMessageContentModel",
"logicalName": "MailingContent",
"namespace": "MailingContent",
"fullNamespace": [
"Put_Id_Filter_Segment",
"MailingContent"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionType",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "a46801ddad089872a01f7ae8b9577982",
"name": "string",
"namespace": "ResponseSuppressionType",
"fullNamespace": [
"Put_Id_Filter_Segment",
"ResponseSuppressionType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "DomainName",
"enumeration": {
"name": "SuppressionType",
"options": [
{
"name": "DomainName",
"value": "DomainName"
},
{
"name": "EmailAddress",
"value": "EmailAddress"
},
{
"name": "Md5",
"value": "Md5"
},
{
"name": "None",
"value": "None"
},
{
"name": "Standard",
"value": "Standard"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionLists",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "SuppressionLists",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageListModel",
"type": {
"id": "e9ee2b472d3b384f1c3552b49f093dd0",
"name": "AutoMessageListModel",
"logicalName": "SuppressionLists",
"namespace": "SuppressionLists",
"fullNamespace": [
"Put_Id_Filter_Segment",
"SuppressionLists"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Segments",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Segments",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageSegmentModel",
"type": {
"id": "55768ce022065f3014c94ddc304143c9",
"name": "AutoMessageSegmentModel",
"logicalName": "Segments",
"namespace": "Segments",
"fullNamespace": [
"Put_Id_Filter_Segment",
"Segments"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagIncludes",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagIncludes",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageTagModel",
"type": {
"id": "9d9839846a62840adc90df08c820c326",
"name": "AutoMessageTagModel",
"logicalName": "TagIncludes",
"namespace": "TagIncludes",
"fullNamespace": [
"Put_Id_Filter_Segment",
"TagIncludes"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagExcludes",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagExcludes",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageTagModel",
"type": {
"id": "9d9839846a62840adc90df08c820c326",
"name": "AutoMessageTagModel",
"logicalName": "TagExcludes",
"namespace": "TagExcludes",
"fullNamespace": [
"Put_Id_Filter_Segment",
"TagExcludes"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TriggerType",
"optional": false,
"sampleValue": "RecipientDateFieldMatch",
"deprecated": false,
"type": {
"id": "0b8ffc92086f2c24559effd93dfdf44d",
"name": "string",
"namespace": "ResponseTriggerType",
"fullNamespace": [
"Put_Id_Filter_Segment",
"ResponseTriggerType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "ImmediateRecipientCreated",
"enumeration": {
"name": "AutoMessageTriggerType",
"options": [
{
"name": "ImmediateRecipientCreated",
"value": "ImmediateRecipientCreated"
},
{
"name": "RecipientDateFieldMatch",
"value": "RecipientDateFieldMatch"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TriggerProperties",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "2d085c96346bfdffb8514a9e5f8639a9",
"name": "RecipientDateFieldTriggerModel",
"logicalName": "TriggerProperties",
"namespace": "TriggerProperties",
"fullNamespace": [
"Put_Id_Filter_Segment",
"TriggerProperties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "CompareRecipientFieldName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DateScope",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "ac4b980691ec98804e11381aa6916fa7",
"name": "string",
"namespace": "TriggerPropertiesDateScope",
"fullNamespace": [
"Put_Id_Filter_Segment",
"TriggerProperties",
"TriggerPropertiesDateScope"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Date",
"enumeration": {
"name": "DateScope",
"options": [
{
"name": "Date",
"value": "Date"
},
{
"name": "Month",
"value": "Month"
},
{
"name": "None",
"value": "None"
},
{
"name": "WeekOfYear",
"value": "WeekOfYear"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DayModifier",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ScheduledTime",
"comments": "Note: Time spans are formatted as d.hh:mm:ss.n.",
"optional": false,
"sampleValue": "0:00:00",
"deprecated": false,
"type": {
"name": "duration",
"isNullable": false,
"isSimple": true,
"sampleValue": "0:00:00",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "NextScheduledRun",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CurrentState",
"optional": false,
"sampleValue": "AwaitingFirstRun",
"deprecated": false,
"type": {
"id": "64c9db3ab85a9df76c1793b72d869994",
"name": "string",
"namespace": "TriggerPropertiesCurrentState",
"fullNamespace": [
"Put_Id_Filter_Segment",
"TriggerProperties",
"TriggerPropertiesCurrentState"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "AwaitingFirstRun",
"enumeration": {
"name": "State",
"options": [
{
"name": "AwaitingFirstRun",
"value": "AwaitingFirstRun"
},
{
"name": "Complete",
"value": "Complete"
},
{
"name": "Executing",
"value": "Executing"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Campaigns/AutoMessages/Filter/Suppression",
"comments": "The AutoMessage endpoints can be used to configure recurring messages to a list. To schedule an\r\nauto message campaign, a recipient list, and mailing content are required.
\nEndpoints to create and access lists are documented in the Lists section.\r\nEndpoints to create and access mailings are documented in the Mailings\r\nsection.
\nWhen creating new AutoMessages the default active state is false. After reviewing the model\r\nreturned by the POST request, send a PUT request setting Active to true in the request\r\nmodel to activate the AutoMessage.
application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "c62133bbccddb1742381b2103b97816e",
"name": "AutoMessageUpdateModel",
"logicalName": "Request",
"namespace": "Put_Id_Filter_Suppression",
"fullNamespace": [
"Put_Id_Filter_Suppression"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Active",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailingContentId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionLists",
"comments": "Only used on /Campaigns/AutoMessages/{id}/Filter/Suppression. Lists in this collection replace existing suppression lists. An empty collection removes existing suppression.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "SuppressionLists",
"comments": "Only used on /Campaigns/AutoMessages/{id}/Filter/Suppression. Lists in this collection replace existing suppression lists. An empty collection removes existing suppression.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageListModel",
"type": {
"id": "e9ee2b472d3b384f1c3552b49f093dd0",
"name": "AutoMessageListModel",
"logicalName": "SuppressionLists",
"namespace": "SuppressionLists",
"fullNamespace": [
"Put_Id_Filter_Suppression",
"SuppressionLists"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "SuppressionType",
"comments": "Only used on /Campaigns/AutoMessages/{id}/Filter/Suppression.",
"optional": true,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "a46801ddad089872a01f7ae8b9577982",
"name": "string",
"namespace": "RequestSuppressionType",
"fullNamespace": [
"Put_Id_Filter_Suppression",
"RequestSuppressionType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "DomainName",
"enumeration": {
"name": "SuppressionType",
"options": [
{
"name": "DomainName",
"value": "DomainName"
},
{
"name": "EmailAddress",
"value": "EmailAddress"
},
{
"name": "Md5",
"value": "Md5"
},
{
"name": "None",
"value": "None"
},
{
"name": "Standard",
"value": "Standard"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Segments",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Segments. Segments in this collection replace existing segments. An empty collection removes existing segments.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Segments",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Segments. Segments in this collection replace existing segments. An empty collection removes existing segments.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageSegmentModel",
"type": {
"id": "55768ce022065f3014c94ddc304143c9",
"name": "AutoMessageSegmentModel",
"logicalName": "Segments",
"namespace": "Segments",
"fullNamespace": [
"Put_Id_Filter_Suppression",
"Segments"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagIncludes",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Tags/Include. Tags in this collection replace existing include tags. An empty collection removes existing include tags.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagIncludes",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Tags/Include. Tags in this collection replace existing include tags. An empty collection removes existing include tags.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageTagModel",
"type": {
"id": "9d9839846a62840adc90df08c820c326",
"name": "AutoMessageTagModel",
"logicalName": "TagIncludes",
"namespace": "TagIncludes",
"fullNamespace": [
"Put_Id_Filter_Suppression",
"TagIncludes"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagExcludes",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Tags/Exclude. Tags in this collection replace existing exclude tags. An empty collection removes existing exclude tags.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagExcludes",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Tags/Exclude. Tags in this collection replace existing exclude tags. An empty collection removes existing exclude tags.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageTagModel",
"type": {
"id": "9d9839846a62840adc90df08c820c326",
"name": "AutoMessageTagModel",
"logicalName": "TagExcludes",
"namespace": "TagExcludes",
"fullNamespace": [
"Put_Id_Filter_Suppression",
"TagExcludes"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "89d70a60a6402d128080ae9613742bd1",
"name": "AutoMessageModel",
"logicalName": "Response",
"namespace": "Put_Id_Filter_Suppression",
"fullNamespace": [
"Put_Id_Filter_Suppression"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Active",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastRun",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AccountId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CampaignId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "RecipientList",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "e9ee2b472d3b384f1c3552b49f093dd0",
"name": "AutoMessageListModel",
"logicalName": "RecipientList",
"namespace": "RecipientList",
"fullNamespace": [
"Put_Id_Filter_Suppression",
"RecipientList"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailingContent",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "8f7227e53233ac33de5c4400ac457515",
"name": "AutoMessageContentModel",
"logicalName": "MailingContent",
"namespace": "MailingContent",
"fullNamespace": [
"Put_Id_Filter_Suppression",
"MailingContent"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionType",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "a46801ddad089872a01f7ae8b9577982",
"name": "string",
"namespace": "ResponseSuppressionType",
"fullNamespace": [
"Put_Id_Filter_Suppression",
"ResponseSuppressionType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "DomainName",
"enumeration": {
"name": "SuppressionType",
"options": [
{
"name": "DomainName",
"value": "DomainName"
},
{
"name": "EmailAddress",
"value": "EmailAddress"
},
{
"name": "Md5",
"value": "Md5"
},
{
"name": "None",
"value": "None"
},
{
"name": "Standard",
"value": "Standard"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionLists",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "SuppressionLists",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageListModel",
"type": {
"id": "e9ee2b472d3b384f1c3552b49f093dd0",
"name": "AutoMessageListModel",
"logicalName": "SuppressionLists",
"namespace": "SuppressionLists",
"fullNamespace": [
"Put_Id_Filter_Suppression",
"SuppressionLists"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Segments",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Segments",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageSegmentModel",
"type": {
"id": "55768ce022065f3014c94ddc304143c9",
"name": "AutoMessageSegmentModel",
"logicalName": "Segments",
"namespace": "Segments",
"fullNamespace": [
"Put_Id_Filter_Suppression",
"Segments"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagIncludes",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagIncludes",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageTagModel",
"type": {
"id": "9d9839846a62840adc90df08c820c326",
"name": "AutoMessageTagModel",
"logicalName": "TagIncludes",
"namespace": "TagIncludes",
"fullNamespace": [
"Put_Id_Filter_Suppression",
"TagIncludes"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagExcludes",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagExcludes",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageTagModel",
"type": {
"id": "9d9839846a62840adc90df08c820c326",
"name": "AutoMessageTagModel",
"logicalName": "TagExcludes",
"namespace": "TagExcludes",
"fullNamespace": [
"Put_Id_Filter_Suppression",
"TagExcludes"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TriggerType",
"optional": false,
"sampleValue": "RecipientDateFieldMatch",
"deprecated": false,
"type": {
"id": "0b8ffc92086f2c24559effd93dfdf44d",
"name": "string",
"namespace": "ResponseTriggerType",
"fullNamespace": [
"Put_Id_Filter_Suppression",
"ResponseTriggerType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "ImmediateRecipientCreated",
"enumeration": {
"name": "AutoMessageTriggerType",
"options": [
{
"name": "ImmediateRecipientCreated",
"value": "ImmediateRecipientCreated"
},
{
"name": "RecipientDateFieldMatch",
"value": "RecipientDateFieldMatch"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TriggerProperties",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "2d085c96346bfdffb8514a9e5f8639a9",
"name": "RecipientDateFieldTriggerModel",
"logicalName": "TriggerProperties",
"namespace": "TriggerProperties",
"fullNamespace": [
"Put_Id_Filter_Suppression",
"TriggerProperties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "CompareRecipientFieldName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DateScope",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "ac4b980691ec98804e11381aa6916fa7",
"name": "string",
"namespace": "TriggerPropertiesDateScope",
"fullNamespace": [
"Put_Id_Filter_Suppression",
"TriggerProperties",
"TriggerPropertiesDateScope"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Date",
"enumeration": {
"name": "DateScope",
"options": [
{
"name": "Date",
"value": "Date"
},
{
"name": "Month",
"value": "Month"
},
{
"name": "None",
"value": "None"
},
{
"name": "WeekOfYear",
"value": "WeekOfYear"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DayModifier",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ScheduledTime",
"comments": "Note: Time spans are formatted as d.hh:mm:ss.n.",
"optional": false,
"sampleValue": "0:00:00",
"deprecated": false,
"type": {
"name": "duration",
"isNullable": false,
"isSimple": true,
"sampleValue": "0:00:00",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "NextScheduledRun",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CurrentState",
"optional": false,
"sampleValue": "AwaitingFirstRun",
"deprecated": false,
"type": {
"id": "64c9db3ab85a9df76c1793b72d869994",
"name": "string",
"namespace": "TriggerPropertiesCurrentState",
"fullNamespace": [
"Put_Id_Filter_Suppression",
"TriggerProperties",
"TriggerPropertiesCurrentState"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "AwaitingFirstRun",
"enumeration": {
"name": "State",
"options": [
{
"name": "AwaitingFirstRun",
"value": "AwaitingFirstRun"
},
{
"name": "Complete",
"value": "Complete"
},
{
"name": "Executing",
"value": "Executing"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Campaigns/AutoMessages/Filter/Tag/Exclude",
"comments": "The AutoMessage endpoints can be used to configure recurring messages to a list. To schedule an\r\nauto message campaign, a recipient list, and mailing content are required.
\nEndpoints to create and access lists are documented in the Lists section.\r\nEndpoints to create and access mailings are documented in the Mailings\r\nsection.
\nWhen creating new AutoMessages the default active state is false. After reviewing the model\r\nreturned by the POST request, send a PUT request setting Active to true in the request\r\nmodel to activate the AutoMessage.
application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "c62133bbccddb1742381b2103b97816e",
"name": "AutoMessageUpdateModel",
"logicalName": "Request",
"namespace": "Put_Id_Filter_Tag_Exclude",
"fullNamespace": [
"Put_Id_Filter_Tag_Exclude"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Active",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailingContentId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionLists",
"comments": "Only used on /Campaigns/AutoMessages/{id}/Filter/Suppression. Lists in this collection replace existing suppression lists. An empty collection removes existing suppression.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "SuppressionLists",
"comments": "Only used on /Campaigns/AutoMessages/{id}/Filter/Suppression. Lists in this collection replace existing suppression lists. An empty collection removes existing suppression.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageListModel",
"type": {
"id": "e9ee2b472d3b384f1c3552b49f093dd0",
"name": "AutoMessageListModel",
"logicalName": "SuppressionLists",
"namespace": "SuppressionLists",
"fullNamespace": [
"Put_Id_Filter_Tag_Exclude",
"SuppressionLists"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "SuppressionType",
"comments": "Only used on /Campaigns/AutoMessages/{id}/Filter/Suppression.",
"optional": true,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "a46801ddad089872a01f7ae8b9577982",
"name": "string",
"namespace": "RequestSuppressionType",
"fullNamespace": [
"Put_Id_Filter_Tag_Exclude",
"RequestSuppressionType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "DomainName",
"enumeration": {
"name": "SuppressionType",
"options": [
{
"name": "DomainName",
"value": "DomainName"
},
{
"name": "EmailAddress",
"value": "EmailAddress"
},
{
"name": "Md5",
"value": "Md5"
},
{
"name": "None",
"value": "None"
},
{
"name": "Standard",
"value": "Standard"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Segments",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Segments. Segments in this collection replace existing segments. An empty collection removes existing segments.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Segments",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Segments. Segments in this collection replace existing segments. An empty collection removes existing segments.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageSegmentModel",
"type": {
"id": "55768ce022065f3014c94ddc304143c9",
"name": "AutoMessageSegmentModel",
"logicalName": "Segments",
"namespace": "Segments",
"fullNamespace": [
"Put_Id_Filter_Tag_Exclude",
"Segments"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagIncludes",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Tags/Include. Tags in this collection replace existing include tags. An empty collection removes existing include tags.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagIncludes",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Tags/Include. Tags in this collection replace existing include tags. An empty collection removes existing include tags.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageTagModel",
"type": {
"id": "9d9839846a62840adc90df08c820c326",
"name": "AutoMessageTagModel",
"logicalName": "TagIncludes",
"namespace": "TagIncludes",
"fullNamespace": [
"Put_Id_Filter_Tag_Exclude",
"TagIncludes"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagExcludes",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Tags/Exclude. Tags in this collection replace existing exclude tags. An empty collection removes existing exclude tags.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagExcludes",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Tags/Exclude. Tags in this collection replace existing exclude tags. An empty collection removes existing exclude tags.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageTagModel",
"type": {
"id": "9d9839846a62840adc90df08c820c326",
"name": "AutoMessageTagModel",
"logicalName": "TagExcludes",
"namespace": "TagExcludes",
"fullNamespace": [
"Put_Id_Filter_Tag_Exclude",
"TagExcludes"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "89d70a60a6402d128080ae9613742bd1",
"name": "AutoMessageModel",
"logicalName": "Response",
"namespace": "Put_Id_Filter_Tag_Exclude",
"fullNamespace": [
"Put_Id_Filter_Tag_Exclude"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Active",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastRun",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AccountId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CampaignId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "RecipientList",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "e9ee2b472d3b384f1c3552b49f093dd0",
"name": "AutoMessageListModel",
"logicalName": "RecipientList",
"namespace": "RecipientList",
"fullNamespace": [
"Put_Id_Filter_Tag_Exclude",
"RecipientList"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailingContent",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "8f7227e53233ac33de5c4400ac457515",
"name": "AutoMessageContentModel",
"logicalName": "MailingContent",
"namespace": "MailingContent",
"fullNamespace": [
"Put_Id_Filter_Tag_Exclude",
"MailingContent"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionType",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "a46801ddad089872a01f7ae8b9577982",
"name": "string",
"namespace": "ResponseSuppressionType",
"fullNamespace": [
"Put_Id_Filter_Tag_Exclude",
"ResponseSuppressionType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "DomainName",
"enumeration": {
"name": "SuppressionType",
"options": [
{
"name": "DomainName",
"value": "DomainName"
},
{
"name": "EmailAddress",
"value": "EmailAddress"
},
{
"name": "Md5",
"value": "Md5"
},
{
"name": "None",
"value": "None"
},
{
"name": "Standard",
"value": "Standard"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionLists",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "SuppressionLists",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageListModel",
"type": {
"id": "e9ee2b472d3b384f1c3552b49f093dd0",
"name": "AutoMessageListModel",
"logicalName": "SuppressionLists",
"namespace": "SuppressionLists",
"fullNamespace": [
"Put_Id_Filter_Tag_Exclude",
"SuppressionLists"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Segments",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Segments",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageSegmentModel",
"type": {
"id": "55768ce022065f3014c94ddc304143c9",
"name": "AutoMessageSegmentModel",
"logicalName": "Segments",
"namespace": "Segments",
"fullNamespace": [
"Put_Id_Filter_Tag_Exclude",
"Segments"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagIncludes",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagIncludes",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageTagModel",
"type": {
"id": "9d9839846a62840adc90df08c820c326",
"name": "AutoMessageTagModel",
"logicalName": "TagIncludes",
"namespace": "TagIncludes",
"fullNamespace": [
"Put_Id_Filter_Tag_Exclude",
"TagIncludes"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagExcludes",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagExcludes",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageTagModel",
"type": {
"id": "9d9839846a62840adc90df08c820c326",
"name": "AutoMessageTagModel",
"logicalName": "TagExcludes",
"namespace": "TagExcludes",
"fullNamespace": [
"Put_Id_Filter_Tag_Exclude",
"TagExcludes"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TriggerType",
"optional": false,
"sampleValue": "RecipientDateFieldMatch",
"deprecated": false,
"type": {
"id": "0b8ffc92086f2c24559effd93dfdf44d",
"name": "string",
"namespace": "ResponseTriggerType",
"fullNamespace": [
"Put_Id_Filter_Tag_Exclude",
"ResponseTriggerType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "ImmediateRecipientCreated",
"enumeration": {
"name": "AutoMessageTriggerType",
"options": [
{
"name": "ImmediateRecipientCreated",
"value": "ImmediateRecipientCreated"
},
{
"name": "RecipientDateFieldMatch",
"value": "RecipientDateFieldMatch"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TriggerProperties",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "2d085c96346bfdffb8514a9e5f8639a9",
"name": "RecipientDateFieldTriggerModel",
"logicalName": "TriggerProperties",
"namespace": "TriggerProperties",
"fullNamespace": [
"Put_Id_Filter_Tag_Exclude",
"TriggerProperties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "CompareRecipientFieldName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DateScope",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "ac4b980691ec98804e11381aa6916fa7",
"name": "string",
"namespace": "TriggerPropertiesDateScope",
"fullNamespace": [
"Put_Id_Filter_Tag_Exclude",
"TriggerProperties",
"TriggerPropertiesDateScope"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Date",
"enumeration": {
"name": "DateScope",
"options": [
{
"name": "Date",
"value": "Date"
},
{
"name": "Month",
"value": "Month"
},
{
"name": "None",
"value": "None"
},
{
"name": "WeekOfYear",
"value": "WeekOfYear"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DayModifier",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ScheduledTime",
"comments": "Note: Time spans are formatted as d.hh:mm:ss.n.",
"optional": false,
"sampleValue": "0:00:00",
"deprecated": false,
"type": {
"name": "duration",
"isNullable": false,
"isSimple": true,
"sampleValue": "0:00:00",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "NextScheduledRun",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CurrentState",
"optional": false,
"sampleValue": "AwaitingFirstRun",
"deprecated": false,
"type": {
"id": "64c9db3ab85a9df76c1793b72d869994",
"name": "string",
"namespace": "TriggerPropertiesCurrentState",
"fullNamespace": [
"Put_Id_Filter_Tag_Exclude",
"TriggerProperties",
"TriggerPropertiesCurrentState"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "AwaitingFirstRun",
"enumeration": {
"name": "State",
"options": [
{
"name": "AwaitingFirstRun",
"value": "AwaitingFirstRun"
},
{
"name": "Complete",
"value": "Complete"
},
{
"name": "Executing",
"value": "Executing"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Campaigns/AutoMessages/Filter/Tag/Include",
"comments": "The AutoMessage endpoints can be used to configure recurring messages to a list. To schedule an\r\nauto message campaign, a recipient list, and mailing content are required.
\nEndpoints to create and access lists are documented in the Lists section.\r\nEndpoints to create and access mailings are documented in the Mailings\r\nsection.
\nWhen creating new AutoMessages the default active state is false. After reviewing the model\r\nreturned by the POST request, send a PUT request setting Active to true in the request\r\nmodel to activate the AutoMessage.
application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "c62133bbccddb1742381b2103b97816e",
"name": "AutoMessageUpdateModel",
"logicalName": "Request",
"namespace": "Put_Id_Filter_Tag_Include",
"fullNamespace": [
"Put_Id_Filter_Tag_Include"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Active",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailingContentId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionLists",
"comments": "Only used on /Campaigns/AutoMessages/{id}/Filter/Suppression. Lists in this collection replace existing suppression lists. An empty collection removes existing suppression.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "SuppressionLists",
"comments": "Only used on /Campaigns/AutoMessages/{id}/Filter/Suppression. Lists in this collection replace existing suppression lists. An empty collection removes existing suppression.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageListModel",
"type": {
"id": "e9ee2b472d3b384f1c3552b49f093dd0",
"name": "AutoMessageListModel",
"logicalName": "SuppressionLists",
"namespace": "SuppressionLists",
"fullNamespace": [
"Put_Id_Filter_Tag_Include",
"SuppressionLists"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "SuppressionType",
"comments": "Only used on /Campaigns/AutoMessages/{id}/Filter/Suppression.",
"optional": true,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "a46801ddad089872a01f7ae8b9577982",
"name": "string",
"namespace": "RequestSuppressionType",
"fullNamespace": [
"Put_Id_Filter_Tag_Include",
"RequestSuppressionType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "DomainName",
"enumeration": {
"name": "SuppressionType",
"options": [
{
"name": "DomainName",
"value": "DomainName"
},
{
"name": "EmailAddress",
"value": "EmailAddress"
},
{
"name": "Md5",
"value": "Md5"
},
{
"name": "None",
"value": "None"
},
{
"name": "Standard",
"value": "Standard"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Segments",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Segments. Segments in this collection replace existing segments. An empty collection removes existing segments.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Segments",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Segments. Segments in this collection replace existing segments. An empty collection removes existing segments.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageSegmentModel",
"type": {
"id": "55768ce022065f3014c94ddc304143c9",
"name": "AutoMessageSegmentModel",
"logicalName": "Segments",
"namespace": "Segments",
"fullNamespace": [
"Put_Id_Filter_Tag_Include",
"Segments"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagIncludes",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Tags/Include. Tags in this collection replace existing include tags. An empty collection removes existing include tags.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagIncludes",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Tags/Include. Tags in this collection replace existing include tags. An empty collection removes existing include tags.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageTagModel",
"type": {
"id": "9d9839846a62840adc90df08c820c326",
"name": "AutoMessageTagModel",
"logicalName": "TagIncludes",
"namespace": "TagIncludes",
"fullNamespace": [
"Put_Id_Filter_Tag_Include",
"TagIncludes"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagExcludes",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Tags/Exclude. Tags in this collection replace existing exclude tags. An empty collection removes existing exclude tags.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagExcludes",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Tags/Exclude. Tags in this collection replace existing exclude tags. An empty collection removes existing exclude tags.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageTagModel",
"type": {
"id": "9d9839846a62840adc90df08c820c326",
"name": "AutoMessageTagModel",
"logicalName": "TagExcludes",
"namespace": "TagExcludes",
"fullNamespace": [
"Put_Id_Filter_Tag_Include",
"TagExcludes"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "89d70a60a6402d128080ae9613742bd1",
"name": "AutoMessageModel",
"logicalName": "Response",
"namespace": "Put_Id_Filter_Tag_Include",
"fullNamespace": [
"Put_Id_Filter_Tag_Include"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Active",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastRun",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AccountId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CampaignId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "RecipientList",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "e9ee2b472d3b384f1c3552b49f093dd0",
"name": "AutoMessageListModel",
"logicalName": "RecipientList",
"namespace": "RecipientList",
"fullNamespace": [
"Put_Id_Filter_Tag_Include",
"RecipientList"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailingContent",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "8f7227e53233ac33de5c4400ac457515",
"name": "AutoMessageContentModel",
"logicalName": "MailingContent",
"namespace": "MailingContent",
"fullNamespace": [
"Put_Id_Filter_Tag_Include",
"MailingContent"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionType",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "a46801ddad089872a01f7ae8b9577982",
"name": "string",
"namespace": "ResponseSuppressionType",
"fullNamespace": [
"Put_Id_Filter_Tag_Include",
"ResponseSuppressionType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "DomainName",
"enumeration": {
"name": "SuppressionType",
"options": [
{
"name": "DomainName",
"value": "DomainName"
},
{
"name": "EmailAddress",
"value": "EmailAddress"
},
{
"name": "Md5",
"value": "Md5"
},
{
"name": "None",
"value": "None"
},
{
"name": "Standard",
"value": "Standard"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionLists",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "SuppressionLists",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageListModel",
"type": {
"id": "e9ee2b472d3b384f1c3552b49f093dd0",
"name": "AutoMessageListModel",
"logicalName": "SuppressionLists",
"namespace": "SuppressionLists",
"fullNamespace": [
"Put_Id_Filter_Tag_Include",
"SuppressionLists"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Segments",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Segments",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageSegmentModel",
"type": {
"id": "55768ce022065f3014c94ddc304143c9",
"name": "AutoMessageSegmentModel",
"logicalName": "Segments",
"namespace": "Segments",
"fullNamespace": [
"Put_Id_Filter_Tag_Include",
"Segments"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagIncludes",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagIncludes",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageTagModel",
"type": {
"id": "9d9839846a62840adc90df08c820c326",
"name": "AutoMessageTagModel",
"logicalName": "TagIncludes",
"namespace": "TagIncludes",
"fullNamespace": [
"Put_Id_Filter_Tag_Include",
"TagIncludes"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagExcludes",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagExcludes",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageTagModel",
"type": {
"id": "9d9839846a62840adc90df08c820c326",
"name": "AutoMessageTagModel",
"logicalName": "TagExcludes",
"namespace": "TagExcludes",
"fullNamespace": [
"Put_Id_Filter_Tag_Include",
"TagExcludes"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TriggerType",
"optional": false,
"sampleValue": "RecipientDateFieldMatch",
"deprecated": false,
"type": {
"id": "0b8ffc92086f2c24559effd93dfdf44d",
"name": "string",
"namespace": "ResponseTriggerType",
"fullNamespace": [
"Put_Id_Filter_Tag_Include",
"ResponseTriggerType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "ImmediateRecipientCreated",
"enumeration": {
"name": "AutoMessageTriggerType",
"options": [
{
"name": "ImmediateRecipientCreated",
"value": "ImmediateRecipientCreated"
},
{
"name": "RecipientDateFieldMatch",
"value": "RecipientDateFieldMatch"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TriggerProperties",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "2d085c96346bfdffb8514a9e5f8639a9",
"name": "RecipientDateFieldTriggerModel",
"logicalName": "TriggerProperties",
"namespace": "TriggerProperties",
"fullNamespace": [
"Put_Id_Filter_Tag_Include",
"TriggerProperties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "CompareRecipientFieldName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DateScope",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "ac4b980691ec98804e11381aa6916fa7",
"name": "string",
"namespace": "TriggerPropertiesDateScope",
"fullNamespace": [
"Put_Id_Filter_Tag_Include",
"TriggerProperties",
"TriggerPropertiesDateScope"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Date",
"enumeration": {
"name": "DateScope",
"options": [
{
"name": "Date",
"value": "Date"
},
{
"name": "Month",
"value": "Month"
},
{
"name": "None",
"value": "None"
},
{
"name": "WeekOfYear",
"value": "WeekOfYear"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DayModifier",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ScheduledTime",
"comments": "Note: Time spans are formatted as d.hh:mm:ss.n.",
"optional": false,
"sampleValue": "0:00:00",
"deprecated": false,
"type": {
"name": "duration",
"isNullable": false,
"isSimple": true,
"sampleValue": "0:00:00",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "NextScheduledRun",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CurrentState",
"optional": false,
"sampleValue": "AwaitingFirstRun",
"deprecated": false,
"type": {
"id": "64c9db3ab85a9df76c1793b72d869994",
"name": "string",
"namespace": "TriggerPropertiesCurrentState",
"fullNamespace": [
"Put_Id_Filter_Tag_Include",
"TriggerProperties",
"TriggerPropertiesCurrentState"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "AwaitingFirstRun",
"enumeration": {
"name": "State",
"options": [
{
"name": "AwaitingFirstRun",
"value": "AwaitingFirstRun"
},
{
"name": "Complete",
"value": "Complete"
},
{
"name": "Executing",
"value": "Executing"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Campaigns/AutoMessages/MessageContent",
"comments": "The AutoMessage endpoints can be used to configure recurring messages to a list. To schedule an\r\nauto message campaign, a recipient list, and mailing content are required.
\nEndpoints to create and access lists are documented in the Lists section.\r\nEndpoints to create and access mailings are documented in the Mailings\r\nsection.
\nWhen creating new AutoMessages the default active state is false. After reviewing the model\r\nreturned by the POST request, send a PUT request setting Active to true in the request\r\nmodel to activate the AutoMessage.
application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "c62133bbccddb1742381b2103b97816e",
"name": "AutoMessageUpdateModel",
"logicalName": "Request",
"namespace": "Put_Id_MessageContent",
"fullNamespace": [
"Put_Id_MessageContent"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Active",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailingContentId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionLists",
"comments": "Only used on /Campaigns/AutoMessages/{id}/Filter/Suppression. Lists in this collection replace existing suppression lists. An empty collection removes existing suppression.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "SuppressionLists",
"comments": "Only used on /Campaigns/AutoMessages/{id}/Filter/Suppression. Lists in this collection replace existing suppression lists. An empty collection removes existing suppression.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageListModel",
"type": {
"id": "e9ee2b472d3b384f1c3552b49f093dd0",
"name": "AutoMessageListModel",
"logicalName": "SuppressionLists",
"namespace": "SuppressionLists",
"fullNamespace": [
"Put_Id_MessageContent",
"SuppressionLists"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "SuppressionType",
"comments": "Only used on /Campaigns/AutoMessages/{id}/Filter/Suppression.",
"optional": true,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "a46801ddad089872a01f7ae8b9577982",
"name": "string",
"namespace": "RequestSuppressionType",
"fullNamespace": [
"Put_Id_MessageContent",
"RequestSuppressionType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "DomainName",
"enumeration": {
"name": "SuppressionType",
"options": [
{
"name": "DomainName",
"value": "DomainName"
},
{
"name": "EmailAddress",
"value": "EmailAddress"
},
{
"name": "Md5",
"value": "Md5"
},
{
"name": "None",
"value": "None"
},
{
"name": "Standard",
"value": "Standard"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Segments",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Segments. Segments in this collection replace existing segments. An empty collection removes existing segments.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Segments",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Segments. Segments in this collection replace existing segments. An empty collection removes existing segments.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageSegmentModel",
"type": {
"id": "55768ce022065f3014c94ddc304143c9",
"name": "AutoMessageSegmentModel",
"logicalName": "Segments",
"namespace": "Segments",
"fullNamespace": [
"Put_Id_MessageContent",
"Segments"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagIncludes",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Tags/Include. Tags in this collection replace existing include tags. An empty collection removes existing include tags.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagIncludes",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Tags/Include. Tags in this collection replace existing include tags. An empty collection removes existing include tags.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageTagModel",
"type": {
"id": "9d9839846a62840adc90df08c820c326",
"name": "AutoMessageTagModel",
"logicalName": "TagIncludes",
"namespace": "TagIncludes",
"fullNamespace": [
"Put_Id_MessageContent",
"TagIncludes"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagExcludes",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Tags/Exclude. Tags in this collection replace existing exclude tags. An empty collection removes existing exclude tags.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagExcludes",
"comments": "Only used on /Campaign/AutoMessages/{id}/Filter/Tags/Exclude. Tags in this collection replace existing exclude tags. An empty collection removes existing exclude tags.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageTagModel",
"type": {
"id": "9d9839846a62840adc90df08c820c326",
"name": "AutoMessageTagModel",
"logicalName": "TagExcludes",
"namespace": "TagExcludes",
"fullNamespace": [
"Put_Id_MessageContent",
"TagExcludes"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "89d70a60a6402d128080ae9613742bd1",
"name": "AutoMessageModel",
"logicalName": "Response",
"namespace": "Put_Id_MessageContent",
"fullNamespace": [
"Put_Id_MessageContent"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Active",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastRun",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AccountId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CampaignId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "RecipientList",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "e9ee2b472d3b384f1c3552b49f093dd0",
"name": "AutoMessageListModel",
"logicalName": "RecipientList",
"namespace": "RecipientList",
"fullNamespace": [
"Put_Id_MessageContent",
"RecipientList"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailingContent",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "8f7227e53233ac33de5c4400ac457515",
"name": "AutoMessageContentModel",
"logicalName": "MailingContent",
"namespace": "MailingContent",
"fullNamespace": [
"Put_Id_MessageContent",
"MailingContent"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionType",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "a46801ddad089872a01f7ae8b9577982",
"name": "string",
"namespace": "ResponseSuppressionType",
"fullNamespace": [
"Put_Id_MessageContent",
"ResponseSuppressionType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "DomainName",
"enumeration": {
"name": "SuppressionType",
"options": [
{
"name": "DomainName",
"value": "DomainName"
},
{
"name": "EmailAddress",
"value": "EmailAddress"
},
{
"name": "Md5",
"value": "Md5"
},
{
"name": "None",
"value": "None"
},
{
"name": "Standard",
"value": "Standard"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionLists",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "SuppressionLists",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageListModel",
"type": {
"id": "e9ee2b472d3b384f1c3552b49f093dd0",
"name": "AutoMessageListModel",
"logicalName": "SuppressionLists",
"namespace": "SuppressionLists",
"fullNamespace": [
"Put_Id_MessageContent",
"SuppressionLists"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Segments",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Segments",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageSegmentModel",
"type": {
"id": "55768ce022065f3014c94ddc304143c9",
"name": "AutoMessageSegmentModel",
"logicalName": "Segments",
"namespace": "Segments",
"fullNamespace": [
"Put_Id_MessageContent",
"Segments"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagIncludes",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagIncludes",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageTagModel",
"type": {
"id": "9d9839846a62840adc90df08c820c326",
"name": "AutoMessageTagModel",
"logicalName": "TagIncludes",
"namespace": "TagIncludes",
"fullNamespace": [
"Put_Id_MessageContent",
"TagIncludes"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagExcludes",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagExcludes",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageTagModel",
"type": {
"id": "9d9839846a62840adc90df08c820c326",
"name": "AutoMessageTagModel",
"logicalName": "TagExcludes",
"namespace": "TagExcludes",
"fullNamespace": [
"Put_Id_MessageContent",
"TagExcludes"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TriggerType",
"optional": false,
"sampleValue": "RecipientDateFieldMatch",
"deprecated": false,
"type": {
"id": "0b8ffc92086f2c24559effd93dfdf44d",
"name": "string",
"namespace": "ResponseTriggerType",
"fullNamespace": [
"Put_Id_MessageContent",
"ResponseTriggerType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "ImmediateRecipientCreated",
"enumeration": {
"name": "AutoMessageTriggerType",
"options": [
{
"name": "ImmediateRecipientCreated",
"value": "ImmediateRecipientCreated"
},
{
"name": "RecipientDateFieldMatch",
"value": "RecipientDateFieldMatch"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TriggerProperties",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "2d085c96346bfdffb8514a9e5f8639a9",
"name": "RecipientDateFieldTriggerModel",
"logicalName": "TriggerProperties",
"namespace": "TriggerProperties",
"fullNamespace": [
"Put_Id_MessageContent",
"TriggerProperties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "CompareRecipientFieldName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DateScope",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "ac4b980691ec98804e11381aa6916fa7",
"name": "string",
"namespace": "TriggerPropertiesDateScope",
"fullNamespace": [
"Put_Id_MessageContent",
"TriggerProperties",
"TriggerPropertiesDateScope"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Date",
"enumeration": {
"name": "DateScope",
"options": [
{
"name": "Date",
"value": "Date"
},
{
"name": "Month",
"value": "Month"
},
{
"name": "None",
"value": "None"
},
{
"name": "WeekOfYear",
"value": "WeekOfYear"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DayModifier",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ScheduledTime",
"comments": "Note: Time spans are formatted as d.hh:mm:ss.n.",
"optional": false,
"sampleValue": "0:00:00",
"deprecated": false,
"type": {
"name": "duration",
"isNullable": false,
"isSimple": true,
"sampleValue": "0:00:00",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "NextScheduledRun",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CurrentState",
"optional": false,
"sampleValue": "AwaitingFirstRun",
"deprecated": false,
"type": {
"id": "64c9db3ab85a9df76c1793b72d869994",
"name": "string",
"namespace": "TriggerPropertiesCurrentState",
"fullNamespace": [
"Put_Id_MessageContent",
"TriggerProperties",
"TriggerPropertiesCurrentState"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "AwaitingFirstRun",
"enumeration": {
"name": "State",
"options": [
{
"name": "AwaitingFirstRun",
"value": "AwaitingFirstRun"
},
{
"name": "Complete",
"value": "Complete"
},
{
"name": "Executing",
"value": "Executing"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Campaigns/MessageTesting",
"comments": "Message Testing (commonly refered to as A/B testing) differs from a standard campaign in that you can specify \nmore then Mailing to be sent. For instance you can send two slightly different versions of your contnet \nto determine which receives the best response.
\nThe format for message testing is the same as campaign except that MailingIds is an array, and you have to specify a MailingTestingPercentage.
MailingTestingPercentage is the percentage of each list that will receive the each mailing you specify. For instance if you have two mailings that you are testing \nand you specify a MailingTestPercentage of 10 then 20% percent of the people in the specified lists will receive the email during the first send. 10% getting a copy of Mailing A \nand 10% getting a copy of Mailing B.
After the initial sending is complete the results will be available in the reporting section. Use this info to determine if Mailing A or Mailing B should be sent to the remaining 80% of \nyour specified lists. Use the /campaigns/messagetesting/{AccountId}/{CampaignId} endpoint to schedule the remaining portion of the [campaign][campaign]. You'll have to specify the campaignId, mailingId and \ntime you'd like the remainder to be sent.
application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "6fa978d7d9323d878db71ca5b935a690",
"name": "QueueParameters",
"logicalName": "Request",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "ListIds",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "ListIds",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Id",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "MailingIds",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "MailingIds",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Id",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "MessageTestingPercentage",
"optional": false,
"sampleValue": "0.00",
"deprecated": false,
"type": {
"name": "decimal",
"isNullable": false,
"isSimple": true,
"sampleValue": "0.00",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Properties",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "73b8e2dad04c8818e0ca8a9feb93314e",
"name": "MessageProperties",
"logicalName": "Properties",
"namespace": "Properties",
"fullNamespace": [
"Post_AccountId",
"Properties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "DeliveryTime",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "IsTest",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionLists",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "SuppressionLists",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Id",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TestFormat",
"optional": true,
"sampleValue": "HtmlOnly",
"deprecated": false,
"type": {
"id": "d27ebcf671ab49466c3a83a5f3b8cfcb",
"name": "string",
"namespace": "PropertiesTestFormat",
"fullNamespace": [
"Post_AccountId",
"Properties",
"PropertiesTestFormat"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "HtmlOnly",
"enumeration": {
"name": "TestFormat",
"options": [
{
"name": "HtmlOnly",
"value": "HtmlOnly"
},
{
"name": "TextAndHtml",
"value": "TextAndHtml"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Filter",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "438b86f509b956559efa1fc3ed9248ec",
"name": "Filter",
"logicalName": "Filter",
"namespace": "Filter",
"fullNamespace": [
"Post_AccountId",
"Properties",
"Filter"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Conditions",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Conditions",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Condition",
"type": {
"id": "90e095d1e3239db8d1ee7e9ad2acc797",
"name": "Condition",
"logicalName": "Conditions",
"namespace": "Conditions",
"fullNamespace": [
"Post_AccountId",
"Properties",
"Filter",
"Conditions"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Comparison",
"optional": false,
"sampleValue": "Contains",
"deprecated": false,
"type": {
"id": "089b970ee25465194615eb1c245d1492",
"name": "Comparison",
"namespace": "ConditionsComparison",
"fullNamespace": [
"Post_AccountId",
"Properties",
"Filter",
"Conditions",
"ConditionsComparison"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Contains",
"enumeration": {
"name": "Comparison",
"options": [
{
"name": "Contains",
"value": "Contains"
},
{
"name": "EndsWith",
"value": "EndsWith"
},
{
"name": "Equals",
"value": "Equals"
},
{
"name": "GreaterThan",
"value": "GreaterThan"
},
{
"name": "GreaterThanOrEqualTo",
"value": "GreaterThanOrEqualTo"
},
{
"name": "IsNull",
"value": "IsNull"
},
{
"name": "LessThan",
"value": "LessThan"
},
{
"name": "LessThanOrEqualTo",
"value": "LessThanOrEqualTo"
},
{
"name": "NotEqual",
"value": "NotEqual"
},
{
"name": "StartsWith",
"value": "StartsWith"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Property",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Value",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Operator",
"optional": false,
"sampleValue": "And",
"deprecated": false,
"type": {
"id": "7d4d97fb094c1c81383d8954d6eed781",
"name": "Operator",
"namespace": "FilterOperator",
"fullNamespace": [
"Post_AccountId",
"Properties",
"Filter",
"FilterOperator"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "And",
"enumeration": {
"name": "Operator",
"options": [
{
"name": "And",
"value": "And"
},
{
"name": "Or",
"value": "Or"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TagIds",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagIds",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "uuid",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TagExclusionIds",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TagExclusionIds",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "uuid",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "9150e36bd6f6703d4f073ddc86d95b66",
"name": "Queue",
"logicalName": "Response",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "0d5545f287fe07e0b5b56a505808789d",
"name": "",
"methodName": "Post_AccountId_CampaignId",
"namespace": [
"Campaigns",
"MessageTesting"
],
"urlTemplate": "Campaigns/MessageTesting/{accountId}/{campaignId}",
"method": "POST",
"urlParameters": [
{
"name": "accountId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
},
{
"name": "campaignId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "738dc4df0fc2d707412d3e8b75f604ce",
"name": "QueueRemainderParameters",
"logicalName": "Request",
"namespace": "Post_AccountId_CampaignId",
"fullNamespace": [
"Post_AccountId_CampaignId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "MessageId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DeliveryTime",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [],
"isBinary": false,
"hasBody": false
}
}
]
},
{
"name": "/Campaigns/Scheduled",
"comments": "Scheduled Campaign management.
", "endpoints": [ { "id": "acc3cdbbefd02ad89a11e011f58e5d76", "name": "", "comments": "Get scheduled campaigns.
", "methodName": "Get", "namespace": [ "Campaigns", "Scheduled" ], "urlTemplate": "Campaigns/Scheduled", "method": "GET", "urlParameters": [], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "accept", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "CampaignMailings",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "CampaignMailing",
"type": {
"id": "0a61a956ebcaef6e64861ddf88f5ea64",
"name": "CampaignMailing",
"logicalName": "Response",
"namespace": "Get",
"fullNamespace": [
"Get"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CurrentState",
"optional": false,
"sampleValue": "AwaitingSchedule",
"deprecated": false,
"type": {
"id": "bdacc7ec65a5afc46a67a0edbb110af7",
"name": "string",
"namespace": "ResponseCurrentState",
"fullNamespace": [
"Get",
"ResponseCurrentState"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "AwaitingApproval",
"enumeration": {
"name": "ScheduledStateCode",
"options": [
{
"name": "AwaitingApproval",
"value": "AwaitingApproval"
},
{
"name": "AwaitingPickUp",
"value": "AwaitingPickUp"
},
{
"name": "AwaitingSchedule",
"value": "AwaitingSchedule"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Filtered",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Scheduled",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ScheduledDelivery",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "IsTest",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionListIds",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "SuppressionListIds",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "uuid",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "ListIds",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "ListIds",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "uuid",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "5876818223f8dea9958dc52cdd6d24a5",
"name": "",
"comments": "Cancel a scheduled campaign.
", "methodName": "Delete_AccountId_CampaignId", "namespace": [ "Campaigns", "Scheduled" ], "urlTemplate": "Campaigns/Scheduled/{accountId}/{campaignId}", "method": "DELETE", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "campaignId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [], "isBinary": false, "hasBody": false }, "response": { "headers": [], "isBinary": false, "hasBody": false } } ] } ] }, { "name": "Data", "comments": "The Data endpoints are used to load files in to your account. These files can be used as attachments\nto email messages, images in email messages, or as a collection of contact details to be\nloaded into a list.
\nData management.
", "endpoints": [ { "id": "a07a9aeeb14c7bae8311e6eecbde14e7", "name": "", "comments": "Upload data.
", "methodName": "Post", "namespace": [ "Data" ], "urlTemplate": "Data", "method": "POST", "urlParameters": [], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "comments": "Binary data.
", "headers": [ { "name": "content-type", "optional": true, "required": false, "isContentType": true, "isAccept": false, "isAuth": false }, { "name": "accept", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": true,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "1126d7a99ee0da19854292724c2c1aad",
"name": "Data",
"logicalName": "Response",
"namespace": "Post",
"fullNamespace": [
"Post"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "d9f93d4356ab6681210f54af302ff312",
"name": "",
"methodName": "PublicGet_DataId",
"namespace": [
"Data"
],
"urlTemplate": "Data/{dataId}",
"method": "GET",
"urlParameters": [
{
"name": "dataId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [],
"secure": false,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [],
"isBinary": false,
"hasBody": false
},
"response": {
"comments": "Binary data.
", "headers": [ { "name": "content-type", "comments": "application/octet-stream",
"optional": false,
"required": false,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": true,
"hasBody": false
}
},
{
"id": "1aaaa26184691ebc28c7f7c1be77be15",
"name": "",
"methodName": "PublicGet_DataId_Filename",
"namespace": [
"Data"
],
"urlTemplate": "Data/{dataId}/{filename}",
"method": "GET",
"urlParameters": [
{
"name": "dataId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
},
{
"name": "filename",
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "",
"isAuth": false
}
],
"querystringParameters": [],
"secure": false,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [],
"isBinary": false,
"hasBody": false
},
"response": {
"comments": "Binary data.
", "headers": [ { "name": "content-type", "comments": "Determined by the filename extension.", "optional": false, "required": false, "isContentType": true, "isAccept": false, "isAuth": false } ], "isBinary": true, "hasBody": false } } ] } ] }, { "name": "EasySMTP", "comments": "EasySMTP endpoint provides single email transactions.
\nEasySMTP (ReachMail's smtp relay service) does not have access to ReachMail API endpoints and visa versa. Users will see a 403 response if they try to access an endpoint for which they have not been granted access. Access can be granted to both services on any account if desired. \nPlease contact support@reachmail.com to request additional access for your account. All EasySMTP endpoints are named as such in this documentation page. If \"easysmtp\" does not appear in the endpoint name, that service can only be used by ReachMail customers until additional access is granted.
", "resources": [ { "name": "/EasySmtp", "comments": "EasySMTP message delivery.
\nAll messages are signed with ReachMail DKIM keys. Custom signature keys can be created\r\nfor domains that are used in the From field of a message. To configure custom signatures, \r\nuse the Dkim endpoints.
EasySMTP delivery.
", "methodName": "Post_AccountId", "namespace": [ "EasySmtp" ], "urlTemplate": "EasySmtp/{accountId}", "method": "POST", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "4d45bae14c545fa1b6a1f767bde7b0e5",
"name": "Message",
"logicalName": "Request",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "FromAddress",
"comments": "Message from address.",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Recipients",
"comments": "Message recipients.",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Recipients",
"comments": "Message recipients.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Recipient",
"type": {
"id": "a51d1d5bf5581c1ebbe3928fba992807",
"name": "Recipient",
"logicalName": "Recipients",
"namespace": "Recipients",
"fullNamespace": [
"Post_AccountId",
"Recipients"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Address",
"comments": "Recipient email address.",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Subject",
"comments": "Email subject.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BodyText",
"comments": "Plain text message body.",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BodyHtml",
"comments": "HTML message body.",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Headers",
"comments": "SMTP headers.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Headers",
"comments": "SMTP headers.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": false,
"isDictionary": true,
"dictionaryEntry": {
"keyType": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"valueType": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
}
},
{
"name": "Attachments",
"comments": "Message attachments.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Attachments",
"comments": "Message attachments.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Attachment",
"type": {
"id": "e4593238d9677163820aa515852ade88",
"name": "Attachment",
"logicalName": "Attachments",
"namespace": "Attachments",
"fullNamespace": [
"Post_AccountId",
"Attachments"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Filename",
"comments": "Attachment filename.",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Data",
"comments": "Base64 encoded file data.",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ContentType",
"comments": "Attachment MIME type as described here.",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ContentDisposition",
"comments": "Content disposition as described here.",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ContentTransferEncoding",
"comments": "Content transfer encoding",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Cid",
"comments": "MIME content id as described here.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Tracking",
"comments": "Enable message tracking.",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Campaign",
"comments": "Set a campaign name for this message. The campaign name can be used to filter report results and webhook calls.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Profile",
"comments": "Set the profile name to be used during delivery. This is an advanced feature for users leasing dedicated IP or those needing differentiated traffic routing.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ContentTransferEncoding",
"comments": "Default is quoted-printable. Other options are 7bit, 8bit, and base64.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "9ec630b07d55be2a26275a242cb9aac6",
"name": "DeliveryStatus",
"logicalName": "Response",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"comments": "Id of the message.",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Failures",
"comments": "Indicates if delivery failed for one or more recipients.",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FailedAddresses",
"comments": "List of delivery failures.",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "FailedAddresses",
"comments": "List of delivery failures.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "FailedAddress",
"type": {
"id": "dba92616ce1f187ec41706fcd62aeca5",
"name": "FailedAddress",
"logicalName": "FailedAddresses",
"namespace": "FailedAddresses",
"fullNamespace": [
"Post_AccountId",
"FailedAddresses"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Email",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Reason",
"optional": false,
"sampleValue": "AddressInvalid",
"deprecated": false,
"type": {
"id": "36e9d454ef1ec2da4c563e1c9ee22585",
"name": "FailureType",
"namespace": "FailedAddressesReason",
"fullNamespace": [
"Post_AccountId",
"FailedAddresses",
"FailedAddressesReason"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "AddressBlocked",
"enumeration": {
"name": "FailureType",
"options": [
{
"name": "AddressBlocked",
"value": "AddressBlocked",
"comments": "Addresses blocked by global opt-out list, pattern opt-out list, or account opt-out list."
},
{
"name": "AddressInvalid",
"value": "AddressInvalid",
"comments": "Known hard bounces"
},
{
"name": "AddressSyntaxInvalid",
"value": "AddressSyntaxInvalid",
"comments": "Poorly formatted addresses, e.g. '@whatever.'"
},
{
"name": "SendingRateLimitExceeded",
"value": "SendingRateLimitExceeded",
"comments": "Sending rate limit exceeded."
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "CurrentVolume",
"comments": "Current volume as of this mailing.",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/EasySmtp/Advanced",
"comments": "The advanced EasySMTP API endpoint provides a way to send complex messages with \r\na variety of mixed content types.
\nWhen sending email via the advanced sending endpoint, the various metdata components of\r\nthe message (including recipients, subject, header, substitutions, etc.) are contained\r\nin an array called Personalizations.
The Personalizations section is like the envelope of the letter: the fields defined\r\nthere pertain to each individual email, not the recipient. Similar to an envelope,\r\npersonalizations are used to identify who should receive an email and how the email should\r\nbe handled. In this section you can specify what headers should be included as well as any\r\nsubstitutions that you would like to include in the email.
Personalizations allow you to set:
To - The recipient of the email.Subject - The subject of the email.Headers - Any headers you want the email to include.Substitutions - Any substitutions to be made in the email.Though the Personalizations parameter array must contain at least one \"to\" object, you\r\ncan specify many separate objects to deliver to multiple recipients.
Substitutions in the message bodies can be carried out by specifying named tokens in each \r\npersonalization object that also appear in the message body.
\nFor example, if the Substitutions object looks like this:
...\n\"Substitutions\": {\"fname\": \"Jane\"}\n...\n\r\nand the message body looks like this:
\nHello {{fname}}
\nThe final email will include Hello Jane.
All messages are signed with ReachMail DKIM keys. Custom signature keys can be created\r\nfor domains that are used in the From field of a message. To configure custom signatures,\r\nuse the Dkim endpoints.
The x-rm-campaign header is a special feature of Easy-SMTP that allows message \r\nrecipients to be tagged with a campaign name in delivery reporting results.
To use x-rm-campaign, just set x-rm-campaign: [CAMPAIGN NAME] in the headers of \r\nyour message.
Example
\n...\nDate: 24 July 2011 08:00:00\nx-rm-campaign: Forum Users\nSubject: Welcome to the Acme Company forum!\n...\nThe campaign name can also be set in the Settings object by using the Campaign property.
Example
\n...\n\"Settings\": {\n ...\n \"Campaign\": \"Forum Users\"\n ...\n}\nThe x-rm-profile header is an advanced feature for senders leasing dedicated IPs \r\nwith ReachMail, or those needing differentiated traffic routing, for example, \r\nmarketing and transactional email streams.
Example
\n...\nDate: 24 July 2011 08:00:00\nx-rm-profile: promotions\nSubject: Welcome to the Acme Company forum!\n...\nThe profile can also be set in the Settings object by using the Profile property.
Example
\n...\n\"Settings\": {\n ...\n \"Profile\": \"Transactional\"\n ...\n}\napplication/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "a6735e9033ebfa4ca7f0f7a56c818b8d",
"name": "AdvancedRequest",
"logicalName": "Request",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Personalizations",
"comments": "An array of messages and their metadata. Each personalization can be thought of as an envelope, it defines who receives the message and how the message should be handled.",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Personalizations",
"comments": "An array of messages and their metadata. Each personalization can be thought of as an envelope, it defines who receives the message and how the message should be handled.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Personalization",
"type": {
"id": "df7c5cb5c2f8dfcf5dba75e59ae576df",
"name": "Personalization",
"logicalName": "Personalizations",
"namespace": "Personalizations",
"fullNamespace": [
"Post_AccountId",
"Personalizations"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "To",
"comments": "The email address of this recipient.",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "b345d3ca7a2d33db8e47e9574b45b46a",
"name": "MailBoxAddress",
"logicalName": "To",
"namespace": "To",
"fullNamespace": [
"Post_AccountId",
"Personalizations",
"To"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"comments": "The friendly name of this address.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Email",
"comments": "Full email address, e.g. jane@domain.com",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "Subject",
"comments": "Subject of this message. Will override the subject set at the message level.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Headers",
"comments": "Header fields specific to this recipient. Will replace any existing values set at the message level.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Headers",
"comments": "Header fields specific to this recipient. Will replace any existing values set at the message level.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": false,
"isDictionary": true,
"dictionaryEntry": {
"keyType": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"valueType": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
}
},
{
"name": "Substitutions",
"comments": "A collection of key/value pairs representing substitutions in this message. These will be applied to the message content and subject.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Substitutions",
"comments": "A collection of key/value pairs representing substitutions in this message. These will be applied to the message content and subject.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": false,
"isDictionary": true,
"dictionaryEntry": {
"keyType": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"valueType": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "From",
"comments": "An email object containing the name and email of the sender.",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "b345d3ca7a2d33db8e47e9574b45b46a",
"name": "MailBoxAddress",
"logicalName": "From",
"namespace": "From",
"fullNamespace": [
"Post_AccountId",
"From"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"comments": "The friendly name of this address.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Email",
"comments": "Full email address, e.g. jane@domain.com",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "ReplyTo",
"comments": "An email object containing name and email of the reply-to address",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "b345d3ca7a2d33db8e47e9574b45b46a",
"name": "MailBoxAddress",
"logicalName": "ReplyTo",
"namespace": "ReplyTo",
"fullNamespace": [
"Post_AccountId",
"ReplyTo"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"comments": "The friendly name of this address.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Email",
"comments": "Full email address, e.g. jane@domain.com",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "Contents",
"comments": "A collection specifying the content of the message. Multiple MIME types can be included but at least one should be specified.",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Contents",
"comments": "A collection specifying the content of the message. Multiple MIME types can be included but at least one should be specified.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "MessageContent",
"type": {
"id": "ca85c6635b04af5745176f0c24cd8a67",
"name": "MessageContent",
"logicalName": "Contents",
"namespace": "Contents",
"fullNamespace": [
"Post_AccountId",
"Contents"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Type",
"comments": "Content MIME type as described here.",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Content",
"comments": "The actual content to be included in the message.",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Headers",
"comments": "A collection of key/value pairs to be used as headers for this content section.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Headers",
"comments": "A collection of key/value pairs to be used as headers for this content section.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": false,
"isDictionary": true,
"dictionaryEntry": {
"keyType": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"valueType": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Attachments",
"comments": "A collection of objects representing any message attachments.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Attachments",
"comments": "A collection of objects representing any message attachments.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Attachment",
"type": {
"id": "77f8c4cb0be740f1b79a922ac4b3dcba",
"name": "Attachment",
"logicalName": "Attachments",
"namespace": "Attachments",
"fullNamespace": [
"Post_AccountId",
"Attachments"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Type",
"comments": "Attachment MIME type as described here.",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Content",
"comments": "Base64 encoded attachment data.",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FileName",
"comments": "Attachment file name.",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Disposition",
"comments": "Content disposition as described here.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Cid",
"comments": "Attachment content id.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Headers",
"comments": "A collection of key/value pairs to be used as headers for this attachment.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Headers",
"comments": "A collection of key/value pairs to be used as headers for this attachment.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": false,
"isDictionary": true,
"dictionaryEntry": {
"keyType": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"valueType": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Headers",
"comments": "A collection of key/value pairs representing headers for this message.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Headers",
"comments": "A collection of key/value pairs representing headers for this message.",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": false,
"isDictionary": true,
"dictionaryEntry": {
"keyType": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"valueType": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
}
},
{
"name": "Settings",
"comments": "Message specific settings, i.e. enable tracking, etc.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "2d76a4b3b63dd1b1960fdcb789146849",
"name": "MessageSettings",
"logicalName": "Settings",
"namespace": "Settings",
"fullNamespace": [
"Post_AccountId",
"Settings"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Tracking",
"comments": "Toggle open/click tracking for this message.",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Campaign",
"comments": "Set a campaign name for this message. The campaign name can be used to filter report results and webhook calls.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Profile",
"comments": "Set the profile name to be used during delivery. This is an advanced feature for users leasing dedicated IP or those needing differentiated traffic routing.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "Subject",
"comments": "The message subject.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "e4b785c1627e284dcf229e067614edee",
"name": "DeliveryResponse",
"logicalName": "Response",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"comments": "Id of the transaction.",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CurrentVolume",
"comments": "Current volume as of this mailing.",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Message",
"comments": "Transaction status message",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Sent",
"comments": "List of accepted addresses",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Sent",
"comments": "List of accepted addresses",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "string",
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/EasySmtp/SpamCheck",
"comments": "The EasySMTP spam check endpoints allow for creation and management of a unique email address that is used as\r\na submission point for using EasySMTP's spam checking tools.
\nOnce the spam check email address has been generated, use it in the send a message to it using the API or SMTP\r\nsubmission methods. After processing the analysis will be available from the Results endpoints.
\nAfter submitting, analysis results will be available from the Logs endpoint.
", "endpoints": [ { "id": "ca939177eab5ee9d3f1b692e8fae6377", "name": "", "methodName": "Get", "namespace": [ "EasySmtp", "SpamCheck" ], "urlTemplate": "EasySmtp/SpamCheck", "method": "GET", "urlParameters": [], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "accept", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "ArrayOfSpamCheckEmailAccountModel",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "SpamCheckEmailAccountModel",
"type": {
"id": "8bb8209892c04d97a27348a18de2ebb4",
"name": "SpamCheckEmailAccountModel",
"logicalName": "Response",
"namespace": "Get",
"fullNamespace": [
"Get"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EmailAddress",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AccountId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "02d9d0cd3376c2d1248a69d77a64fb0c",
"name": "",
"methodName": "Post",
"namespace": [
"EasySmtp",
"SpamCheck"
],
"urlTemplate": "EasySmtp/SpamCheck",
"method": "POST",
"urlParameters": [],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "8bb8209892c04d97a27348a18de2ebb4",
"name": "SpamCheckEmailAccountModel",
"logicalName": "Response",
"namespace": "Post",
"fullNamespace": [
"Post"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EmailAddress",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AccountId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "37510e8015dbe5edea0af91e7747f817",
"name": "",
"methodName": "Put",
"namespace": [
"EasySmtp",
"SpamCheck"
],
"urlTemplate": "EasySmtp/SpamCheck",
"method": "PUT",
"urlParameters": [],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "8bb8209892c04d97a27348a18de2ebb4",
"name": "SpamCheckEmailAccountModel",
"logicalName": "Response",
"namespace": "Put",
"fullNamespace": [
"Put"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EmailAddress",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AccountId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/EasySmtp/SpamCheck/Logs",
"comments": "The EasySMTP spam check endpoints allow for creation and management of a unique email address that is used as\r\na submission point for using EasySMTP's spam checking tools.
\nOnce the spam check email address has been generated, use it in the send a message to it using the API or SMTP\r\nsubmission methods. After processing the analysis will be available from the Results endpoints.
\nAfter submitting, analysis results will be available from the Logs endpoint.
", "endpoints": [ { "id": "dc30cac8643ecb3894f25ac40df17b9f", "name": "", "methodName": "Get_Logs", "namespace": [ "EasySmtp", "SpamCheck", "Logs" ], "urlTemplate": "EasySmtp/SpamCheck/Logs", "method": "GET", "urlParameters": [], "querystringParameters": [ { "name": "skip", "type": { "name": "int", "isNullable": true, "isSimple": true, "sampleValue": "0", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "0", "multipleAllowed": false, "required": false, "isAuth": false }, { "name": "take", "type": { "name": "int", "isNullable": true, "isSimple": true, "sampleValue": "0", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "0", "multipleAllowed": false, "required": false, "isAuth": false } ], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "accept", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "6006ca0f4b995de610ec36c488633c00",
"name": "SpamCheckLogResults",
"logicalName": "Response",
"namespace": "Get_Logs",
"fullNamespace": [
"Get_Logs"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "SpamCheckLogs",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "SpamCheckLogs",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "SpamCheckLogModel",
"type": {
"id": "b1e31f6aedce419abadc1858303f3d37",
"name": "SpamCheckLogModel",
"logicalName": "SpamCheckLogs",
"namespace": "SpamCheckLogs",
"fullNamespace": [
"Get_Logs",
"SpamCheckLogs"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EasySmtpRecipientId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Subject",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Score",
"optional": false,
"sampleValue": "0.00",
"deprecated": false,
"type": {
"name": "double",
"isNullable": false,
"isSimple": true,
"sampleValue": "0.00",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Report",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Source",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Next",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
}
]
}
]
},
{
"name": "Lists",
"comments": "List endpoint provides functionality for creation, deletion, and update of email list.
\nList components.
\nHere's a step-by-step guide to creating a contact list for sending emails. The process for creating a suppression list is nearly identical, with the exception of setting the list Type to Suppression.
To create a list, use thePOST method on the Lists endpoint and send the following request:
{\n \"Name\": \"My First List\",\n \"Type\": \"Recipient\"\n}
This will return a unique Id that you will use to reference the list in future actions.\nIf you don't specify any fields, the list will be created with the default field, which is just the Email address. The nxt step is to add recipients to this newly created list.
To add recipients to your list, use the POST method on the Lists/Recipients with the following request:
{\n \"Email\": \"myemail@domain.com\"\n}
Using the endpoint /Lists/Recipients/MyAccount/_List_Id_Above_ to add recipients to your list\nOne the lists contains one or more recipients, it can be use in a Campaign
Importing a list of contacts requires use of a few different resources.
\nBegin by creating a list as described above or use the GET method on the Lists endpoint to\nenumerate and locate an existing list. If you have many lists you can make a POST request to the\nLists/Filtered endpoint to refine your search. Keep track of the Id value of the\nlist. You will use that later.
After you have the destination list id, make a POST request to the Data endpoint to load your\ncontact list. The contact list should be uploaded as binary data. Refer to the code examples in the POST section\nof Data for more details. Keep track of the Id value returned by the Data\nendpoint.
Make a Post request to the Lists/Import endpoint, setting the saved data id and list id\nas needed. The request should also map the source file field position to the destination field name. For example, if\nyour contact file has an email column followed by a first name column, the field mappings would look like this:
[\n {\n \"destinationFieldName\": \"email\",\n \"sourceFieldPosition\": 1\n },\n {\n \"destinationFieldName\": \"first_name\",\n \"sourceFieldPosition\": 2\n }\n]For a list of field names make a GET request to Lists/Fields. Any field mappings included\nin the import request that are not present in the destination list will be skipped. Again, keep track of the Id\nreturned by the request.
Imports may take some time to complete if a contact file is large. Imports should be periodically polled to check their\nstatus using a GET request to Lists/Import/Status. Once the Status value in the response\nindicates Complete the import is done and the list can be used in Campaigns.
Use the Lists/Fields endpoint to get a list of the available fields.
\nThis will include the field name and information about the data type.
Use the Lists PUT endpoints to add one or more fields to a list. The field names are specified as a comma separated list.\nFor example, to add fields for the City and State to an existing list, use the following request:
\n{\n \"fields\": [\n \"City\", \"State\"\n ]\n}
The field names are case-insensitive, names that are not valid will be ignored. \nFields are only added to the list if they do not already exist.
\nExisting fields will not be removed.
application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "Lists",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "List",
"type": {
"id": "80ed0649be37d1d81b0d4a93ebe6d51b",
"name": "List",
"logicalName": "Response",
"namespace": "Get",
"fullNamespace": [
"Get"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "CreateDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "GroupId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ContentType",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalActiveRecipients",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalInactiveRecipients",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalRecipients",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Type",
"optional": false,
"sampleValue": "GlobalOptOut",
"deprecated": false,
"type": {
"id": "13f93e8e200ffb582c435387e75cdc71",
"name": "ListType",
"namespace": "ResponseType",
"fullNamespace": [
"Get",
"ResponseType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "GlobalOptOut",
"enumeration": {
"name": "ListType",
"options": [
{
"name": "GlobalOptOut",
"value": "GlobalOptOut"
},
{
"name": "Md5Suppression",
"value": "Md5Suppression"
},
{
"name": "Recipient",
"value": "Recipient"
},
{
"name": "Suppression",
"value": "Suppression"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Fields",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Fields",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Field",
"type": {
"id": "32e4ae9023bff32a2d72ada67ba78f2e",
"name": "Field",
"logicalName": "Fields",
"namespace": "Fields",
"fullNamespace": [
"Get",
"Fields"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Description",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Length",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Type",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Personalization",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "02912fe9fc8103d46106b5e1dab87b82",
"name": "",
"comments": "Create a list.
", "methodName": "Post", "namespace": [ "Lists" ], "urlTemplate": "Lists", "method": "POST", "urlParameters": [], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "47bd9f76a5eaaca966716b8c49be85d8",
"name": "ListProperties",
"logicalName": "Request",
"namespace": "Post",
"fullNamespace": [
"Post"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Type",
"optional": true,
"sampleValue": "GlobalOptOut",
"deprecated": false,
"type": {
"id": "7da119c3898ba2f06eef4443abc906f5",
"name": "string",
"namespace": "RequestType",
"fullNamespace": [
"Post",
"RequestType"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "GlobalOptOut",
"enumeration": {
"name": "ListType",
"options": [
{
"name": "GlobalOptOut",
"value": "GlobalOptOut"
},
{
"name": "Md5Suppression",
"value": "Md5Suppression"
},
{
"name": "Recipient",
"value": "Recipient"
},
{
"name": "Suppression",
"value": "Suppression"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "GroupId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Fields",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Fields",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Name",
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "PublicName",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "2dfc423a9d5513ae8570e537c7170b6f",
"name": "List",
"logicalName": "Response",
"namespace": "Post",
"fullNamespace": [
"Post"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "d61b67bcddcf2bf9b8a69ff6fc8f5692",
"name": "",
"methodName": "Get_AccountId",
"namespace": [
"Lists"
],
"urlTemplate": "Lists/{accountId}",
"method": "GET",
"urlParameters": [
{
"name": "accountId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "Lists",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "List",
"type": {
"id": "80ed0649be37d1d81b0d4a93ebe6d51b",
"name": "List",
"logicalName": "Response",
"namespace": "Get_AccountId",
"fullNamespace": [
"Get_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "CreateDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "GroupId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ContentType",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalActiveRecipients",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalInactiveRecipients",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalRecipients",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Type",
"optional": false,
"sampleValue": "GlobalOptOut",
"deprecated": false,
"type": {
"id": "13f93e8e200ffb582c435387e75cdc71",
"name": "ListType",
"namespace": "ResponseType",
"fullNamespace": [
"Get_AccountId",
"ResponseType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "GlobalOptOut",
"enumeration": {
"name": "ListType",
"options": [
{
"name": "GlobalOptOut",
"value": "GlobalOptOut"
},
{
"name": "Md5Suppression",
"value": "Md5Suppression"
},
{
"name": "Recipient",
"value": "Recipient"
},
{
"name": "Suppression",
"value": "Suppression"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Fields",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Fields",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Field",
"type": {
"id": "32e4ae9023bff32a2d72ada67ba78f2e",
"name": "Field",
"logicalName": "Fields",
"namespace": "Fields",
"fullNamespace": [
"Get_AccountId",
"Fields"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Description",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Length",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Type",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Personalization",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "61788c5947da9aeb8c1410c334d82a1e",
"name": "",
"comments": "Create a list.
", "methodName": "Post_AccountId", "namespace": [ "Lists" ], "urlTemplate": "Lists/{accountId}", "method": "POST", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "47bd9f76a5eaaca966716b8c49be85d8",
"name": "ListProperties",
"logicalName": "Request",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Type",
"optional": true,
"sampleValue": "GlobalOptOut",
"deprecated": false,
"type": {
"id": "7da119c3898ba2f06eef4443abc906f5",
"name": "string",
"namespace": "RequestType",
"fullNamespace": [
"Post_AccountId",
"RequestType"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "GlobalOptOut",
"enumeration": {
"name": "ListType",
"options": [
{
"name": "GlobalOptOut",
"value": "GlobalOptOut"
},
{
"name": "Md5Suppression",
"value": "Md5Suppression"
},
{
"name": "Recipient",
"value": "Recipient"
},
{
"name": "Suppression",
"value": "Suppression"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "GroupId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Fields",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Fields",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Name",
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "PublicName",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "2dfc423a9d5513ae8570e537c7170b6f",
"name": "List",
"logicalName": "Response",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "31413f8f77f628e5b995150c269947db",
"name": "",
"methodName": "Get_AccountId_ListId",
"namespace": [
"Lists"
],
"urlTemplate": "Lists/{accountId}/{listId}",
"method": "GET",
"urlParameters": [
{
"name": "accountId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
},
{
"name": "listId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "80ed0649be37d1d81b0d4a93ebe6d51b",
"name": "List",
"logicalName": "Response",
"namespace": "Get_AccountId_ListId",
"fullNamespace": [
"Get_AccountId_ListId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "CreateDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "GroupId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ContentType",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalActiveRecipients",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalInactiveRecipients",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalRecipients",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Type",
"optional": false,
"sampleValue": "GlobalOptOut",
"deprecated": false,
"type": {
"id": "13f93e8e200ffb582c435387e75cdc71",
"name": "ListType",
"namespace": "ResponseType",
"fullNamespace": [
"Get_AccountId_ListId",
"ResponseType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "GlobalOptOut",
"enumeration": {
"name": "ListType",
"options": [
{
"name": "GlobalOptOut",
"value": "GlobalOptOut"
},
{
"name": "Md5Suppression",
"value": "Md5Suppression"
},
{
"name": "Recipient",
"value": "Recipient"
},
{
"name": "Suppression",
"value": "Suppression"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Fields",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Fields",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Field",
"type": {
"id": "32e4ae9023bff32a2d72ada67ba78f2e",
"name": "Field",
"logicalName": "Fields",
"namespace": "Fields",
"fullNamespace": [
"Get_AccountId_ListId",
"Fields"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Description",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Length",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Type",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Personalization",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "601200c5fb55c9dd70df5718ba88b264",
"name": "",
"comments": "Modify a list.
", "methodName": "Put_AccountId_ListId", "namespace": [ "Lists" ], "urlTemplate": "Lists/{accountId}/{listId}", "method": "PUT", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "listId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "564a1d1bce04217c2cd26eb08f9713b4",
"name": "ListProperties",
"logicalName": "Request",
"namespace": "Put_AccountId_ListId",
"fullNamespace": [
"Put_AccountId_ListId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "GroupId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Fields",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Fields",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Name",
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [],
"isBinary": false,
"hasBody": false
}
},
{
"id": "15a1505d3dd2101cb2a8ee1bb4763d5c",
"name": "",
"comments": "Delete a list.
", "methodName": "Delete_AccountId_ListId", "namespace": [ "Lists" ], "urlTemplate": "Lists/{accountId}/{listId}", "method": "DELETE", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "listId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [], "isBinary": false, "hasBody": false }, "response": { "headers": [], "isBinary": false, "hasBody": false } }, { "id": "26a9ef3c8ce227c3bd5b2511815501eb", "name": "", "comments": "Modify a list.
", "methodName": "Put_ListId", "namespace": [ "Lists" ], "urlTemplate": "Lists/{listId}", "method": "PUT", "urlParameters": [ { "name": "listId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "564a1d1bce04217c2cd26eb08f9713b4",
"name": "ListProperties",
"logicalName": "Request",
"namespace": "Put_ListId",
"fullNamespace": [
"Put_ListId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "GroupId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Fields",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Fields",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Name",
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [],
"isBinary": false,
"hasBody": false
}
},
{
"id": "2a90ea23336f1c7f816ce95b74d4dd72",
"name": "",
"comments": "Delete a list.
", "methodName": "Delete_ListId", "namespace": [ "Lists" ], "urlTemplate": "Lists/{listId}", "method": "DELETE", "urlParameters": [ { "name": "listId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [], "isBinary": false, "hasBody": false }, "response": { "headers": [], "isBinary": false, "hasBody": false } } ] }, { "name": "/Lists/Export", "comments": "List export.
", "endpoints": [ { "id": "ae8098bba5aca8bf344d4f3f6643def2", "name": "", "comments": "Export a list.
", "methodName": "Post_AccountId_ListId", "namespace": [ "Lists", "Export" ], "urlTemplate": "Lists/Export/{accountId}/{listId}", "method": "POST", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "listId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "6ae4e069c38a5adfc287539faf2b3366",
"name": "ExportParameters",
"logicalName": "Request",
"namespace": "Post_AccountId_ListId",
"fullNamespace": [
"Post_AccountId_ListId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "ExportOptions",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "f1659492413bdd602dc7b9e3922f8554",
"name": "ExportOptions",
"logicalName": "ExportOptions",
"namespace": "ExportOptions",
"fullNamespace": [
"Post_AccountId_ListId",
"ExportOptions"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Format",
"optional": false,
"sampleValue": "CharacterSeperated",
"deprecated": false,
"type": {
"id": "bcff9c14dba016e5307cea0394ae4ca2",
"name": "ExportFormat",
"namespace": "ExportOptionsFormat",
"fullNamespace": [
"Post_AccountId_ListId",
"ExportOptions",
"ExportOptionsFormat"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "CharacterSeperated",
"enumeration": {
"name": "ExportFormat",
"options": [
{
"name": "CharacterSeperated",
"value": "CharacterSeperated"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "HeaderRow",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CharacterSeperatedData",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "1277208f7ca3c3304153c326458fd1c0",
"name": "CharacterSeperatedOptions",
"logicalName": "CharacterSeperatedData",
"namespace": "CharacterSeperatedData",
"fullNamespace": [
"Post_AccountId_ListId",
"ExportOptions",
"CharacterSeperatedData"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Delimiter",
"optional": false,
"sampleValue": "Comma",
"deprecated": false,
"type": {
"id": "ea59ebed29a1aa1de12917cba5641401",
"name": "Delimiter",
"namespace": "CharacterSeperatedDataDelimiter",
"fullNamespace": [
"Post_AccountId_ListId",
"ExportOptions",
"CharacterSeperatedData",
"CharacterSeperatedDataDelimiter"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Comma",
"enumeration": {
"name": "Delimiter",
"options": [
{
"name": "Comma",
"value": "Comma"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "FieldMapping",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "FieldMapping",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "FieldMapping",
"type": {
"id": "63abf4cc92df3b00659b9202b3d459c1",
"name": "FieldMapping",
"logicalName": "FieldMapping",
"namespace": "FieldMapping",
"fullNamespace": [
"Post_AccountId_ListId",
"ExportOptions",
"FieldMapping"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "SourceFieldName",
"comments": "Name of the source list field. These can be enumerated here.",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DestinationFieldName",
"comments": "Name of the destination column if the file has a header. If a destination column name is not specified a column index must be.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "b02b2c908c07b3b60756bf824c24921c",
"name": "Export",
"logicalName": "Response",
"namespace": "Post_AccountId_ListId",
"fullNamespace": [
"Post_AccountId_ListId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "2a24a7954743cf39a1ccbf64dcf390f8",
"name": "",
"comments": "Export a list.
", "methodName": "Post_ListId", "namespace": [ "Lists", "Export" ], "urlTemplate": "Lists/Export/{listId}", "method": "POST", "urlParameters": [ { "name": "listId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "6ae4e069c38a5adfc287539faf2b3366",
"name": "ExportParameters",
"logicalName": "Request",
"namespace": "Post_ListId",
"fullNamespace": [
"Post_ListId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "ExportOptions",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "f1659492413bdd602dc7b9e3922f8554",
"name": "ExportOptions",
"logicalName": "ExportOptions",
"namespace": "ExportOptions",
"fullNamespace": [
"Post_ListId",
"ExportOptions"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Format",
"optional": false,
"sampleValue": "CharacterSeperated",
"deprecated": false,
"type": {
"id": "bcff9c14dba016e5307cea0394ae4ca2",
"name": "ExportFormat",
"namespace": "ExportOptionsFormat",
"fullNamespace": [
"Post_ListId",
"ExportOptions",
"ExportOptionsFormat"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "CharacterSeperated",
"enumeration": {
"name": "ExportFormat",
"options": [
{
"name": "CharacterSeperated",
"value": "CharacterSeperated"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "HeaderRow",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CharacterSeperatedData",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "1277208f7ca3c3304153c326458fd1c0",
"name": "CharacterSeperatedOptions",
"logicalName": "CharacterSeperatedData",
"namespace": "CharacterSeperatedData",
"fullNamespace": [
"Post_ListId",
"ExportOptions",
"CharacterSeperatedData"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Delimiter",
"optional": false,
"sampleValue": "Comma",
"deprecated": false,
"type": {
"id": "ea59ebed29a1aa1de12917cba5641401",
"name": "Delimiter",
"namespace": "CharacterSeperatedDataDelimiter",
"fullNamespace": [
"Post_ListId",
"ExportOptions",
"CharacterSeperatedData",
"CharacterSeperatedDataDelimiter"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Comma",
"enumeration": {
"name": "Delimiter",
"options": [
{
"name": "Comma",
"value": "Comma"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "FieldMapping",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "FieldMapping",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "FieldMapping",
"type": {
"id": "63abf4cc92df3b00659b9202b3d459c1",
"name": "FieldMapping",
"logicalName": "FieldMapping",
"namespace": "FieldMapping",
"fullNamespace": [
"Post_ListId",
"ExportOptions",
"FieldMapping"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "SourceFieldName",
"comments": "Name of the source list field. These can be enumerated here.",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DestinationFieldName",
"comments": "Name of the destination column if the file has a header. If a destination column name is not specified a column index must be.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "b02b2c908c07b3b60756bf824c24921c",
"name": "Export",
"logicalName": "Response",
"namespace": "Post_ListId",
"fullNamespace": [
"Post_ListId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Lists/Export/Status",
"comments": "List export status.
", "endpoints": [ { "id": "e5201325642e7ed65369bb51e9ceac0f", "name": "", "comments": "Get the status of a list export.
", "methodName": "Get_AccountId_ExportId", "namespace": [ "Lists", "Export", "Status" ], "urlTemplate": "Lists/Export/Status/{accountId}/{exportId}", "method": "GET", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "exportId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "accept", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "d92da75c92f166a301e38dc98ace5ad8",
"name": "ExportStatus",
"logicalName": "Response",
"namespace": "Get_AccountId_ExportId",
"fullNamespace": [
"Get_AccountId_ExportId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Duration",
"comments": "Note: Time spans are formatted as d.hh:mm:ss.n.",
"optional": false,
"sampleValue": "0:00:00",
"deprecated": false,
"type": {
"name": "duration",
"isNullable": false,
"isSimple": true,
"sampleValue": "0:00:00",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Complete",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "RecordsProcessed",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DataId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Lists/Fields",
"comments": "List fields.
\nGet a list of available fields you can use in lists.\nThe data for each field is as follows:
\n1. Name - The name of the field, use when creating a list or adding fields to a list.
\n2. Description - A description of the field.
\n3. Length - The maximum size of data in this field
\n4. Type - The type of the field (String, DateTime or Integer)
\n5. Personalization - This is the string to use within the mailing contents that will be replaced with the value of this field.
\nCheck out this documentation for more information
", "endpoints": [ { "id": "5a5916a298ffbded950441b530f5bd5e", "name": "", "comments": "Enumerate list fields.
", "methodName": "Get", "namespace": [ "Lists", "Fields" ], "urlTemplate": "Lists/Fields", "method": "GET", "urlParameters": [], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "accept", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "Fields",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Field",
"type": {
"id": "32e4ae9023bff32a2d72ada67ba78f2e",
"name": "Field",
"logicalName": "Response",
"namespace": "Get",
"fullNamespace": [
"Get"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Description",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Length",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Type",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Personalization",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "6411bf15ce141c199d7693430aba0b75",
"name": "",
"comments": "Enumerate list fields.
", "methodName": "Get_AccountId", "namespace": [ "Lists", "Fields" ], "urlTemplate": "Lists/Fields/{accountId}", "method": "GET", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "accept", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "Fields",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Field",
"type": {
"id": "32e4ae9023bff32a2d72ada67ba78f2e",
"name": "Field",
"logicalName": "Response",
"namespace": "Get_AccountId",
"fullNamespace": [
"Get_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Description",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Length",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Type",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Personalization",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Lists/Fields/Filtered",
"comments": "List fields.
\nGet a list of available fields you can use in lists.\nThe data for each field is as follows:
\n1. Name - The name of the field, use when creating a list or adding fields to a list.
\n2. Description - A description of the field.
\n3. Length - The maximum size of data in this field
\n4. Type - The type of the field (String, DateTime or Integer)
\n5. Personalization - This is the string to use within the mailing contents that will be replaced with the value of this field.
\nCheck out this documentation for more information
", "endpoints": [ { "id": "2ed6a4342dcb034fb1c07e4f33836ffa", "name": "", "comments": "Enumerate list fields.
", "methodName": "Get_Filtered_ListId", "namespace": [ "Lists", "Fields", "Filtered" ], "urlTemplate": "Lists/Fields/Filtered/{listId}", "method": "GET", "urlParameters": [ { "name": "listId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "accept", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "Fields",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Field",
"type": {
"id": "32e4ae9023bff32a2d72ada67ba78f2e",
"name": "Field",
"logicalName": "Response",
"namespace": "Get_Filtered_ListId",
"fullNamespace": [
"Get_Filtered_ListId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Description",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Length",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Type",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Personalization",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Lists/Filtered",
"comments": "List query.
", "endpoints": [ { "id": "8ddbb38e1c125754eb191fafd6292074", "name": "", "comments": "Query lists.
", "methodName": "Post", "namespace": [ "Lists", "Filtered" ], "urlTemplate": "Lists/Filtered", "method": "POST", "urlParameters": [], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "6ca430dd7e3dc79e82128611c993d1da",
"name": "ListFilter",
"logicalName": "Request",
"namespace": "Post",
"fullNamespace": [
"Post"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "GroupId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "IncludeSubGroups",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ActiveLargerThan",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ActiveSmallerThan",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "InactiveLargerThan",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "InactiveSmallerThan",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LargerThan",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SmallerThan",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "StartIndex",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MaxResults",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "NewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "Lists",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "List",
"type": {
"id": "80ed0649be37d1d81b0d4a93ebe6d51b",
"name": "List",
"logicalName": "Response",
"namespace": "Post",
"fullNamespace": [
"Post"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "CreateDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "GroupId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ContentType",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalActiveRecipients",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalInactiveRecipients",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalRecipients",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Type",
"optional": false,
"sampleValue": "GlobalOptOut",
"deprecated": false,
"type": {
"id": "13f93e8e200ffb582c435387e75cdc71",
"name": "ListType",
"namespace": "ResponseType",
"fullNamespace": [
"Post",
"ResponseType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "GlobalOptOut",
"enumeration": {
"name": "ListType",
"options": [
{
"name": "GlobalOptOut",
"value": "GlobalOptOut"
},
{
"name": "Md5Suppression",
"value": "Md5Suppression"
},
{
"name": "Recipient",
"value": "Recipient"
},
{
"name": "Suppression",
"value": "Suppression"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Fields",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Fields",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Field",
"type": {
"id": "32e4ae9023bff32a2d72ada67ba78f2e",
"name": "Field",
"logicalName": "Fields",
"namespace": "Fields",
"fullNamespace": [
"Post",
"Fields"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Description",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Length",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Type",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Personalization",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "716d557425b1005f0ab98a3d2fc67583",
"name": "",
"comments": "Query lists.
", "methodName": "Post_AccountId", "namespace": [ "Lists", "Filtered" ], "urlTemplate": "Lists/Filtered/{accountId}", "method": "POST", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "6ca430dd7e3dc79e82128611c993d1da",
"name": "ListFilter",
"logicalName": "Request",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "GroupId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "IncludeSubGroups",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ActiveLargerThan",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ActiveSmallerThan",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "InactiveLargerThan",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "InactiveSmallerThan",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LargerThan",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SmallerThan",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "StartIndex",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MaxResults",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "NewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "Lists",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "List",
"type": {
"id": "80ed0649be37d1d81b0d4a93ebe6d51b",
"name": "List",
"logicalName": "Response",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "CreateDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "GroupId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ContentType",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalActiveRecipients",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalInactiveRecipients",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalRecipients",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Type",
"optional": false,
"sampleValue": "GlobalOptOut",
"deprecated": false,
"type": {
"id": "13f93e8e200ffb582c435387e75cdc71",
"name": "ListType",
"namespace": "ResponseType",
"fullNamespace": [
"Post_AccountId",
"ResponseType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "GlobalOptOut",
"enumeration": {
"name": "ListType",
"options": [
{
"name": "GlobalOptOut",
"value": "GlobalOptOut"
},
{
"name": "Md5Suppression",
"value": "Md5Suppression"
},
{
"name": "Recipient",
"value": "Recipient"
},
{
"name": "Suppression",
"value": "Suppression"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Fields",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Fields",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Field",
"type": {
"id": "32e4ae9023bff32a2d72ada67ba78f2e",
"name": "Field",
"logicalName": "Fields",
"namespace": "Fields",
"fullNamespace": [
"Post_AccountId",
"Fields"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Description",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Length",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Type",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Personalization",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Lists/Groups",
"comments": "List group management.
", "endpoints": [ { "id": "fa04d238537698fda96738784e318a67", "name": "", "methodName": "Get", "namespace": [ "Lists", "Groups" ], "urlTemplate": "Lists/Groups", "method": "GET", "urlParameters": [], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "accept", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "Groups",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Group",
"type": {
"id": "068ccec0aed16c27552712f856263fa3",
"name": "Group",
"logicalName": "Response",
"namespace": "Get",
"fullNamespace": [
"Get"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "9f7be20c5f96e185466d48926139801d",
"name": "",
"comments": "Create a list group.
", "methodName": "Post", "namespace": [ "Lists", "Groups" ], "urlTemplate": "Lists/Groups", "method": "POST", "urlParameters": [], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "71dd6ed5e5e6056b2cce54a3d22c2c1f",
"name": "GroupProperties",
"logicalName": "Request",
"namespace": "Post",
"fullNamespace": [
"Post"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "1da87551aea85ff16da89a62aaa6fe5e",
"name": "Group",
"logicalName": "Response",
"namespace": "Post",
"fullNamespace": [
"Post"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "4cac40c1ae54a5c902e1e223d1adb0c4",
"name": "",
"methodName": "Get_AccountId",
"namespace": [
"Lists",
"Groups"
],
"urlTemplate": "Lists/Groups/{accountId}",
"method": "GET",
"urlParameters": [
{
"name": "accountId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "Groups",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Group",
"type": {
"id": "068ccec0aed16c27552712f856263fa3",
"name": "Group",
"logicalName": "Response",
"namespace": "Get_AccountId",
"fullNamespace": [
"Get_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "080da0e5a65c3bd8c541e25d889a9847",
"name": "",
"comments": "Create a list group.
", "methodName": "Post_AccountId", "namespace": [ "Lists", "Groups" ], "urlTemplate": "Lists/Groups/{accountId}", "method": "POST", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "71dd6ed5e5e6056b2cce54a3d22c2c1f",
"name": "GroupProperties",
"logicalName": "Request",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "1da87551aea85ff16da89a62aaa6fe5e",
"name": "Group",
"logicalName": "Response",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "e2bfc3675dc2ecf2c438f419ca79849e",
"name": "",
"methodName": "Get_AccountId_GroupId",
"namespace": [
"Lists",
"Groups"
],
"urlTemplate": "Lists/Groups/{accountId}/{groupId}",
"method": "GET",
"urlParameters": [
{
"name": "accountId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
},
{
"name": "groupId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "068ccec0aed16c27552712f856263fa3",
"name": "Group",
"logicalName": "Response",
"namespace": "Get_AccountId_GroupId",
"fullNamespace": [
"Get_AccountId_GroupId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "6b03725881746bf393f8b6340e4dd32c",
"name": "",
"comments": "Modify a list group.
", "methodName": "Put_AccountId_GroupId", "namespace": [ "Lists", "Groups" ], "urlTemplate": "Lists/Groups/{accountId}/{groupId}", "method": "PUT", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "groupId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "c15345cf4b5d7d549842253ec16ba2e4",
"name": "GroupProperties",
"logicalName": "Request",
"namespace": "Put_AccountId_GroupId",
"fullNamespace": [
"Put_AccountId_GroupId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [],
"isBinary": false,
"hasBody": false
}
},
{
"id": "6247300e94ee4acf20b0271ea661d43c",
"name": "",
"comments": "Delete a list group.
", "methodName": "Delete_AccountId_GroupId", "namespace": [ "Lists", "Groups" ], "urlTemplate": "Lists/Groups/{accountId}/{groupId}", "method": "DELETE", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "groupId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [], "isBinary": false, "hasBody": false }, "response": { "headers": [], "isBinary": false, "hasBody": false } }, { "id": "3fbaf67144f0ff92f8f3a4b5a1721aa8", "name": "", "comments": "Modify a list group.
", "methodName": "Put_GroupId", "namespace": [ "Lists", "Groups" ], "urlTemplate": "Lists/Groups/{groupId}", "method": "PUT", "urlParameters": [ { "name": "groupId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "c15345cf4b5d7d549842253ec16ba2e4",
"name": "GroupProperties",
"logicalName": "Request",
"namespace": "Put_GroupId",
"fullNamespace": [
"Put_GroupId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [],
"isBinary": false,
"hasBody": false
}
},
{
"id": "d0d46263f9a97a2663bb21cb1dc5bc03",
"name": "",
"comments": "Delete a list group.
", "methodName": "Delete_GroupId", "namespace": [ "Lists", "Groups" ], "urlTemplate": "Lists/Groups/{groupId}", "method": "DELETE", "urlParameters": [ { "name": "groupId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [], "isBinary": false, "hasBody": false }, "response": { "headers": [], "isBinary": false, "hasBody": false } } ] }, { "name": "/Lists/Import", "comments": "List import.
", "endpoints": [ { "id": "6cf9d4099f51e10323358a8136968108", "name": "", "comments": "Import a list.
", "methodName": "Post_AccountId_ListId", "namespace": [ "Lists", "Import" ], "urlTemplate": "Lists/Import/{accountId}/{listId}", "method": "POST", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "listId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "6fe23d3c4c98d1b78e949f76f2da46fe",
"name": "Parameters",
"logicalName": "Request",
"namespace": "Post_AccountId_ListId",
"fullNamespace": [
"Post_AccountId_ListId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "DataId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FieldMappings",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "FieldMappings",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "FieldMapping",
"type": {
"id": "b544934fc00f56dbfc715c402c9a6e5b",
"name": "FieldMapping",
"logicalName": "FieldMappings",
"namespace": "FieldMappings",
"fullNamespace": [
"Post_AccountId_ListId",
"FieldMappings"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "DestinationFieldName",
"comments": "Name of the destination list field. These can be enumerated here.",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SourceFieldPosition",
"comments": "1-based index of the source column. If a source column name is not specified an index must be.",
"optional": true,
"sampleValue": "1",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SourceFieldName",
"comments": "Name of the source column if the file has a header. If a source column name is not specified a column index must be.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "ImportOptions",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "3a0e474f10fb9866df4c2102209b00c4",
"name": "ImportOptions",
"logicalName": "ImportOptions",
"namespace": "ImportOptions",
"fullNamespace": [
"Post_AccountId_ListId",
"ImportOptions"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Format",
"optional": false,
"sampleValue": "CharacterSeperated",
"deprecated": false,
"type": {
"id": "519b053d0f0b0b5910d697b831a2248a",
"name": "ImportFormat",
"namespace": "ImportOptionsFormat",
"fullNamespace": [
"Post_AccountId_ListId",
"ImportOptions",
"ImportOptionsFormat"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "CharacterSeperated",
"enumeration": {
"name": "ImportFormat",
"options": [
{
"name": "CharacterSeperated",
"value": "CharacterSeperated"
},
{
"name": "Excel",
"value": "Excel"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "HeaderRow",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SkipRecordsWithErrors",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AllowStringTruncation",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AbortImportOnError",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CharacterSeperatedOptions",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "1277208f7ca3c3304153c326458fd1c0",
"name": "CharacterSeperatedOptions",
"logicalName": "CharacterSeperatedOptions",
"namespace": "CharacterSeperatedOptions",
"fullNamespace": [
"Post_AccountId_ListId",
"ImportOptions",
"CharacterSeperatedOptions"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Delimiter",
"optional": false,
"sampleValue": "Comma",
"deprecated": false,
"type": {
"id": "ea59ebed29a1aa1de12917cba5641401",
"name": "Delimiter",
"namespace": "CharacterSeperatedOptionsDelimiter",
"fullNamespace": [
"Post_AccountId_ListId",
"ImportOptions",
"CharacterSeperatedOptions",
"CharacterSeperatedOptionsDelimiter"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Comma",
"enumeration": {
"name": "Delimiter",
"options": [
{
"name": "Comma",
"value": "Comma"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "ExcelOptions",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "0f12fa8158824b7e328d2118487ddbc5",
"name": "ExcelOptions",
"logicalName": "ExcelOptions",
"namespace": "ExcelOptions",
"fullNamespace": [
"Post_AccountId_ListId",
"ImportOptions",
"ExcelOptions"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "WorksheetName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "3c3e2f55a886538f4224b0d2de093c93",
"name": "Import",
"logicalName": "Response",
"namespace": "Post_AccountId_ListId",
"fullNamespace": [
"Post_AccountId_ListId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "87245cfbf69783bc5c8f661d716156f0",
"name": "",
"comments": "Import a list.
", "methodName": "Post_ListId", "namespace": [ "Lists", "Import" ], "urlTemplate": "Lists/Import/{listId}", "method": "POST", "urlParameters": [ { "name": "listId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "6fe23d3c4c98d1b78e949f76f2da46fe",
"name": "Parameters",
"logicalName": "Request",
"namespace": "Post_ListId",
"fullNamespace": [
"Post_ListId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "DataId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FieldMappings",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "FieldMappings",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "FieldMapping",
"type": {
"id": "b544934fc00f56dbfc715c402c9a6e5b",
"name": "FieldMapping",
"logicalName": "FieldMappings",
"namespace": "FieldMappings",
"fullNamespace": [
"Post_ListId",
"FieldMappings"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "DestinationFieldName",
"comments": "Name of the destination list field. These can be enumerated here.",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SourceFieldPosition",
"comments": "1-based index of the source column. If a source column name is not specified an index must be.",
"optional": true,
"sampleValue": "1",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SourceFieldName",
"comments": "Name of the source column if the file has a header. If a source column name is not specified a column index must be.",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "ImportOptions",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "3a0e474f10fb9866df4c2102209b00c4",
"name": "ImportOptions",
"logicalName": "ImportOptions",
"namespace": "ImportOptions",
"fullNamespace": [
"Post_ListId",
"ImportOptions"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Format",
"optional": false,
"sampleValue": "CharacterSeperated",
"deprecated": false,
"type": {
"id": "519b053d0f0b0b5910d697b831a2248a",
"name": "ImportFormat",
"namespace": "ImportOptionsFormat",
"fullNamespace": [
"Post_ListId",
"ImportOptions",
"ImportOptionsFormat"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "CharacterSeperated",
"enumeration": {
"name": "ImportFormat",
"options": [
{
"name": "CharacterSeperated",
"value": "CharacterSeperated"
},
{
"name": "Excel",
"value": "Excel"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "HeaderRow",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SkipRecordsWithErrors",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AllowStringTruncation",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AbortImportOnError",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CharacterSeperatedOptions",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "1277208f7ca3c3304153c326458fd1c0",
"name": "CharacterSeperatedOptions",
"logicalName": "CharacterSeperatedOptions",
"namespace": "CharacterSeperatedOptions",
"fullNamespace": [
"Post_ListId",
"ImportOptions",
"CharacterSeperatedOptions"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Delimiter",
"optional": false,
"sampleValue": "Comma",
"deprecated": false,
"type": {
"id": "ea59ebed29a1aa1de12917cba5641401",
"name": "Delimiter",
"namespace": "CharacterSeperatedOptionsDelimiter",
"fullNamespace": [
"Post_ListId",
"ImportOptions",
"CharacterSeperatedOptions",
"CharacterSeperatedOptionsDelimiter"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Comma",
"enumeration": {
"name": "Delimiter",
"options": [
{
"name": "Comma",
"value": "Comma"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "ExcelOptions",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "0f12fa8158824b7e328d2118487ddbc5",
"name": "ExcelOptions",
"logicalName": "ExcelOptions",
"namespace": "ExcelOptions",
"fullNamespace": [
"Post_ListId",
"ImportOptions",
"ExcelOptions"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "WorksheetName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "3c3e2f55a886538f4224b0d2de093c93",
"name": "Import",
"logicalName": "Response",
"namespace": "Post_ListId",
"fullNamespace": [
"Post_ListId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Lists/Import/Status",
"comments": "List import status.
", "endpoints": [ { "id": "8ced341866d4b1406bcec9ef5107497e", "name": "", "comments": "Check the status of a list import.
", "methodName": "Get_AccountId_ImportId", "namespace": [ "Lists", "Import", "Status" ], "urlTemplate": "Lists/Import/Status/{accountId}/{importId}", "method": "GET", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "importId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "accept", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "0851abf0fea5da3614bbc4f480fdc3ec",
"name": "ImportStatus",
"logicalName": "Response",
"namespace": "Get_AccountId_ImportId",
"fullNamespace": [
"Get_AccountId_ImportId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Duration",
"comments": "Note: Time spans are formatted as d.hh:mm:ss.n.",
"optional": false,
"sampleValue": "0:00:00",
"deprecated": false,
"type": {
"name": "duration",
"isNullable": false,
"isSimple": true,
"sampleValue": "0:00:00",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Complete",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Status",
"optional": false,
"sampleValue": "Queued",
"deprecated": false,
"type": {
"id": "15b9020217adbf8aa868d34048e05632",
"name": "ListImportStatus",
"namespace": "ResponseStatus",
"fullNamespace": [
"Get_AccountId_ImportId",
"ResponseStatus"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Complete",
"enumeration": {
"name": "ListImportStatus",
"options": [
{
"name": "Complete",
"value": "Complete"
},
{
"name": "Failed",
"value": "Failed"
},
{
"name": "PostProcessing",
"value": "PostProcessing"
},
{
"name": "PostProcessingQueued",
"value": "PostProcessingQueued"
},
{
"name": "Processing",
"value": "Processing"
},
{
"name": "Queued",
"value": "Queued"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "RecordsProcessed",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "9ea890976ac3bdbe95651ff8224b4d72",
"name": "",
"comments": "Check the status of a list import.
", "methodName": "Get_ImportId", "namespace": [ "Lists", "Import", "Status" ], "urlTemplate": "Lists/Import/Status/{importId}", "method": "GET", "urlParameters": [ { "name": "importId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "accept", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "0851abf0fea5da3614bbc4f480fdc3ec",
"name": "ImportStatus",
"logicalName": "Response",
"namespace": "Get_ImportId",
"fullNamespace": [
"Get_ImportId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Duration",
"comments": "Note: Time spans are formatted as d.hh:mm:ss.n.",
"optional": false,
"sampleValue": "0:00:00",
"deprecated": false,
"type": {
"name": "duration",
"isNullable": false,
"isSimple": true,
"sampleValue": "0:00:00",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Complete",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Status",
"optional": false,
"sampleValue": "Queued",
"deprecated": false,
"type": {
"id": "15b9020217adbf8aa868d34048e05632",
"name": "ListImportStatus",
"namespace": "ResponseStatus",
"fullNamespace": [
"Get_ImportId",
"ResponseStatus"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Complete",
"enumeration": {
"name": "ListImportStatus",
"options": [
{
"name": "Complete",
"value": "Complete"
},
{
"name": "Failed",
"value": "Failed"
},
{
"name": "PostProcessing",
"value": "PostProcessing"
},
{
"name": "PostProcessingQueued",
"value": "PostProcessingQueued"
},
{
"name": "Processing",
"value": "Processing"
},
{
"name": "Queued",
"value": "Queued"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "RecordsProcessed",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Lists/MyAccount",
"comments": "Here's a step-by-step guide to creating a contact list for sending emails. The process for creating a suppression list is nearly identical, with the exception of setting the list Type to Suppression.
To create a list, use thePOST method on the Lists endpoint and send the following request:
{\n \"Name\": \"My First List\",\n \"Type\": \"Recipient\"\n}
This will return a unique Id that you will use to reference the list in future actions.\nIf you don't specify any fields, the list will be created with the default field, which is just the Email address. The nxt step is to add recipients to this newly created list.
To add recipients to your list, use the POST method on the Lists/Recipients with the following request:
{\n \"Email\": \"myemail@domain.com\"\n}
Using the endpoint /Lists/Recipients/MyAccount/_List_Id_Above_ to add recipients to your list\nOne the lists contains one or more recipients, it can be use in a Campaign
Importing a list of contacts requires use of a few different resources.
\nBegin by creating a list as described above or use the GET method on the Lists endpoint to\nenumerate and locate an existing list. If you have many lists you can make a POST request to the\nLists/Filtered endpoint to refine your search. Keep track of the Id value of the\nlist. You will use that later.
After you have the destination list id, make a POST request to the Data endpoint to load your\ncontact list. The contact list should be uploaded as binary data. Refer to the code examples in the POST section\nof Data for more details. Keep track of the Id value returned by the Data\nendpoint.
Make a Post request to the Lists/Import endpoint, setting the saved data id and list id\nas needed. The request should also map the source file field position to the destination field name. For example, if\nyour contact file has an email column followed by a first name column, the field mappings would look like this:
[\n {\n \"destinationFieldName\": \"email\",\n \"sourceFieldPosition\": 1\n },\n {\n \"destinationFieldName\": \"first_name\",\n \"sourceFieldPosition\": 2\n }\n]For a list of field names make a GET request to Lists/Fields. Any field mappings included\nin the import request that are not present in the destination list will be skipped. Again, keep track of the Id\nreturned by the request.
Imports may take some time to complete if a contact file is large. Imports should be periodically polled to check their\nstatus using a GET request to Lists/Import/Status. Once the Status value in the response\nindicates Complete the import is done and the list can be used in Campaigns.
Use the Lists/Fields endpoint to get a list of the available fields.
\nThis will include the field name and information about the data type.
Use the Lists PUT endpoints to add one or more fields to a list. The field names are specified as a comma separated list.\nFor example, to add fields for the City and State to an existing list, use the following request:
\n{\n \"fields\": [\n \"City\", \"State\"\n ]\n}
The field names are case-insensitive, names that are not valid will be ignored. \nFields are only added to the list if they do not already exist.
\nExisting fields will not be removed.
application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "Lists",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "List",
"type": {
"id": "80ed0649be37d1d81b0d4a93ebe6d51b",
"name": "List",
"logicalName": "Response",
"namespace": "Get_MyAccount",
"fullNamespace": [
"Get_MyAccount"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "CreateDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "GroupId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ContentType",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalActiveRecipients",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalInactiveRecipients",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalRecipients",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Type",
"optional": false,
"sampleValue": "GlobalOptOut",
"deprecated": false,
"type": {
"id": "13f93e8e200ffb582c435387e75cdc71",
"name": "ListType",
"namespace": "ResponseType",
"fullNamespace": [
"Get_MyAccount",
"ResponseType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "GlobalOptOut",
"enumeration": {
"name": "ListType",
"options": [
{
"name": "GlobalOptOut",
"value": "GlobalOptOut"
},
{
"name": "Md5Suppression",
"value": "Md5Suppression"
},
{
"name": "Recipient",
"value": "Recipient"
},
{
"name": "Suppression",
"value": "Suppression"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Fields",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Fields",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Field",
"type": {
"id": "32e4ae9023bff32a2d72ada67ba78f2e",
"name": "Field",
"logicalName": "Fields",
"namespace": "Fields",
"fullNamespace": [
"Get_MyAccount",
"Fields"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Description",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Length",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Type",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Personalization",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Lists/OptOut",
"comments": "List opt outs.
", "endpoints": [ { "id": "f692ffa988445f550fe737fce2be1b53", "name": "", "comments": "Opt out of a list.
", "methodName": "Post_AccountId_ListId", "namespace": [ "Lists", "OptOut" ], "urlTemplate": "Lists/OptOut/{accountId}/{listId}", "method": "POST", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "listId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "bb71ad1cf8aa581b804747f3b3425000",
"name": "Recipient",
"logicalName": "Request",
"namespace": "Post_AccountId_ListId",
"fullNamespace": [
"Post_AccountId_ListId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Email",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [],
"isBinary": false,
"hasBody": false
}
},
{
"id": "c6eb6a2cb3a0c2125ef9504a72882e1e",
"name": "",
"comments": "Opt out of a list.
", "methodName": "Post_ListId", "namespace": [ "Lists", "OptOut" ], "urlTemplate": "Lists/OptOut/{listId}", "method": "POST", "urlParameters": [ { "name": "listId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "bb71ad1cf8aa581b804747f3b3425000",
"name": "Recipient",
"logicalName": "Request",
"namespace": "Post_ListId",
"fullNamespace": [
"Post_ListId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Email",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [],
"isBinary": false,
"hasBody": false
}
}
]
},
{
"name": "/Lists/Recipients",
"comments": "List recipients.
", "endpoints": [ { "id": "ea8dd636577fdb9454d77649ee3befd6", "name": "", "comments": "Create a recipient.
\nIf a recipient with the same Email address exists, the recipient will be updated.
", "methodName": "Post_AccountId_ListId", "namespace": [ "Lists", "Recipients" ], "urlTemplate": "Lists/Recipients/{accountId}/{listId}", "method": "POST", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "listId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "3a929703bc6b9c8b9189f5108ed1dd96",
"name": "RecipientProperties",
"logicalName": "Request",
"namespace": "Post_AccountId_ListId",
"fullNamespace": [
"Post_AccountId_ListId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Email",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EmailFormatPreference",
"optional": true,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "06c003bd45139aa6b36313c1f144f8f7",
"name": "string",
"namespace": "RequestEmailFormatPreference",
"fullNamespace": [
"Post_AccountId_ListId",
"RequestEmailFormatPreference"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "EmailFormatPreference",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "None",
"value": "None"
},
{
"name": "Text",
"value": "Text"
},
{
"name": "TextAndHtml",
"value": "TextAndHtml"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOut",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Properties",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Properties",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Property",
"type": {
"id": "817d4fa0f2f256418bfd02b5bfcf0bdf",
"name": "Property",
"logicalName": "Properties",
"namespace": "Properties",
"fullNamespace": [
"Post_AccountId_ListId",
"Properties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Value",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [],
"isBinary": false,
"hasBody": false
}
},
{
"id": "0077296f416068ca98929c91eb1173af",
"name": "",
"comments": "Modify a recipient.
", "methodName": "Put_AccountId_ListId_Email", "namespace": [ "Lists", "Recipients" ], "urlTemplate": "Lists/Recipients/{accountId}/{listId}/{*email}", "method": "PUT", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "listId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "email", "type": { "name": "string", "isNullable": false, "isSimple": true, "sampleValue": "", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "33ef41d39d9e9e7e8d5f24d2eac41921",
"name": "RecipientProperties",
"logicalName": "Request",
"namespace": "Put_AccountId_ListId_Email",
"fullNamespace": [
"Put_AccountId_ListId_Email"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Email",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EmailFormatPreference",
"optional": true,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "06c003bd45139aa6b36313c1f144f8f7",
"name": "string",
"namespace": "RequestEmailFormatPreference",
"fullNamespace": [
"Put_AccountId_ListId_Email",
"RequestEmailFormatPreference"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "EmailFormatPreference",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "None",
"value": "None"
},
{
"name": "Text",
"value": "Text"
},
{
"name": "TextAndHtml",
"value": "TextAndHtml"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOut",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Properties",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Properties",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Property",
"type": {
"id": "817d4fa0f2f256418bfd02b5bfcf0bdf",
"name": "Property",
"logicalName": "Properties",
"namespace": "Properties",
"fullNamespace": [
"Put_AccountId_ListId_Email",
"Properties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Value",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [],
"isBinary": false,
"hasBody": false
}
},
{
"id": "5b3a8d575af570c8efadec63a68884eb",
"name": "",
"comments": "Delete a recipient.
", "methodName": "Delete_AccountId_ListId_Email", "namespace": [ "Lists", "Recipients" ], "urlTemplate": "Lists/Recipients/{accountId}/{listId}/{*email}", "method": "DELETE", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "listId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "email", "type": { "name": "string", "isNullable": false, "isSimple": true, "sampleValue": "", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [], "isBinary": false, "hasBody": false }, "response": { "headers": [], "isBinary": false, "hasBody": false } }, { "id": "cc2e847d3b49bca16bb618c4a01c8781", "name": "", "comments": "Get a recipient.
", "methodName": "Get_AccountId_ListId_Email", "namespace": [ "Lists", "Recipients" ], "urlTemplate": "Lists/Recipients/{accountId}/{listId}/{email}", "method": "GET", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "listId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "email", "type": { "name": "string", "isNullable": false, "isSimple": true, "sampleValue": "", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "accept", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "612d296f79bef6128d793c53eca95a88",
"name": "Recipient",
"logicalName": "Response",
"namespace": "Get_AccountId_ListId_Email",
"fullNamespace": [
"Get_AccountId_ListId_Email"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "BounceDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BounceStatus",
"optional": false,
"sampleValue": "Hard",
"deprecated": false,
"type": {
"id": "7efe3e1cf4aea11626d780867d862524",
"name": "BounceSeverity",
"namespace": "ResponseBounceStatus",
"fullNamespace": [
"Get_AccountId_ListId_Email",
"ResponseBounceStatus"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Hard",
"enumeration": {
"name": "BounceSeverity",
"options": [
{
"name": "Hard",
"value": "Hard"
},
{
"name": "None",
"value": "None"
},
{
"name": "Soft",
"value": "Soft"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CreateDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Email",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EmailFormatPreference",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "2d0855170510caa5ee9b0e2a55c3e337",
"name": "EmailFormatPreference",
"namespace": "ResponseEmailFormatPreference",
"fullNamespace": [
"Get_AccountId_ListId_Email",
"ResponseEmailFormatPreference"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "EmailFormatPreference",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "None",
"value": "None"
},
{
"name": "Text",
"value": "Text"
},
{
"name": "TextAndHtml",
"value": "TextAndHtml"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOut",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOutDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Properties",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Properties",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Property",
"type": {
"id": "817d4fa0f2f256418bfd02b5bfcf0bdf",
"name": "Property",
"logicalName": "Properties",
"namespace": "Properties",
"fullNamespace": [
"Get_AccountId_ListId_Email",
"Properties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Value",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "01ecc4d9049fd4f11a4914ed9ba336b4",
"name": "",
"comments": "Create a recipient.
\nIf a recipient with the same Email address exists, the recipient will be updated.
", "methodName": "Post_ListId", "namespace": [ "Lists", "Recipients" ], "urlTemplate": "Lists/Recipients/{listId}", "method": "POST", "urlParameters": [ { "name": "listId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "3a929703bc6b9c8b9189f5108ed1dd96",
"name": "RecipientProperties",
"logicalName": "Request",
"namespace": "Post_ListId",
"fullNamespace": [
"Post_ListId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Email",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EmailFormatPreference",
"optional": true,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "06c003bd45139aa6b36313c1f144f8f7",
"name": "string",
"namespace": "RequestEmailFormatPreference",
"fullNamespace": [
"Post_ListId",
"RequestEmailFormatPreference"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "EmailFormatPreference",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "None",
"value": "None"
},
{
"name": "Text",
"value": "Text"
},
{
"name": "TextAndHtml",
"value": "TextAndHtml"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOut",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Properties",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Properties",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Property",
"type": {
"id": "817d4fa0f2f256418bfd02b5bfcf0bdf",
"name": "Property",
"logicalName": "Properties",
"namespace": "Properties",
"fullNamespace": [
"Post_ListId",
"Properties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Value",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [],
"isBinary": false,
"hasBody": false
}
},
{
"id": "5d945647c56e78973316d0448a824313",
"name": "",
"comments": "Modify a recipient.
", "methodName": "Put_ListId_Email", "namespace": [ "Lists", "Recipients" ], "urlTemplate": "Lists/Recipients/{listId}/{*email}", "method": "PUT", "urlParameters": [ { "name": "listId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "email", "type": { "name": "string", "isNullable": false, "isSimple": true, "sampleValue": "", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "33ef41d39d9e9e7e8d5f24d2eac41921",
"name": "RecipientProperties",
"logicalName": "Request",
"namespace": "Put_ListId_Email",
"fullNamespace": [
"Put_ListId_Email"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Email",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EmailFormatPreference",
"optional": true,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "06c003bd45139aa6b36313c1f144f8f7",
"name": "string",
"namespace": "RequestEmailFormatPreference",
"fullNamespace": [
"Put_ListId_Email",
"RequestEmailFormatPreference"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "EmailFormatPreference",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "None",
"value": "None"
},
{
"name": "Text",
"value": "Text"
},
{
"name": "TextAndHtml",
"value": "TextAndHtml"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOut",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Properties",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Properties",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Property",
"type": {
"id": "817d4fa0f2f256418bfd02b5bfcf0bdf",
"name": "Property",
"logicalName": "Properties",
"namespace": "Properties",
"fullNamespace": [
"Put_ListId_Email",
"Properties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Value",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [],
"isBinary": false,
"hasBody": false
}
},
{
"id": "1acdae0f6953de2bcc49d8010076f4c3",
"name": "",
"comments": "Delete a recipient.
", "methodName": "Delete_ListId_Email", "namespace": [ "Lists", "Recipients" ], "urlTemplate": "Lists/Recipients/{listId}/{*email}", "method": "DELETE", "urlParameters": [ { "name": "listId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "email", "type": { "name": "string", "isNullable": false, "isSimple": true, "sampleValue": "", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [], "isBinary": false, "hasBody": false }, "response": { "headers": [], "isBinary": false, "hasBody": false } }, { "id": "bb0fa2a44f1bef897b1fa15d46432c55", "name": "", "comments": "Get a recipient.
", "methodName": "Get_ListId_Email", "namespace": [ "Lists", "Recipients" ], "urlTemplate": "Lists/Recipients/{listId}/{email}", "method": "GET", "urlParameters": [ { "name": "listId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "email", "type": { "name": "string", "isNullable": false, "isSimple": true, "sampleValue": "", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "accept", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "612d296f79bef6128d793c53eca95a88",
"name": "Recipient",
"logicalName": "Response",
"namespace": "Get_ListId_Email",
"fullNamespace": [
"Get_ListId_Email"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "BounceDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BounceStatus",
"optional": false,
"sampleValue": "Hard",
"deprecated": false,
"type": {
"id": "7efe3e1cf4aea11626d780867d862524",
"name": "BounceSeverity",
"namespace": "ResponseBounceStatus",
"fullNamespace": [
"Get_ListId_Email",
"ResponseBounceStatus"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Hard",
"enumeration": {
"name": "BounceSeverity",
"options": [
{
"name": "Hard",
"value": "Hard"
},
{
"name": "None",
"value": "None"
},
{
"name": "Soft",
"value": "Soft"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CreateDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Email",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EmailFormatPreference",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "2d0855170510caa5ee9b0e2a55c3e337",
"name": "EmailFormatPreference",
"namespace": "ResponseEmailFormatPreference",
"fullNamespace": [
"Get_ListId_Email",
"ResponseEmailFormatPreference"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "EmailFormatPreference",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "None",
"value": "None"
},
{
"name": "Text",
"value": "Text"
},
{
"name": "TextAndHtml",
"value": "TextAndHtml"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOut",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOutDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Properties",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Properties",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Property",
"type": {
"id": "817d4fa0f2f256418bfd02b5bfcf0bdf",
"name": "Property",
"logicalName": "Properties",
"namespace": "Properties",
"fullNamespace": [
"Get_ListId_Email",
"Properties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Value",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Lists/Recipients/Filtered",
"comments": "List recipient query.
", "endpoints": [ { "id": "412e8351d66202e68d8d6e6108bbcddf", "name": "", "comments": "Query recipients.
", "methodName": "Post_AccountId_ListId", "namespace": [ "Lists", "Recipients", "Filtered" ], "urlTemplate": "Lists/Recipients/Filtered/{accountId}/{listId}", "method": "POST", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "listId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "29cce5f7b33d597960f49cff2d18ee48",
"name": "RecipientFilter",
"logicalName": "Request",
"namespace": "Post_AccountId_ListId",
"fullNamespace": [
"Post_AccountId_ListId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "StartIndex",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MaxResults",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Email",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BounceFilter",
"optional": true,
"sampleValue": "All",
"deprecated": false,
"type": {
"id": "a8af0c43f351c5c85bcb8dd433fdb0b5",
"name": "string",
"namespace": "RequestBounceFilter",
"fullNamespace": [
"Post_AccountId_ListId",
"RequestBounceFilter"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "All",
"enumeration": {
"name": "BounceFilter",
"options": [
{
"name": "All",
"value": "All"
},
{
"name": "Hard",
"value": "Hard"
},
{
"name": "HardAndSoft",
"value": "HardAndSoft"
},
{
"name": "Non",
"value": "Non"
},
{
"name": "NonAndSoft",
"value": "NonAndSoft"
},
{
"name": "Soft",
"value": "Soft"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BounceDateNewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BouncesDateOlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EmailFormatPreferenceFilter",
"optional": true,
"sampleValue": "All",
"deprecated": false,
"type": {
"id": "fac5777e17de156c24bf2b015b872184",
"name": "string",
"namespace": "RequestEmailFormatPreferenceFilter",
"fullNamespace": [
"Post_AccountId_ListId",
"RequestEmailFormatPreferenceFilter"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "All",
"enumeration": {
"name": "EmailFormatPreferenceFilter",
"options": [
{
"name": "All",
"value": "All"
},
{
"name": "Html",
"value": "Html"
},
{
"name": "NoPreference",
"value": "NoPreference"
},
{
"name": "Text",
"value": "Text"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Expression",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "f58571a0da19b3aa2a3f43d4881b3805",
"name": "Expression",
"logicalName": "Expression",
"namespace": "Expression",
"fullNamespace": [
"Post_AccountId_ListId",
"Expression"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Conditions",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Conditions",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Condition",
"type": {
"id": "8c7496f61d28f248880e293e7e7f1e1d",
"name": "Condition",
"logicalName": "Conditions",
"namespace": "Conditions",
"fullNamespace": [
"Post_AccountId_ListId",
"Expression",
"Conditions"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Comparison",
"optional": false,
"sampleValue": "Contains",
"deprecated": false,
"type": {
"id": "0b5cdf6a8afe2dcd6ccf4d357535948b",
"name": "Comparison",
"namespace": "ConditionsComparison",
"fullNamespace": [
"Post_AccountId_ListId",
"Expression",
"Conditions",
"ConditionsComparison"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Contains",
"enumeration": {
"name": "Comparison",
"options": [
{
"name": "Contains",
"value": "Contains"
},
{
"name": "EndsWith",
"value": "EndsWith"
},
{
"name": "Equals",
"value": "Equals"
},
{
"name": "GreaterThan",
"value": "GreaterThan"
},
{
"name": "GreaterThanOrEqualTo",
"value": "GreaterThanOrEqualTo"
},
{
"name": "IsNull",
"value": "IsNull"
},
{
"name": "LessThan",
"value": "LessThan"
},
{
"name": "LessThanOrEqualTo",
"value": "LessThanOrEqualTo"
},
{
"name": "NotEqual",
"value": "NotEqual"
},
{
"name": "StartsWith",
"value": "StartsWith"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Property",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Value",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Operator",
"optional": false,
"sampleValue": "And",
"deprecated": false,
"type": {
"id": "5634e1e459f44cc9202e903d422032be",
"name": "Operator",
"namespace": "ExpressionOperator",
"fullNamespace": [
"Post_AccountId_ListId",
"Expression",
"ExpressionOperator"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "And",
"enumeration": {
"name": "Operator",
"options": [
{
"name": "And",
"value": "And"
},
{
"name": "Or",
"value": "Or"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "NewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOutDateNewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOutDateOlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOutFilter",
"optional": true,
"sampleValue": "All",
"deprecated": false,
"type": {
"id": "ebaf233e7d5d5e1390a79bd2ef8a0486",
"name": "string",
"namespace": "RequestOptOutFilter",
"fullNamespace": [
"Post_AccountId_ListId",
"RequestOptOutFilter"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "All",
"enumeration": {
"name": "OptOutFilter",
"options": [
{
"name": "All",
"value": "All"
},
{
"name": "Non",
"value": "Non"
},
{
"name": "OptOuts",
"value": "OptOuts"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "Recipients",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Recipient",
"type": {
"id": "612d296f79bef6128d793c53eca95a88",
"name": "Recipient",
"logicalName": "Response",
"namespace": "Post_AccountId_ListId",
"fullNamespace": [
"Post_AccountId_ListId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "BounceDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BounceStatus",
"optional": false,
"sampleValue": "Hard",
"deprecated": false,
"type": {
"id": "7efe3e1cf4aea11626d780867d862524",
"name": "BounceSeverity",
"namespace": "ResponseBounceStatus",
"fullNamespace": [
"Post_AccountId_ListId",
"ResponseBounceStatus"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Hard",
"enumeration": {
"name": "BounceSeverity",
"options": [
{
"name": "Hard",
"value": "Hard"
},
{
"name": "None",
"value": "None"
},
{
"name": "Soft",
"value": "Soft"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CreateDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Email",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EmailFormatPreference",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "2d0855170510caa5ee9b0e2a55c3e337",
"name": "EmailFormatPreference",
"namespace": "ResponseEmailFormatPreference",
"fullNamespace": [
"Post_AccountId_ListId",
"ResponseEmailFormatPreference"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "EmailFormatPreference",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "None",
"value": "None"
},
{
"name": "Text",
"value": "Text"
},
{
"name": "TextAndHtml",
"value": "TextAndHtml"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOut",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOutDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Properties",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Properties",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Property",
"type": {
"id": "817d4fa0f2f256418bfd02b5bfcf0bdf",
"name": "Property",
"logicalName": "Properties",
"namespace": "Properties",
"fullNamespace": [
"Post_AccountId_ListId",
"Properties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Value",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "f2d5612e17cbc19c45302086fa2e9aec",
"name": "",
"comments": "Query recipients.
", "methodName": "Post_ListId", "namespace": [ "Lists", "Recipients", "Filtered" ], "urlTemplate": "Lists/Recipients/Filtered/{listId}", "method": "POST", "urlParameters": [ { "name": "listId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "29cce5f7b33d597960f49cff2d18ee48",
"name": "RecipientFilter",
"logicalName": "Request",
"namespace": "Post_ListId",
"fullNamespace": [
"Post_ListId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "StartIndex",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MaxResults",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Email",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BounceFilter",
"optional": true,
"sampleValue": "All",
"deprecated": false,
"type": {
"id": "a8af0c43f351c5c85bcb8dd433fdb0b5",
"name": "string",
"namespace": "RequestBounceFilter",
"fullNamespace": [
"Post_ListId",
"RequestBounceFilter"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "All",
"enumeration": {
"name": "BounceFilter",
"options": [
{
"name": "All",
"value": "All"
},
{
"name": "Hard",
"value": "Hard"
},
{
"name": "HardAndSoft",
"value": "HardAndSoft"
},
{
"name": "Non",
"value": "Non"
},
{
"name": "NonAndSoft",
"value": "NonAndSoft"
},
{
"name": "Soft",
"value": "Soft"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BounceDateNewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BouncesDateOlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EmailFormatPreferenceFilter",
"optional": true,
"sampleValue": "All",
"deprecated": false,
"type": {
"id": "fac5777e17de156c24bf2b015b872184",
"name": "string",
"namespace": "RequestEmailFormatPreferenceFilter",
"fullNamespace": [
"Post_ListId",
"RequestEmailFormatPreferenceFilter"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "All",
"enumeration": {
"name": "EmailFormatPreferenceFilter",
"options": [
{
"name": "All",
"value": "All"
},
{
"name": "Html",
"value": "Html"
},
{
"name": "NoPreference",
"value": "NoPreference"
},
{
"name": "Text",
"value": "Text"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Expression",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "f58571a0da19b3aa2a3f43d4881b3805",
"name": "Expression",
"logicalName": "Expression",
"namespace": "Expression",
"fullNamespace": [
"Post_ListId",
"Expression"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Conditions",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Conditions",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Condition",
"type": {
"id": "8c7496f61d28f248880e293e7e7f1e1d",
"name": "Condition",
"logicalName": "Conditions",
"namespace": "Conditions",
"fullNamespace": [
"Post_ListId",
"Expression",
"Conditions"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Comparison",
"optional": false,
"sampleValue": "Contains",
"deprecated": false,
"type": {
"id": "0b5cdf6a8afe2dcd6ccf4d357535948b",
"name": "Comparison",
"namespace": "ConditionsComparison",
"fullNamespace": [
"Post_ListId",
"Expression",
"Conditions",
"ConditionsComparison"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Contains",
"enumeration": {
"name": "Comparison",
"options": [
{
"name": "Contains",
"value": "Contains"
},
{
"name": "EndsWith",
"value": "EndsWith"
},
{
"name": "Equals",
"value": "Equals"
},
{
"name": "GreaterThan",
"value": "GreaterThan"
},
{
"name": "GreaterThanOrEqualTo",
"value": "GreaterThanOrEqualTo"
},
{
"name": "IsNull",
"value": "IsNull"
},
{
"name": "LessThan",
"value": "LessThan"
},
{
"name": "LessThanOrEqualTo",
"value": "LessThanOrEqualTo"
},
{
"name": "NotEqual",
"value": "NotEqual"
},
{
"name": "StartsWith",
"value": "StartsWith"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Property",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Value",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Operator",
"optional": false,
"sampleValue": "And",
"deprecated": false,
"type": {
"id": "5634e1e459f44cc9202e903d422032be",
"name": "Operator",
"namespace": "ExpressionOperator",
"fullNamespace": [
"Post_ListId",
"Expression",
"ExpressionOperator"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "And",
"enumeration": {
"name": "Operator",
"options": [
{
"name": "And",
"value": "And"
},
{
"name": "Or",
"value": "Or"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "NewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOutDateNewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOutDateOlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOutFilter",
"optional": true,
"sampleValue": "All",
"deprecated": false,
"type": {
"id": "ebaf233e7d5d5e1390a79bd2ef8a0486",
"name": "string",
"namespace": "RequestOptOutFilter",
"fullNamespace": [
"Post_ListId",
"RequestOptOutFilter"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "All",
"enumeration": {
"name": "OptOutFilter",
"options": [
{
"name": "All",
"value": "All"
},
{
"name": "Non",
"value": "Non"
},
{
"name": "OptOuts",
"value": "OptOuts"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "Recipients",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Recipient",
"type": {
"id": "612d296f79bef6128d793c53eca95a88",
"name": "Recipient",
"logicalName": "Response",
"namespace": "Post_ListId",
"fullNamespace": [
"Post_ListId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "BounceDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BounceStatus",
"optional": false,
"sampleValue": "Hard",
"deprecated": false,
"type": {
"id": "7efe3e1cf4aea11626d780867d862524",
"name": "BounceSeverity",
"namespace": "ResponseBounceStatus",
"fullNamespace": [
"Post_ListId",
"ResponseBounceStatus"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Hard",
"enumeration": {
"name": "BounceSeverity",
"options": [
{
"name": "Hard",
"value": "Hard"
},
{
"name": "None",
"value": "None"
},
{
"name": "Soft",
"value": "Soft"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CreateDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Email",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EmailFormatPreference",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "2d0855170510caa5ee9b0e2a55c3e337",
"name": "EmailFormatPreference",
"namespace": "ResponseEmailFormatPreference",
"fullNamespace": [
"Post_ListId",
"ResponseEmailFormatPreference"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "EmailFormatPreference",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "None",
"value": "None"
},
{
"name": "Text",
"value": "Text"
},
{
"name": "TextAndHtml",
"value": "TextAndHtml"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOut",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOutDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Properties",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Properties",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Property",
"type": {
"id": "817d4fa0f2f256418bfd02b5bfcf0bdf",
"name": "Property",
"logicalName": "Properties",
"namespace": "Properties",
"fullNamespace": [
"Post_ListId",
"Properties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Value",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Lists/Recipients/Filtered/Delete",
"comments": "Delete recipients by query.
", "endpoints": [ { "id": "d7de6d4bc69486c611cae5b6e2fd5f2b", "name": "", "comments": "Delete recipients by query.
", "methodName": "Post_AccountId_ListId", "namespace": [ "Lists", "Recipients", "Filtered", "Delete" ], "urlTemplate": "Lists/Recipients/Filtered/Delete/{accountId}/{listId}", "method": "POST", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "listId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "6a6f96a21a6d23799706143797747811",
"name": "RecipientFilter",
"logicalName": "Request",
"namespace": "Post_AccountId_ListId",
"fullNamespace": [
"Post_AccountId_ListId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "MaxResults",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Email",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BounceFilter",
"optional": true,
"sampleValue": "All",
"deprecated": false,
"type": {
"id": "a8af0c43f351c5c85bcb8dd433fdb0b5",
"name": "string",
"namespace": "RequestBounceFilter",
"fullNamespace": [
"Post_AccountId_ListId",
"RequestBounceFilter"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "All",
"enumeration": {
"name": "BounceFilter",
"options": [
{
"name": "All",
"value": "All"
},
{
"name": "Hard",
"value": "Hard"
},
{
"name": "HardAndSoft",
"value": "HardAndSoft"
},
{
"name": "Non",
"value": "Non"
},
{
"name": "NonAndSoft",
"value": "NonAndSoft"
},
{
"name": "Soft",
"value": "Soft"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BounceDateNewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BouncesDateOlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EmailFormatPreferenceFilter",
"optional": true,
"sampleValue": "All",
"deprecated": false,
"type": {
"id": "fac5777e17de156c24bf2b015b872184",
"name": "string",
"namespace": "RequestEmailFormatPreferenceFilter",
"fullNamespace": [
"Post_AccountId_ListId",
"RequestEmailFormatPreferenceFilter"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "All",
"enumeration": {
"name": "EmailFormatPreferenceFilter",
"options": [
{
"name": "All",
"value": "All"
},
{
"name": "Html",
"value": "Html"
},
{
"name": "NoPreference",
"value": "NoPreference"
},
{
"name": "Text",
"value": "Text"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Expression",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "f58571a0da19b3aa2a3f43d4881b3805",
"name": "Expression",
"logicalName": "Expression",
"namespace": "Expression",
"fullNamespace": [
"Post_AccountId_ListId",
"Expression"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Conditions",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Conditions",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Condition",
"type": {
"id": "8c7496f61d28f248880e293e7e7f1e1d",
"name": "Condition",
"logicalName": "Conditions",
"namespace": "Conditions",
"fullNamespace": [
"Post_AccountId_ListId",
"Expression",
"Conditions"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Comparison",
"optional": false,
"sampleValue": "Contains",
"deprecated": false,
"type": {
"id": "0b5cdf6a8afe2dcd6ccf4d357535948b",
"name": "Comparison",
"namespace": "ConditionsComparison",
"fullNamespace": [
"Post_AccountId_ListId",
"Expression",
"Conditions",
"ConditionsComparison"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Contains",
"enumeration": {
"name": "Comparison",
"options": [
{
"name": "Contains",
"value": "Contains"
},
{
"name": "EndsWith",
"value": "EndsWith"
},
{
"name": "Equals",
"value": "Equals"
},
{
"name": "GreaterThan",
"value": "GreaterThan"
},
{
"name": "GreaterThanOrEqualTo",
"value": "GreaterThanOrEqualTo"
},
{
"name": "IsNull",
"value": "IsNull"
},
{
"name": "LessThan",
"value": "LessThan"
},
{
"name": "LessThanOrEqualTo",
"value": "LessThanOrEqualTo"
},
{
"name": "NotEqual",
"value": "NotEqual"
},
{
"name": "StartsWith",
"value": "StartsWith"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Property",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Value",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Operator",
"optional": false,
"sampleValue": "And",
"deprecated": false,
"type": {
"id": "5634e1e459f44cc9202e903d422032be",
"name": "Operator",
"namespace": "ExpressionOperator",
"fullNamespace": [
"Post_AccountId_ListId",
"Expression",
"ExpressionOperator"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "And",
"enumeration": {
"name": "Operator",
"options": [
{
"name": "And",
"value": "And"
},
{
"name": "Or",
"value": "Or"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "NewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOutDateNewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOutDateOlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOutFilter",
"optional": true,
"sampleValue": "All",
"deprecated": false,
"type": {
"id": "ebaf233e7d5d5e1390a79bd2ef8a0486",
"name": "string",
"namespace": "RequestOptOutFilter",
"fullNamespace": [
"Post_AccountId_ListId",
"RequestOptOutFilter"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "All",
"enumeration": {
"name": "OptOutFilter",
"options": [
{
"name": "All",
"value": "All"
},
{
"name": "Non",
"value": "Non"
},
{
"name": "OptOuts",
"value": "OptOuts"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [],
"isBinary": false,
"hasBody": false
}
},
{
"id": "d2fbb8e77bed2f07d6f81816902c0168",
"name": "",
"comments": "Delete recipients by query.
", "methodName": "Post_ListId", "namespace": [ "Lists", "Recipients", "Filtered", "Delete" ], "urlTemplate": "Lists/Recipients/Filtered/Delete/{listId}", "method": "POST", "urlParameters": [ { "name": "listId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "6a6f96a21a6d23799706143797747811",
"name": "RecipientFilter",
"logicalName": "Request",
"namespace": "Post_ListId",
"fullNamespace": [
"Post_ListId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "MaxResults",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Email",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BounceFilter",
"optional": true,
"sampleValue": "All",
"deprecated": false,
"type": {
"id": "a8af0c43f351c5c85bcb8dd433fdb0b5",
"name": "string",
"namespace": "RequestBounceFilter",
"fullNamespace": [
"Post_ListId",
"RequestBounceFilter"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "All",
"enumeration": {
"name": "BounceFilter",
"options": [
{
"name": "All",
"value": "All"
},
{
"name": "Hard",
"value": "Hard"
},
{
"name": "HardAndSoft",
"value": "HardAndSoft"
},
{
"name": "Non",
"value": "Non"
},
{
"name": "NonAndSoft",
"value": "NonAndSoft"
},
{
"name": "Soft",
"value": "Soft"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BounceDateNewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BouncesDateOlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EmailFormatPreferenceFilter",
"optional": true,
"sampleValue": "All",
"deprecated": false,
"type": {
"id": "fac5777e17de156c24bf2b015b872184",
"name": "string",
"namespace": "RequestEmailFormatPreferenceFilter",
"fullNamespace": [
"Post_ListId",
"RequestEmailFormatPreferenceFilter"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "All",
"enumeration": {
"name": "EmailFormatPreferenceFilter",
"options": [
{
"name": "All",
"value": "All"
},
{
"name": "Html",
"value": "Html"
},
{
"name": "NoPreference",
"value": "NoPreference"
},
{
"name": "Text",
"value": "Text"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Expression",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "f58571a0da19b3aa2a3f43d4881b3805",
"name": "Expression",
"logicalName": "Expression",
"namespace": "Expression",
"fullNamespace": [
"Post_ListId",
"Expression"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Conditions",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Conditions",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Condition",
"type": {
"id": "8c7496f61d28f248880e293e7e7f1e1d",
"name": "Condition",
"logicalName": "Conditions",
"namespace": "Conditions",
"fullNamespace": [
"Post_ListId",
"Expression",
"Conditions"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Comparison",
"optional": false,
"sampleValue": "Contains",
"deprecated": false,
"type": {
"id": "0b5cdf6a8afe2dcd6ccf4d357535948b",
"name": "Comparison",
"namespace": "ConditionsComparison",
"fullNamespace": [
"Post_ListId",
"Expression",
"Conditions",
"ConditionsComparison"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Contains",
"enumeration": {
"name": "Comparison",
"options": [
{
"name": "Contains",
"value": "Contains"
},
{
"name": "EndsWith",
"value": "EndsWith"
},
{
"name": "Equals",
"value": "Equals"
},
{
"name": "GreaterThan",
"value": "GreaterThan"
},
{
"name": "GreaterThanOrEqualTo",
"value": "GreaterThanOrEqualTo"
},
{
"name": "IsNull",
"value": "IsNull"
},
{
"name": "LessThan",
"value": "LessThan"
},
{
"name": "LessThanOrEqualTo",
"value": "LessThanOrEqualTo"
},
{
"name": "NotEqual",
"value": "NotEqual"
},
{
"name": "StartsWith",
"value": "StartsWith"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Property",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Value",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Operator",
"optional": false,
"sampleValue": "And",
"deprecated": false,
"type": {
"id": "5634e1e459f44cc9202e903d422032be",
"name": "Operator",
"namespace": "ExpressionOperator",
"fullNamespace": [
"Post_ListId",
"Expression",
"ExpressionOperator"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "And",
"enumeration": {
"name": "Operator",
"options": [
{
"name": "And",
"value": "And"
},
{
"name": "Or",
"value": "Or"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "NewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOutDateNewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOutDateOlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOutFilter",
"optional": true,
"sampleValue": "All",
"deprecated": false,
"type": {
"id": "ebaf233e7d5d5e1390a79bd2ef8a0486",
"name": "string",
"namespace": "RequestOptOutFilter",
"fullNamespace": [
"Post_ListId",
"RequestOptOutFilter"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "All",
"enumeration": {
"name": "OptOutFilter",
"options": [
{
"name": "All",
"value": "All"
},
{
"name": "Non",
"value": "Non"
},
{
"name": "OptOuts",
"value": "OptOuts"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [],
"isBinary": false,
"hasBody": false
}
}
]
},
{
"name": "/Lists/Recipients/Filtered/Modify",
"comments": "Modify recipients by query.
", "endpoints": [ { "id": "f6d84b401c561473a2b1aedb6839d142", "name": "", "comments": "Modify recipients by query.
", "methodName": "Post_AccountId_ListId", "namespace": [ "Lists", "Recipients", "Filtered", "Modify" ], "urlTemplate": "Lists/Recipients/Filtered/Modify/{accountId}/{listId}", "method": "POST", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "listId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "0dbf3bbab81c5968fea9a667d82112b9",
"name": "RecipientParameters",
"logicalName": "Request",
"namespace": "Post_AccountId_ListId",
"fullNamespace": [
"Post_AccountId_ListId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Properties",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "33ef41d39d9e9e7e8d5f24d2eac41921",
"name": "RecipientProperties",
"logicalName": "Properties",
"namespace": "Properties",
"fullNamespace": [
"Post_AccountId_ListId",
"Properties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Email",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EmailFormatPreference",
"optional": true,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "06c003bd45139aa6b36313c1f144f8f7",
"name": "string",
"namespace": "PropertiesEmailFormatPreference",
"fullNamespace": [
"Post_AccountId_ListId",
"Properties",
"PropertiesEmailFormatPreference"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "EmailFormatPreference",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "None",
"value": "None"
},
{
"name": "Text",
"value": "Text"
},
{
"name": "TextAndHtml",
"value": "TextAndHtml"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOut",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Properties",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Properties",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Property",
"type": {
"id": "817d4fa0f2f256418bfd02b5bfcf0bdf",
"name": "Property",
"logicalName": "Properties",
"namespace": "Properties",
"fullNamespace": [
"Post_AccountId_ListId",
"Properties",
"Properties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Value",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "Filter",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "d140c9b909309d9de656bbc1b7f49a11",
"name": "RecipientFilter",
"logicalName": "Filter",
"namespace": "Filter",
"fullNamespace": [
"Post_AccountId_ListId",
"Filter"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "MaxResults",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Email",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BounceFilter",
"optional": true,
"sampleValue": "All",
"deprecated": false,
"type": {
"id": "a8af0c43f351c5c85bcb8dd433fdb0b5",
"name": "string",
"namespace": "FilterBounceFilter",
"fullNamespace": [
"Post_AccountId_ListId",
"Filter",
"FilterBounceFilter"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "All",
"enumeration": {
"name": "BounceFilter",
"options": [
{
"name": "All",
"value": "All"
},
{
"name": "Hard",
"value": "Hard"
},
{
"name": "HardAndSoft",
"value": "HardAndSoft"
},
{
"name": "Non",
"value": "Non"
},
{
"name": "NonAndSoft",
"value": "NonAndSoft"
},
{
"name": "Soft",
"value": "Soft"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BounceDateNewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BouncesDateOlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EmailFormatPreferenceFilter",
"optional": true,
"sampleValue": "All",
"deprecated": false,
"type": {
"id": "fac5777e17de156c24bf2b015b872184",
"name": "string",
"namespace": "FilterEmailFormatPreferenceFilter",
"fullNamespace": [
"Post_AccountId_ListId",
"Filter",
"FilterEmailFormatPreferenceFilter"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "All",
"enumeration": {
"name": "EmailFormatPreferenceFilter",
"options": [
{
"name": "All",
"value": "All"
},
{
"name": "Html",
"value": "Html"
},
{
"name": "NoPreference",
"value": "NoPreference"
},
{
"name": "Text",
"value": "Text"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Expression",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "f58571a0da19b3aa2a3f43d4881b3805",
"name": "Expression",
"logicalName": "Expression",
"namespace": "Expression",
"fullNamespace": [
"Post_AccountId_ListId",
"Filter",
"Expression"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Conditions",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Conditions",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Condition",
"type": {
"id": "8c7496f61d28f248880e293e7e7f1e1d",
"name": "Condition",
"logicalName": "Conditions",
"namespace": "Conditions",
"fullNamespace": [
"Post_AccountId_ListId",
"Filter",
"Expression",
"Conditions"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Comparison",
"optional": false,
"sampleValue": "Contains",
"deprecated": false,
"type": {
"id": "0b5cdf6a8afe2dcd6ccf4d357535948b",
"name": "Comparison",
"namespace": "ConditionsComparison",
"fullNamespace": [
"Post_AccountId_ListId",
"Filter",
"Expression",
"Conditions",
"ConditionsComparison"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Contains",
"enumeration": {
"name": "Comparison",
"options": [
{
"name": "Contains",
"value": "Contains"
},
{
"name": "EndsWith",
"value": "EndsWith"
},
{
"name": "Equals",
"value": "Equals"
},
{
"name": "GreaterThan",
"value": "GreaterThan"
},
{
"name": "GreaterThanOrEqualTo",
"value": "GreaterThanOrEqualTo"
},
{
"name": "IsNull",
"value": "IsNull"
},
{
"name": "LessThan",
"value": "LessThan"
},
{
"name": "LessThanOrEqualTo",
"value": "LessThanOrEqualTo"
},
{
"name": "NotEqual",
"value": "NotEqual"
},
{
"name": "StartsWith",
"value": "StartsWith"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Property",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Value",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Operator",
"optional": false,
"sampleValue": "And",
"deprecated": false,
"type": {
"id": "5634e1e459f44cc9202e903d422032be",
"name": "Operator",
"namespace": "ExpressionOperator",
"fullNamespace": [
"Post_AccountId_ListId",
"Filter",
"Expression",
"ExpressionOperator"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "And",
"enumeration": {
"name": "Operator",
"options": [
{
"name": "And",
"value": "And"
},
{
"name": "Or",
"value": "Or"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "NewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOutDateNewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOutDateOlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOutFilter",
"optional": true,
"sampleValue": "All",
"deprecated": false,
"type": {
"id": "ebaf233e7d5d5e1390a79bd2ef8a0486",
"name": "string",
"namespace": "FilterOptOutFilter",
"fullNamespace": [
"Post_AccountId_ListId",
"Filter",
"FilterOptOutFilter"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "All",
"enumeration": {
"name": "OptOutFilter",
"options": [
{
"name": "All",
"value": "All"
},
{
"name": "Non",
"value": "Non"
},
{
"name": "OptOuts",
"value": "OptOuts"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [],
"isBinary": false,
"hasBody": false
}
},
{
"id": "69ea53bbb454d3f642c6f900b1df686a",
"name": "",
"comments": "Modify recipients by query.
", "methodName": "Post_ListId", "namespace": [ "Lists", "Recipients", "Filtered", "Modify" ], "urlTemplate": "Lists/Recipients/Filtered/Modify/{listId}", "method": "POST", "urlParameters": [ { "name": "listId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "0dbf3bbab81c5968fea9a667d82112b9",
"name": "RecipientParameters",
"logicalName": "Request",
"namespace": "Post_ListId",
"fullNamespace": [
"Post_ListId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Properties",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "33ef41d39d9e9e7e8d5f24d2eac41921",
"name": "RecipientProperties",
"logicalName": "Properties",
"namespace": "Properties",
"fullNamespace": [
"Post_ListId",
"Properties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Email",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EmailFormatPreference",
"optional": true,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "06c003bd45139aa6b36313c1f144f8f7",
"name": "string",
"namespace": "PropertiesEmailFormatPreference",
"fullNamespace": [
"Post_ListId",
"Properties",
"PropertiesEmailFormatPreference"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "EmailFormatPreference",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "None",
"value": "None"
},
{
"name": "Text",
"value": "Text"
},
{
"name": "TextAndHtml",
"value": "TextAndHtml"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOut",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Properties",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Properties",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Property",
"type": {
"id": "817d4fa0f2f256418bfd02b5bfcf0bdf",
"name": "Property",
"logicalName": "Properties",
"namespace": "Properties",
"fullNamespace": [
"Post_ListId",
"Properties",
"Properties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Value",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "Filter",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "d140c9b909309d9de656bbc1b7f49a11",
"name": "RecipientFilter",
"logicalName": "Filter",
"namespace": "Filter",
"fullNamespace": [
"Post_ListId",
"Filter"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "MaxResults",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Email",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BounceFilter",
"optional": true,
"sampleValue": "All",
"deprecated": false,
"type": {
"id": "a8af0c43f351c5c85bcb8dd433fdb0b5",
"name": "string",
"namespace": "FilterBounceFilter",
"fullNamespace": [
"Post_ListId",
"Filter",
"FilterBounceFilter"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "All",
"enumeration": {
"name": "BounceFilter",
"options": [
{
"name": "All",
"value": "All"
},
{
"name": "Hard",
"value": "Hard"
},
{
"name": "HardAndSoft",
"value": "HardAndSoft"
},
{
"name": "Non",
"value": "Non"
},
{
"name": "NonAndSoft",
"value": "NonAndSoft"
},
{
"name": "Soft",
"value": "Soft"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BounceDateNewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BouncesDateOlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EmailFormatPreferenceFilter",
"optional": true,
"sampleValue": "All",
"deprecated": false,
"type": {
"id": "fac5777e17de156c24bf2b015b872184",
"name": "string",
"namespace": "FilterEmailFormatPreferenceFilter",
"fullNamespace": [
"Post_ListId",
"Filter",
"FilterEmailFormatPreferenceFilter"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "All",
"enumeration": {
"name": "EmailFormatPreferenceFilter",
"options": [
{
"name": "All",
"value": "All"
},
{
"name": "Html",
"value": "Html"
},
{
"name": "NoPreference",
"value": "NoPreference"
},
{
"name": "Text",
"value": "Text"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Expression",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "f58571a0da19b3aa2a3f43d4881b3805",
"name": "Expression",
"logicalName": "Expression",
"namespace": "Expression",
"fullNamespace": [
"Post_ListId",
"Filter",
"Expression"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Conditions",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Conditions",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Condition",
"type": {
"id": "8c7496f61d28f248880e293e7e7f1e1d",
"name": "Condition",
"logicalName": "Conditions",
"namespace": "Conditions",
"fullNamespace": [
"Post_ListId",
"Filter",
"Expression",
"Conditions"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Comparison",
"optional": false,
"sampleValue": "Contains",
"deprecated": false,
"type": {
"id": "0b5cdf6a8afe2dcd6ccf4d357535948b",
"name": "Comparison",
"namespace": "ConditionsComparison",
"fullNamespace": [
"Post_ListId",
"Filter",
"Expression",
"Conditions",
"ConditionsComparison"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Contains",
"enumeration": {
"name": "Comparison",
"options": [
{
"name": "Contains",
"value": "Contains"
},
{
"name": "EndsWith",
"value": "EndsWith"
},
{
"name": "Equals",
"value": "Equals"
},
{
"name": "GreaterThan",
"value": "GreaterThan"
},
{
"name": "GreaterThanOrEqualTo",
"value": "GreaterThanOrEqualTo"
},
{
"name": "IsNull",
"value": "IsNull"
},
{
"name": "LessThan",
"value": "LessThan"
},
{
"name": "LessThanOrEqualTo",
"value": "LessThanOrEqualTo"
},
{
"name": "NotEqual",
"value": "NotEqual"
},
{
"name": "StartsWith",
"value": "StartsWith"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Property",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Value",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Operator",
"optional": false,
"sampleValue": "And",
"deprecated": false,
"type": {
"id": "5634e1e459f44cc9202e903d422032be",
"name": "Operator",
"namespace": "ExpressionOperator",
"fullNamespace": [
"Post_ListId",
"Filter",
"Expression",
"ExpressionOperator"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "And",
"enumeration": {
"name": "Operator",
"options": [
{
"name": "And",
"value": "And"
},
{
"name": "Or",
"value": "Or"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "NewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOutDateNewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOutDateOlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOutFilter",
"optional": true,
"sampleValue": "All",
"deprecated": false,
"type": {
"id": "ebaf233e7d5d5e1390a79bd2ef8a0486",
"name": "string",
"namespace": "FilterOptOutFilter",
"fullNamespace": [
"Post_ListId",
"Filter",
"FilterOptOutFilter"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "All",
"enumeration": {
"name": "OptOutFilter",
"options": [
{
"name": "All",
"value": "All"
},
{
"name": "Non",
"value": "Non"
},
{
"name": "OptOuts",
"value": "OptOuts"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [],
"isBinary": false,
"hasBody": false
}
}
]
},
{
"name": "/Lists/Recipients/MyAccount",
"comments": "List recipients.
", "endpoints": [ { "id": "f8117524b427c8913023bf3af85e4713", "name": "", "comments": "Create a recipient.
\nIf a recipient with the same Email address exists, the recipient will be updated.
", "methodName": "Post_MyAccount_ListId", "namespace": [ "Lists", "Recipients", "MyAccount" ], "urlTemplate": "Lists/Recipients/MyAccount/{listId}", "method": "POST", "urlParameters": [ { "name": "listId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "3a929703bc6b9c8b9189f5108ed1dd96",
"name": "RecipientProperties",
"logicalName": "Request",
"namespace": "Post_MyAccount_ListId",
"fullNamespace": [
"Post_MyAccount_ListId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Email",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EmailFormatPreference",
"optional": true,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "06c003bd45139aa6b36313c1f144f8f7",
"name": "string",
"namespace": "RequestEmailFormatPreference",
"fullNamespace": [
"Post_MyAccount_ListId",
"RequestEmailFormatPreference"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "EmailFormatPreference",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "None",
"value": "None"
},
{
"name": "Text",
"value": "Text"
},
{
"name": "TextAndHtml",
"value": "TextAndHtml"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOut",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Properties",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Properties",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Property",
"type": {
"id": "817d4fa0f2f256418bfd02b5bfcf0bdf",
"name": "Property",
"logicalName": "Properties",
"namespace": "Properties",
"fullNamespace": [
"Post_MyAccount_ListId",
"Properties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Value",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [],
"isBinary": false,
"hasBody": false
}
},
{
"id": "f8ccb75a86bd1a687cca80348afb9525",
"name": "",
"comments": "Modify a recipient.
", "methodName": "Put_MyAccount_ListId_Email", "namespace": [ "Lists", "Recipients", "MyAccount" ], "urlTemplate": "Lists/Recipients/MyAccount/{listId}/{*email}", "method": "PUT", "urlParameters": [ { "name": "listId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "email", "type": { "name": "string", "isNullable": false, "isSimple": true, "sampleValue": "", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "33ef41d39d9e9e7e8d5f24d2eac41921",
"name": "RecipientProperties",
"logicalName": "Request",
"namespace": "Put_MyAccount_ListId_Email",
"fullNamespace": [
"Put_MyAccount_ListId_Email"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Email",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EmailFormatPreference",
"optional": true,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "06c003bd45139aa6b36313c1f144f8f7",
"name": "string",
"namespace": "RequestEmailFormatPreference",
"fullNamespace": [
"Put_MyAccount_ListId_Email",
"RequestEmailFormatPreference"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "EmailFormatPreference",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "None",
"value": "None"
},
{
"name": "Text",
"value": "Text"
},
{
"name": "TextAndHtml",
"value": "TextAndHtml"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOut",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Properties",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Properties",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Property",
"type": {
"id": "817d4fa0f2f256418bfd02b5bfcf0bdf",
"name": "Property",
"logicalName": "Properties",
"namespace": "Properties",
"fullNamespace": [
"Put_MyAccount_ListId_Email",
"Properties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Value",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [],
"isBinary": false,
"hasBody": false
}
},
{
"id": "61a3fcf81df076233f9dc8b4a5b4fccf",
"name": "",
"comments": "Get a recipient.
", "methodName": "Get_MyAccount_ListId_Email", "namespace": [ "Lists", "Recipients", "MyAccount" ], "urlTemplate": "Lists/Recipients/MyAccount/{listId}/{email}", "method": "GET", "urlParameters": [ { "name": "listId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "email", "type": { "name": "string", "isNullable": false, "isSimple": true, "sampleValue": "", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "accept", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "612d296f79bef6128d793c53eca95a88",
"name": "Recipient",
"logicalName": "Response",
"namespace": "Get_MyAccount_ListId_Email",
"fullNamespace": [
"Get_MyAccount_ListId_Email"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "BounceDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BounceStatus",
"optional": false,
"sampleValue": "Hard",
"deprecated": false,
"type": {
"id": "7efe3e1cf4aea11626d780867d862524",
"name": "BounceSeverity",
"namespace": "ResponseBounceStatus",
"fullNamespace": [
"Get_MyAccount_ListId_Email",
"ResponseBounceStatus"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Hard",
"enumeration": {
"name": "BounceSeverity",
"options": [
{
"name": "Hard",
"value": "Hard"
},
{
"name": "None",
"value": "None"
},
{
"name": "Soft",
"value": "Soft"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CreateDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Email",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EmailFormatPreference",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "2d0855170510caa5ee9b0e2a55c3e337",
"name": "EmailFormatPreference",
"namespace": "ResponseEmailFormatPreference",
"fullNamespace": [
"Get_MyAccount_ListId_Email",
"ResponseEmailFormatPreference"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "EmailFormatPreference",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "None",
"value": "None"
},
{
"name": "Text",
"value": "Text"
},
{
"name": "TextAndHtml",
"value": "TextAndHtml"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOut",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOutDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Properties",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Properties",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Property",
"type": {
"id": "817d4fa0f2f256418bfd02b5bfcf0bdf",
"name": "Property",
"logicalName": "Properties",
"namespace": "Properties",
"fullNamespace": [
"Get_MyAccount_ListId_Email",
"Properties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Value",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Lists/Recipients/Subscribe",
"comments": "List subscriptions.
", "endpoints": [ { "id": "42955a8d2f4a55fc0ad600cb488f8d4b", "name": "", "comments": "Subscribe a recipient.
", "methodName": "Post_AccountId_ListId", "namespace": [ "Lists", "Recipients", "Subscribe" ], "urlTemplate": "Lists/Recipients/Subscribe/{accountId}/{listId}", "method": "POST", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "listId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "e9a381d4802989e3c816bbc7326aeb68",
"name": "RecipientParameters",
"logicalName": "Request",
"namespace": "Post_AccountId_ListId",
"fullNamespace": [
"Post_AccountId_ListId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Properties",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "33ef41d39d9e9e7e8d5f24d2eac41921",
"name": "RecipientProperties",
"logicalName": "Properties",
"namespace": "Properties",
"fullNamespace": [
"Post_AccountId_ListId",
"Properties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Email",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EmailFormatPreference",
"optional": true,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "06c003bd45139aa6b36313c1f144f8f7",
"name": "string",
"namespace": "PropertiesEmailFormatPreference",
"fullNamespace": [
"Post_AccountId_ListId",
"Properties",
"PropertiesEmailFormatPreference"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "EmailFormatPreference",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "None",
"value": "None"
},
{
"name": "Text",
"value": "Text"
},
{
"name": "TextAndHtml",
"value": "TextAndHtml"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOut",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Properties",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Properties",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Property",
"type": {
"id": "817d4fa0f2f256418bfd02b5bfcf0bdf",
"name": "Property",
"logicalName": "Properties",
"namespace": "Properties",
"fullNamespace": [
"Post_AccountId_ListId",
"Properties",
"Properties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Value",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "Filter",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "c4446e5fefc9591e56118ad142f27263",
"name": "RecipientFilter",
"logicalName": "Filter",
"namespace": "Filter",
"fullNamespace": [
"Post_AccountId_ListId",
"Filter"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Email",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BounceFilter",
"optional": true,
"sampleValue": "All",
"deprecated": false,
"type": {
"id": "a8af0c43f351c5c85bcb8dd433fdb0b5",
"name": "string",
"namespace": "FilterBounceFilter",
"fullNamespace": [
"Post_AccountId_ListId",
"Filter",
"FilterBounceFilter"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "All",
"enumeration": {
"name": "BounceFilter",
"options": [
{
"name": "All",
"value": "All"
},
{
"name": "Hard",
"value": "Hard"
},
{
"name": "HardAndSoft",
"value": "HardAndSoft"
},
{
"name": "Non",
"value": "Non"
},
{
"name": "NonAndSoft",
"value": "NonAndSoft"
},
{
"name": "Soft",
"value": "Soft"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BounceDateNewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BouncesDateOlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EmailFormatPreferenceFilter",
"optional": true,
"sampleValue": "All",
"deprecated": false,
"type": {
"id": "fac5777e17de156c24bf2b015b872184",
"name": "string",
"namespace": "FilterEmailFormatPreferenceFilter",
"fullNamespace": [
"Post_AccountId_ListId",
"Filter",
"FilterEmailFormatPreferenceFilter"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "All",
"enumeration": {
"name": "EmailFormatPreferenceFilter",
"options": [
{
"name": "All",
"value": "All"
},
{
"name": "Html",
"value": "Html"
},
{
"name": "NoPreference",
"value": "NoPreference"
},
{
"name": "Text",
"value": "Text"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Expression",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "f58571a0da19b3aa2a3f43d4881b3805",
"name": "Expression",
"logicalName": "Expression",
"namespace": "Expression",
"fullNamespace": [
"Post_AccountId_ListId",
"Filter",
"Expression"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Conditions",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Conditions",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Condition",
"type": {
"id": "8c7496f61d28f248880e293e7e7f1e1d",
"name": "Condition",
"logicalName": "Conditions",
"namespace": "Conditions",
"fullNamespace": [
"Post_AccountId_ListId",
"Filter",
"Expression",
"Conditions"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Comparison",
"optional": false,
"sampleValue": "Contains",
"deprecated": false,
"type": {
"id": "0b5cdf6a8afe2dcd6ccf4d357535948b",
"name": "Comparison",
"namespace": "ConditionsComparison",
"fullNamespace": [
"Post_AccountId_ListId",
"Filter",
"Expression",
"Conditions",
"ConditionsComparison"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Contains",
"enumeration": {
"name": "Comparison",
"options": [
{
"name": "Contains",
"value": "Contains"
},
{
"name": "EndsWith",
"value": "EndsWith"
},
{
"name": "Equals",
"value": "Equals"
},
{
"name": "GreaterThan",
"value": "GreaterThan"
},
{
"name": "GreaterThanOrEqualTo",
"value": "GreaterThanOrEqualTo"
},
{
"name": "IsNull",
"value": "IsNull"
},
{
"name": "LessThan",
"value": "LessThan"
},
{
"name": "LessThanOrEqualTo",
"value": "LessThanOrEqualTo"
},
{
"name": "NotEqual",
"value": "NotEqual"
},
{
"name": "StartsWith",
"value": "StartsWith"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Property",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Value",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Operator",
"optional": false,
"sampleValue": "And",
"deprecated": false,
"type": {
"id": "5634e1e459f44cc9202e903d422032be",
"name": "Operator",
"namespace": "ExpressionOperator",
"fullNamespace": [
"Post_AccountId_ListId",
"Filter",
"Expression",
"ExpressionOperator"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "And",
"enumeration": {
"name": "Operator",
"options": [
{
"name": "And",
"value": "And"
},
{
"name": "Or",
"value": "Or"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "NewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOutDateNewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOutDateOlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOutFilter",
"optional": true,
"sampleValue": "All",
"deprecated": false,
"type": {
"id": "ebaf233e7d5d5e1390a79bd2ef8a0486",
"name": "string",
"namespace": "FilterOptOutFilter",
"fullNamespace": [
"Post_AccountId_ListId",
"Filter",
"FilterOptOutFilter"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "All",
"enumeration": {
"name": "OptOutFilter",
"options": [
{
"name": "All",
"value": "All"
},
{
"name": "Non",
"value": "Non"
},
{
"name": "OptOuts",
"value": "OptOuts"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [],
"isBinary": false,
"hasBody": false
}
},
{
"id": "6d2f3c8827a1c9766c7171d30c943985",
"name": "",
"comments": "Subscribe a recipient.
", "methodName": "Post_ListId", "namespace": [ "Lists", "Recipients", "Subscribe" ], "urlTemplate": "Lists/Recipients/Subscribe/{listId}", "method": "POST", "urlParameters": [ { "name": "listId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "e9a381d4802989e3c816bbc7326aeb68",
"name": "RecipientParameters",
"logicalName": "Request",
"namespace": "Post_ListId",
"fullNamespace": [
"Post_ListId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Properties",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "33ef41d39d9e9e7e8d5f24d2eac41921",
"name": "RecipientProperties",
"logicalName": "Properties",
"namespace": "Properties",
"fullNamespace": [
"Post_ListId",
"Properties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Email",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EmailFormatPreference",
"optional": true,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "06c003bd45139aa6b36313c1f144f8f7",
"name": "string",
"namespace": "PropertiesEmailFormatPreference",
"fullNamespace": [
"Post_ListId",
"Properties",
"PropertiesEmailFormatPreference"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "EmailFormatPreference",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "None",
"value": "None"
},
{
"name": "Text",
"value": "Text"
},
{
"name": "TextAndHtml",
"value": "TextAndHtml"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOut",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Properties",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Properties",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Property",
"type": {
"id": "817d4fa0f2f256418bfd02b5bfcf0bdf",
"name": "Property",
"logicalName": "Properties",
"namespace": "Properties",
"fullNamespace": [
"Post_ListId",
"Properties",
"Properties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Value",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "Filter",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "c4446e5fefc9591e56118ad142f27263",
"name": "RecipientFilter",
"logicalName": "Filter",
"namespace": "Filter",
"fullNamespace": [
"Post_ListId",
"Filter"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Email",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BounceFilter",
"optional": true,
"sampleValue": "All",
"deprecated": false,
"type": {
"id": "a8af0c43f351c5c85bcb8dd433fdb0b5",
"name": "string",
"namespace": "FilterBounceFilter",
"fullNamespace": [
"Post_ListId",
"Filter",
"FilterBounceFilter"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "All",
"enumeration": {
"name": "BounceFilter",
"options": [
{
"name": "All",
"value": "All"
},
{
"name": "Hard",
"value": "Hard"
},
{
"name": "HardAndSoft",
"value": "HardAndSoft"
},
{
"name": "Non",
"value": "Non"
},
{
"name": "NonAndSoft",
"value": "NonAndSoft"
},
{
"name": "Soft",
"value": "Soft"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BounceDateNewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BouncesDateOlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EmailFormatPreferenceFilter",
"optional": true,
"sampleValue": "All",
"deprecated": false,
"type": {
"id": "fac5777e17de156c24bf2b015b872184",
"name": "string",
"namespace": "FilterEmailFormatPreferenceFilter",
"fullNamespace": [
"Post_ListId",
"Filter",
"FilterEmailFormatPreferenceFilter"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "All",
"enumeration": {
"name": "EmailFormatPreferenceFilter",
"options": [
{
"name": "All",
"value": "All"
},
{
"name": "Html",
"value": "Html"
},
{
"name": "NoPreference",
"value": "NoPreference"
},
{
"name": "Text",
"value": "Text"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Expression",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "f58571a0da19b3aa2a3f43d4881b3805",
"name": "Expression",
"logicalName": "Expression",
"namespace": "Expression",
"fullNamespace": [
"Post_ListId",
"Filter",
"Expression"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Conditions",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Conditions",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Condition",
"type": {
"id": "8c7496f61d28f248880e293e7e7f1e1d",
"name": "Condition",
"logicalName": "Conditions",
"namespace": "Conditions",
"fullNamespace": [
"Post_ListId",
"Filter",
"Expression",
"Conditions"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Comparison",
"optional": false,
"sampleValue": "Contains",
"deprecated": false,
"type": {
"id": "0b5cdf6a8afe2dcd6ccf4d357535948b",
"name": "Comparison",
"namespace": "ConditionsComparison",
"fullNamespace": [
"Post_ListId",
"Filter",
"Expression",
"Conditions",
"ConditionsComparison"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Contains",
"enumeration": {
"name": "Comparison",
"options": [
{
"name": "Contains",
"value": "Contains"
},
{
"name": "EndsWith",
"value": "EndsWith"
},
{
"name": "Equals",
"value": "Equals"
},
{
"name": "GreaterThan",
"value": "GreaterThan"
},
{
"name": "GreaterThanOrEqualTo",
"value": "GreaterThanOrEqualTo"
},
{
"name": "IsNull",
"value": "IsNull"
},
{
"name": "LessThan",
"value": "LessThan"
},
{
"name": "LessThanOrEqualTo",
"value": "LessThanOrEqualTo"
},
{
"name": "NotEqual",
"value": "NotEqual"
},
{
"name": "StartsWith",
"value": "StartsWith"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Property",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Value",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Operator",
"optional": false,
"sampleValue": "And",
"deprecated": false,
"type": {
"id": "5634e1e459f44cc9202e903d422032be",
"name": "Operator",
"namespace": "ExpressionOperator",
"fullNamespace": [
"Post_ListId",
"Filter",
"Expression",
"ExpressionOperator"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "And",
"enumeration": {
"name": "Operator",
"options": [
{
"name": "And",
"value": "And"
},
{
"name": "Or",
"value": "Or"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "NewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOutDateNewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOutDateOlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOutFilter",
"optional": true,
"sampleValue": "All",
"deprecated": false,
"type": {
"id": "ebaf233e7d5d5e1390a79bd2ef8a0486",
"name": "string",
"namespace": "FilterOptOutFilter",
"fullNamespace": [
"Post_ListId",
"Filter",
"FilterOptOutFilter"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "All",
"enumeration": {
"name": "OptOutFilter",
"options": [
{
"name": "All",
"value": "All"
},
{
"name": "Non",
"value": "Non"
},
{
"name": "OptOuts",
"value": "OptOuts"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [],
"isBinary": false,
"hasBody": false
}
}
]
},
{
"name": "/Lists/SubscriptionForm",
"comments": "List subscription form management.
", "endpoints": [ { "id": "eb83b097d7521b472058265ab9bc2dc1", "name": "", "comments": "Get a subscription form.
", "methodName": "Get_SubscriptionFormId", "namespace": [ "Lists", "SubscriptionForm" ], "urlTemplate": "Lists/SubscriptionForm/{subscriptionFormId}", "method": "GET", "urlParameters": [ { "name": "subscriptionFormId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "accept", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "cd2683fec495e2b4e547f4d8103cf0d4",
"name": "SubscriptionForm",
"logicalName": "Response",
"namespace": "Get_SubscriptionFormId",
"fullNamespace": [
"Get_SubscriptionFormId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptInType",
"optional": false,
"sampleValue": "Single",
"deprecated": false,
"type": {
"id": "53fd3799194e078faebe3e15f415f7e5",
"name": "OptInType",
"namespace": "ResponseOptInType",
"fullNamespace": [
"Get_SubscriptionFormId",
"ResponseOptInType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Double",
"enumeration": {
"name": "OptInType",
"options": [
{
"name": "Double",
"value": "Double"
},
{
"name": "Single",
"value": "Single"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Content",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "List",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "80ed0649be37d1d81b0d4a93ebe6d51b",
"name": "List",
"logicalName": "List",
"namespace": "List",
"fullNamespace": [
"Get_SubscriptionFormId",
"List"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "CreateDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "GroupId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ContentType",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalActiveRecipients",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalInactiveRecipients",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalRecipients",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Type",
"optional": false,
"sampleValue": "GlobalOptOut",
"deprecated": false,
"type": {
"id": "13f93e8e200ffb582c435387e75cdc71",
"name": "ListType",
"namespace": "ListType",
"fullNamespace": [
"Get_SubscriptionFormId",
"List",
"ListType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "GlobalOptOut",
"enumeration": {
"name": "ListType",
"options": [
{
"name": "GlobalOptOut",
"value": "GlobalOptOut"
},
{
"name": "Md5Suppression",
"value": "Md5Suppression"
},
{
"name": "Recipient",
"value": "Recipient"
},
{
"name": "Suppression",
"value": "Suppression"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Fields",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Fields",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Field",
"type": {
"id": "32e4ae9023bff32a2d72ada67ba78f2e",
"name": "Field",
"logicalName": "Fields",
"namespace": "Fields",
"fullNamespace": [
"Get_SubscriptionFormId",
"List",
"Fields"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Description",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Length",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Type",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Personalization",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "Fields",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Fields",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "SubscriptionFormField",
"type": {
"id": "b315ab883a7b7094ef9475e078b6bf8c",
"name": "SubscriptionFormField",
"logicalName": "Fields",
"namespace": "Fields",
"fullNamespace": [
"Get_SubscriptionFormId",
"Fields"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Required",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FriendlyName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Tags",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Tags",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "SubscriptionFormTagModel",
"type": {
"id": "70ac90e4dd9666ae3de475d6ba5604e5",
"name": "SubscriptionFormTagModel",
"logicalName": "Tags",
"namespace": "Tags",
"fullNamespace": [
"Get_SubscriptionFormId",
"Tags"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Tag",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "0f6b4f7420c95b3bbc2f387ab99acee2",
"name": "TagModel",
"logicalName": "Tag",
"namespace": "Tag",
"fullNamespace": [
"Get_SubscriptionFormId",
"Tags",
"Tag"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "WelcomeUrl",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Lists/SubscriptionForm/Filtered",
"comments": "List subscription form query.
", "endpoints": [ { "id": "f6fd30ebcaf990eff10c75b495c7d390", "name": "", "comments": "Query subscription forms.
", "methodName": "Post", "namespace": [ "Lists", "SubscriptionForm", "Filtered" ], "urlTemplate": "Lists/SubscriptionForm/Filtered", "method": "POST", "urlParameters": [], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "b0bb5e53c753708e8b39ff4bdc9f83e4",
"name": "Subscriber",
"logicalName": "Request",
"namespace": "Post",
"fullNamespace": [
"Post"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "StartIndex",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MaxResults",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "NewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "SubscriptionForms",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "SubscriptionForm",
"type": {
"id": "cd2683fec495e2b4e547f4d8103cf0d4",
"name": "SubscriptionForm",
"logicalName": "Response",
"namespace": "Post",
"fullNamespace": [
"Post"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptInType",
"optional": false,
"sampleValue": "Single",
"deprecated": false,
"type": {
"id": "53fd3799194e078faebe3e15f415f7e5",
"name": "OptInType",
"namespace": "ResponseOptInType",
"fullNamespace": [
"Post",
"ResponseOptInType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Double",
"enumeration": {
"name": "OptInType",
"options": [
{
"name": "Double",
"value": "Double"
},
{
"name": "Single",
"value": "Single"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Content",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "List",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "80ed0649be37d1d81b0d4a93ebe6d51b",
"name": "List",
"logicalName": "List",
"namespace": "List",
"fullNamespace": [
"Post",
"List"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "CreateDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "GroupId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ContentType",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalActiveRecipients",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalInactiveRecipients",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalRecipients",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Type",
"optional": false,
"sampleValue": "GlobalOptOut",
"deprecated": false,
"type": {
"id": "13f93e8e200ffb582c435387e75cdc71",
"name": "ListType",
"namespace": "ListType",
"fullNamespace": [
"Post",
"List",
"ListType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "GlobalOptOut",
"enumeration": {
"name": "ListType",
"options": [
{
"name": "GlobalOptOut",
"value": "GlobalOptOut"
},
{
"name": "Md5Suppression",
"value": "Md5Suppression"
},
{
"name": "Recipient",
"value": "Recipient"
},
{
"name": "Suppression",
"value": "Suppression"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Fields",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Fields",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Field",
"type": {
"id": "32e4ae9023bff32a2d72ada67ba78f2e",
"name": "Field",
"logicalName": "Fields",
"namespace": "Fields",
"fullNamespace": [
"Post",
"List",
"Fields"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Description",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Length",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Type",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Personalization",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "Fields",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Fields",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "SubscriptionFormField",
"type": {
"id": "b315ab883a7b7094ef9475e078b6bf8c",
"name": "SubscriptionFormField",
"logicalName": "Fields",
"namespace": "Fields",
"fullNamespace": [
"Post",
"Fields"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Required",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FriendlyName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Tags",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Tags",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "SubscriptionFormTagModel",
"type": {
"id": "70ac90e4dd9666ae3de475d6ba5604e5",
"name": "SubscriptionFormTagModel",
"logicalName": "Tags",
"namespace": "Tags",
"fullNamespace": [
"Post",
"Tags"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Tag",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "0f6b4f7420c95b3bbc2f387ab99acee2",
"name": "TagModel",
"logicalName": "Tag",
"namespace": "Tag",
"fullNamespace": [
"Post",
"Tags",
"Tag"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "WelcomeUrl",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "2eb86ad8404e83f99e3231db6fc9c468",
"name": "",
"comments": "Query subscription forms.
", "methodName": "Post_AccountId", "namespace": [ "Lists", "SubscriptionForm", "Filtered" ], "urlTemplate": "Lists/SubscriptionForm/Filtered/{accountId}", "method": "POST", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "b0bb5e53c753708e8b39ff4bdc9f83e4",
"name": "Subscriber",
"logicalName": "Request",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "StartIndex",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MaxResults",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "NewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "SubscriptionForms",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "SubscriptionForm",
"type": {
"id": "cd2683fec495e2b4e547f4d8103cf0d4",
"name": "SubscriptionForm",
"logicalName": "Response",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptInType",
"optional": false,
"sampleValue": "Single",
"deprecated": false,
"type": {
"id": "53fd3799194e078faebe3e15f415f7e5",
"name": "OptInType",
"namespace": "ResponseOptInType",
"fullNamespace": [
"Post_AccountId",
"ResponseOptInType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Double",
"enumeration": {
"name": "OptInType",
"options": [
{
"name": "Double",
"value": "Double"
},
{
"name": "Single",
"value": "Single"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Content",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "List",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "80ed0649be37d1d81b0d4a93ebe6d51b",
"name": "List",
"logicalName": "List",
"namespace": "List",
"fullNamespace": [
"Post_AccountId",
"List"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "CreateDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "GroupId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ContentType",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalActiveRecipients",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalInactiveRecipients",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalRecipients",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Type",
"optional": false,
"sampleValue": "GlobalOptOut",
"deprecated": false,
"type": {
"id": "13f93e8e200ffb582c435387e75cdc71",
"name": "ListType",
"namespace": "ListType",
"fullNamespace": [
"Post_AccountId",
"List",
"ListType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "GlobalOptOut",
"enumeration": {
"name": "ListType",
"options": [
{
"name": "GlobalOptOut",
"value": "GlobalOptOut"
},
{
"name": "Md5Suppression",
"value": "Md5Suppression"
},
{
"name": "Recipient",
"value": "Recipient"
},
{
"name": "Suppression",
"value": "Suppression"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Fields",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Fields",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Field",
"type": {
"id": "32e4ae9023bff32a2d72ada67ba78f2e",
"name": "Field",
"logicalName": "Fields",
"namespace": "Fields",
"fullNamespace": [
"Post_AccountId",
"List",
"Fields"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Description",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Length",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Type",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Personalization",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "Fields",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Fields",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "SubscriptionFormField",
"type": {
"id": "b315ab883a7b7094ef9475e078b6bf8c",
"name": "SubscriptionFormField",
"logicalName": "Fields",
"namespace": "Fields",
"fullNamespace": [
"Post_AccountId",
"Fields"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Required",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FriendlyName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Tags",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Tags",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "SubscriptionFormTagModel",
"type": {
"id": "70ac90e4dd9666ae3de475d6ba5604e5",
"name": "SubscriptionFormTagModel",
"logicalName": "Tags",
"namespace": "Tags",
"fullNamespace": [
"Post_AccountId",
"Tags"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Tag",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "0f6b4f7420c95b3bbc2f387ab99acee2",
"name": "TagModel",
"logicalName": "Tag",
"namespace": "Tag",
"fullNamespace": [
"Post_AccountId",
"Tags",
"Tag"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "WelcomeUrl",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Lists/SubscriptionForm/Subscriber",
"comments": "List subscription form management.
", "endpoints": [ { "id": "f73e452af7d6145b3e8ff9710acaa92e", "name": "", "methodName": "PublicPost_Subscriber_SubscriptionFormId", "namespace": [ "Lists", "SubscriptionForm", "Subscriber" ], "urlTemplate": "Lists/SubscriptionForm/Subscriber/{subscriptionFormId}", "method": "POST", "urlParameters": [ { "name": "subscriptionFormId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": false, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "7c62bcc4053015956a83c1394aa7ac8f",
"name": "Subscriber",
"logicalName": "Request",
"namespace": "PublicPost_Subscriber_SubscriptionFormId",
"fullNamespace": [
"PublicPost_Subscriber_SubscriptionFormId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Properties",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Properties",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "SubscriberProperty",
"type": {
"id": "40957f1e7851524a40182f6dcf620518",
"name": "SubscriberProperty",
"logicalName": "Properties",
"namespace": "Properties",
"fullNamespace": [
"PublicPost_Subscriber_SubscriptionFormId",
"Properties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "ListElementName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Value",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "MailingFormat",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [],
"isBinary": false,
"hasBody": false
}
}
]
}
]
},
{
"name": "Mailings",
"comments": "Mailing endpoint provides ability in creating, updating, deleting, and retrieving mailings.
\nMailing components.
\nMailing Management: Creating and Managing Mailing Content
\nHere's a step-by-step guide to creating mailing content
\n1. Create a Basic HTML Mailing
\nTo create a mailing, use thePOST method on the Mailings endpoint and send the following request:
{\n\"Name\": \"My First Mailing\",\n\"Subject\": \"My First Mailing\",\n\"MailingFormat\": \"Html\",\n\"FromEmail\": \"myemail@domain.com\",\n\"ReplyTo\": \"myemail@domain.com\",\n\"HtmlContent\": \"<body><h1>This is a test</h1><p>Testing basic mailing content</p></body>\"\n}
This will return a unique Id that you will use to reference the mailing in future actions.
2. Using Personalization in Mailing Content
\nMailing personalization can occur in several ways, Subject line, mailing content and link parameters.
\nIn this example, we assume the list being sent to contains a full name field, so we will personalize both\nthe Subject line and body with the recipient's full name.
{\n\"Name\": \"My First Mailing\",\n\"Subject\": \"Hello {{fullname|Friend}}\",\n\"MailingFormat\": \"Html\",\n\"FromEmail\": \"myemail@domain.com\",\n\"ReplyTo\": \"myemail@domain.com\",\n\"HtmlContent\": \"<body><h1>Hi {{fullname|There}}</h1><p>Testing basic mailing content</p></body>\"\n}
Check out this documentation for more information
", "endpoints": [ { "id": "85dfc1ca1e2acf265651ce79fbda7200", "name": "", "comments": "Create a mailing.
", "methodName": "Post", "namespace": [ "Mailings" ], "urlTemplate": "Mailings", "method": "POST", "urlParameters": [], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "25e55c5d509923bd5357cd9a0cedf5d2",
"name": "MailingProperties",
"logicalName": "Request",
"namespace": "Post",
"fullNamespace": [
"Post"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Subject",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailingFormat",
"optional": true,
"sampleValue": "Text",
"deprecated": false,
"type": {
"id": "221d02ff472cbfefbbb3342a756c5d02",
"name": "string",
"namespace": "RequestMailingFormat",
"fullNamespace": [
"Post",
"RequestMailingFormat"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "MailingFormat",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "Text",
"value": "Text"
},
{
"name": "TextAndHtml",
"value": "TextAndHtml"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "GroupId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AddressId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FromEmail",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FromName",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ReplyToEmail",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "HtmlContent",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TextContent",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "PreHeader",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CustomHtmlUnsubscribeLinkText",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CustomTextUnsubscribeLinkText",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "IncludeSendToAFriendLink",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SendToAFriendLinkText",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TrackedLinks",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TrackedLinks",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "TrackedLink",
"type": {
"id": "6b8ce8f8415d762bbd587671495fc89e",
"name": "TrackedLink",
"logicalName": "TrackedLinks",
"namespace": "TrackedLinks",
"fullNamespace": [
"Post",
"TrackedLinks"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "LinkMailingFormat",
"optional": false,
"sampleValue": "Any",
"deprecated": false,
"type": {
"id": "d3d39f8fb2b3968713db5cb1c6190598",
"name": "string",
"namespace": "TrackedLinksLinkMailingFormat",
"fullNamespace": [
"Post",
"TrackedLinks",
"TrackedLinksLinkMailingFormat"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Any",
"enumeration": {
"name": "LinkMailingFormat",
"options": [
{
"name": "Any",
"value": "Any"
},
{
"name": "Html",
"value": "Html"
},
{
"name": "Text",
"value": "Text"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Url",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AdvertiserNumber",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "AnnotationId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CampaingProfileId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AnalyticsVendor",
"optional": true,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "11cab89a73a4d467bc1b8d4470952c8a",
"name": "string",
"namespace": "RequestAnalyticsVendor",
"fullNamespace": [
"Post",
"RequestAnalyticsVendor"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "GoogleAnalytics",
"enumeration": {
"name": "AnalyticsVendor",
"options": [
{
"name": "GoogleAnalytics",
"value": "GoogleAnalytics"
},
{
"name": "Matomo",
"value": "Matomo"
},
{
"name": "None",
"value": "None"
},
{
"name": "OpenWebAnalytics",
"value": "OpenWebAnalytics"
},
{
"name": "Oribi",
"value": "Oribi"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "191146335f2e48c7a94155fdbe2464b8",
"name": "Mailing",
"logicalName": "Response",
"namespace": "Post",
"fullNamespace": [
"Post"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DkimInstallationStatus",
"optional": false,
"sampleValue": "Installed",
"deprecated": false,
"type": {
"id": "0fdcee52022aa75f3db6fa1fa82b431e",
"name": "DkimInstallationResponse",
"namespace": "ResponseDkimInstallationStatus",
"fullNamespace": [
"Post",
"ResponseDkimInstallationStatus"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Installed",
"enumeration": {
"name": "DkimInstallationResponse",
"options": [
{
"name": "Installed",
"value": "Installed",
"comments": "DKIM Public Key is verified as installed on domain"
},
{
"name": "InvalidKeyType",
"value": "InvalidKeyType",
"comments": "DKIM Public Key type ('a=' or 'k=' tag) is invalid. Change to 'rsa'"
},
{
"name": "NotQueried",
"value": "NotQueried",
"comments": "No check of DKIM Public Key installation occurred"
},
{
"name": "PublicKeyMismatch",
"value": "PublicKeyMismatch",
"comments": "DKIM Public Key installed on domain differs from Public Key in system"
},
{
"name": "PublicKeyNotFound",
"value": "PublicKeyNotFound",
"comments": "DKIM Public Key not found in the 'p=' tag"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "3bed3b39ca1c4d6389ce5884a8229940",
"name": "",
"comments": "Create a mailing.
", "methodName": "Post_AccountId", "namespace": [ "Mailings" ], "urlTemplate": "Mailings/{accountId}", "method": "POST", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "25e55c5d509923bd5357cd9a0cedf5d2",
"name": "MailingProperties",
"logicalName": "Request",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Subject",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailingFormat",
"optional": true,
"sampleValue": "Text",
"deprecated": false,
"type": {
"id": "221d02ff472cbfefbbb3342a756c5d02",
"name": "string",
"namespace": "RequestMailingFormat",
"fullNamespace": [
"Post_AccountId",
"RequestMailingFormat"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "MailingFormat",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "Text",
"value": "Text"
},
{
"name": "TextAndHtml",
"value": "TextAndHtml"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "GroupId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AddressId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FromEmail",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FromName",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ReplyToEmail",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "HtmlContent",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TextContent",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "PreHeader",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CustomHtmlUnsubscribeLinkText",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CustomTextUnsubscribeLinkText",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "IncludeSendToAFriendLink",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SendToAFriendLinkText",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TrackedLinks",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TrackedLinks",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "TrackedLink",
"type": {
"id": "6b8ce8f8415d762bbd587671495fc89e",
"name": "TrackedLink",
"logicalName": "TrackedLinks",
"namespace": "TrackedLinks",
"fullNamespace": [
"Post_AccountId",
"TrackedLinks"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "LinkMailingFormat",
"optional": false,
"sampleValue": "Any",
"deprecated": false,
"type": {
"id": "d3d39f8fb2b3968713db5cb1c6190598",
"name": "string",
"namespace": "TrackedLinksLinkMailingFormat",
"fullNamespace": [
"Post_AccountId",
"TrackedLinks",
"TrackedLinksLinkMailingFormat"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Any",
"enumeration": {
"name": "LinkMailingFormat",
"options": [
{
"name": "Any",
"value": "Any"
},
{
"name": "Html",
"value": "Html"
},
{
"name": "Text",
"value": "Text"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Url",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AdvertiserNumber",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "AnnotationId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CampaingProfileId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AnalyticsVendor",
"optional": true,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "11cab89a73a4d467bc1b8d4470952c8a",
"name": "string",
"namespace": "RequestAnalyticsVendor",
"fullNamespace": [
"Post_AccountId",
"RequestAnalyticsVendor"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "GoogleAnalytics",
"enumeration": {
"name": "AnalyticsVendor",
"options": [
{
"name": "GoogleAnalytics",
"value": "GoogleAnalytics"
},
{
"name": "Matomo",
"value": "Matomo"
},
{
"name": "None",
"value": "None"
},
{
"name": "OpenWebAnalytics",
"value": "OpenWebAnalytics"
},
{
"name": "Oribi",
"value": "Oribi"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "191146335f2e48c7a94155fdbe2464b8",
"name": "Mailing",
"logicalName": "Response",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DkimInstallationStatus",
"optional": false,
"sampleValue": "Installed",
"deprecated": false,
"type": {
"id": "0fdcee52022aa75f3db6fa1fa82b431e",
"name": "DkimInstallationResponse",
"namespace": "ResponseDkimInstallationStatus",
"fullNamespace": [
"Post_AccountId",
"ResponseDkimInstallationStatus"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Installed",
"enumeration": {
"name": "DkimInstallationResponse",
"options": [
{
"name": "Installed",
"value": "Installed",
"comments": "DKIM Public Key is verified as installed on domain"
},
{
"name": "InvalidKeyType",
"value": "InvalidKeyType",
"comments": "DKIM Public Key type ('a=' or 'k=' tag) is invalid. Change to 'rsa'"
},
{
"name": "NotQueried",
"value": "NotQueried",
"comments": "No check of DKIM Public Key installation occurred"
},
{
"name": "PublicKeyMismatch",
"value": "PublicKeyMismatch",
"comments": "DKIM Public Key installed on domain differs from Public Key in system"
},
{
"name": "PublicKeyNotFound",
"value": "PublicKeyNotFound",
"comments": "DKIM Public Key not found in the 'p=' tag"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "d6d97bf6d961580845cab8e37a6828a3",
"name": "",
"comments": "Get a mailing.
", "methodName": "Get_AccountId_MailingId", "namespace": [ "Mailings" ], "urlTemplate": "Mailings/{accountId}/{mailingId}", "method": "GET", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "mailingId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "accept", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "80ab0c527d422e0f203012edd305ccd8",
"name": "Mailing",
"logicalName": "Response",
"namespace": "Get_AccountId_MailingId",
"fullNamespace": [
"Get_AccountId_MailingId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Subject",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailingFormat",
"optional": false,
"sampleValue": "Text",
"deprecated": false,
"type": {
"id": "2a042d91d89e4d5bde38b6e0619cc96e",
"name": "MailingFormat",
"namespace": "ResponseMailingFormat",
"fullNamespace": [
"Get_AccountId_MailingId",
"ResponseMailingFormat"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "MailingFormat",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "Text",
"value": "Text"
},
{
"name": "TextAndHtml",
"value": "TextAndHtml"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "GroupId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AddressId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FromEmail",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FromName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ReplyToEmail",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "HtmlContent",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TextContent",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "PreHeader",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "IncludeSendToAFriendLink",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SendToAFriendLinkText",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TrackedLinks",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TrackedLinks",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "TrackedLink",
"type": {
"id": "641605cff3f7a476bc274df44693c362",
"name": "TrackedLink",
"logicalName": "TrackedLinks",
"namespace": "TrackedLinks",
"fullNamespace": [
"Get_AccountId_MailingId",
"TrackedLinks"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Url",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LinkMailingFormat",
"optional": false,
"sampleValue": "Text",
"deprecated": false,
"type": {
"id": "7ee11c6687b34cdf122c67891d43e796",
"name": "TrackedLinkMailingFormat",
"namespace": "TrackedLinksLinkMailingFormat",
"fullNamespace": [
"Get_AccountId_MailingId",
"TrackedLinks",
"TrackedLinksLinkMailingFormat"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "TrackedLinkMailingFormat",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "Text",
"value": "Text"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DkimInstallationStatus",
"optional": false,
"sampleValue": "Installed",
"deprecated": false,
"type": {
"id": "f3be26e1420500da064d7727466d1df8",
"name": "string",
"namespace": "ResponseDkimInstallationStatus",
"fullNamespace": [
"Get_AccountId_MailingId",
"ResponseDkimInstallationStatus"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Installed",
"enumeration": {
"name": "DkimDomainInstallationStatus",
"options": [
{
"name": "Installed",
"value": "Installed"
},
{
"name": "InvalidKeyType",
"value": "InvalidKeyType"
},
{
"name": "InvalidVersion",
"value": "InvalidVersion"
},
{
"name": "NotQueried",
"value": "NotQueried"
},
{
"name": "PublicKeyMismatch",
"value": "PublicKeyMismatch"
},
{
"name": "PublicKeyNotFound",
"value": "PublicKeyNotFound"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AnnotationId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AnalyticsVendor",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "11cab89a73a4d467bc1b8d4470952c8a",
"name": "string",
"namespace": "ResponseAnalyticsVendor",
"fullNamespace": [
"Get_AccountId_MailingId",
"ResponseAnalyticsVendor"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "GoogleAnalytics",
"enumeration": {
"name": "AnalyticsVendor",
"options": [
{
"name": "GoogleAnalytics",
"value": "GoogleAnalytics"
},
{
"name": "Matomo",
"value": "Matomo"
},
{
"name": "None",
"value": "None"
},
{
"name": "OpenWebAnalytics",
"value": "OpenWebAnalytics"
},
{
"name": "Oribi",
"value": "Oribi"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "c90f7a7e50c6082f6a17c05b9ed03598",
"name": "",
"comments": "Modify a mailing.
", "methodName": "Put_AccountId_MailingId", "namespace": [ "Mailings" ], "urlTemplate": "Mailings/{accountId}/{mailingId}", "method": "PUT", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "mailingId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "06d4b19624c684eab883163be65c8c0b",
"name": "MailingProperties",
"logicalName": "Request",
"namespace": "Put_AccountId_MailingId",
"fullNamespace": [
"Put_AccountId_MailingId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Subject",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailingFormat",
"optional": true,
"sampleValue": "Text",
"deprecated": false,
"type": {
"id": "221d02ff472cbfefbbb3342a756c5d02",
"name": "string",
"namespace": "RequestMailingFormat",
"fullNamespace": [
"Put_AccountId_MailingId",
"RequestMailingFormat"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "MailingFormat",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "Text",
"value": "Text"
},
{
"name": "TextAndHtml",
"value": "TextAndHtml"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "GroupId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AddressId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FromEmail",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FromName",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ReplyToEmail",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "HtmlContent",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TextContent",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "PreHeader",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CustomHtmlUnsubscribeLinkText",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CustomTextUnsubscribeLinkText",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "IncludeSendToAFriendLink",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SendToAFriendLinkText",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TrackedLinks",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TrackedLinks",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "TrackedLink",
"type": {
"id": "6b8ce8f8415d762bbd587671495fc89e",
"name": "TrackedLink",
"logicalName": "TrackedLinks",
"namespace": "TrackedLinks",
"fullNamespace": [
"Put_AccountId_MailingId",
"TrackedLinks"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "LinkMailingFormat",
"optional": false,
"sampleValue": "Any",
"deprecated": false,
"type": {
"id": "d3d39f8fb2b3968713db5cb1c6190598",
"name": "string",
"namespace": "TrackedLinksLinkMailingFormat",
"fullNamespace": [
"Put_AccountId_MailingId",
"TrackedLinks",
"TrackedLinksLinkMailingFormat"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Any",
"enumeration": {
"name": "LinkMailingFormat",
"options": [
{
"name": "Any",
"value": "Any"
},
{
"name": "Html",
"value": "Html"
},
{
"name": "Text",
"value": "Text"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Url",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AdvertiserNumber",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "AnnotationId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CampaignProfileId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AnalyticsVendor",
"optional": true,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "11cab89a73a4d467bc1b8d4470952c8a",
"name": "string",
"namespace": "RequestAnalyticsVendor",
"fullNamespace": [
"Put_AccountId_MailingId",
"RequestAnalyticsVendor"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "GoogleAnalytics",
"enumeration": {
"name": "AnalyticsVendor",
"options": [
{
"name": "GoogleAnalytics",
"value": "GoogleAnalytics"
},
{
"name": "Matomo",
"value": "Matomo"
},
{
"name": "None",
"value": "None"
},
{
"name": "OpenWebAnalytics",
"value": "OpenWebAnalytics"
},
{
"name": "Oribi",
"value": "Oribi"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [],
"isBinary": false,
"hasBody": false
}
},
{
"id": "6a7cc6ae6027384c9222af6914aa9375",
"name": "",
"comments": "Delete a mailing.
", "methodName": "Delete_AccountId_MailingId", "namespace": [ "Mailings" ], "urlTemplate": "Mailings/{accountId}/{mailingId}", "method": "DELETE", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "mailingId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [], "isBinary": false, "hasBody": false }, "response": { "headers": [], "isBinary": false, "hasBody": false } }, { "id": "ff39ad265142c1bdca27645e082f802b", "name": "", "comments": "Get a mailing.
", "methodName": "Get_MailingId", "namespace": [ "Mailings" ], "urlTemplate": "Mailings/{mailingId}", "method": "GET", "urlParameters": [ { "name": "mailingId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "accept", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "80ab0c527d422e0f203012edd305ccd8",
"name": "Mailing",
"logicalName": "Response",
"namespace": "Get_MailingId",
"fullNamespace": [
"Get_MailingId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Subject",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailingFormat",
"optional": false,
"sampleValue": "Text",
"deprecated": false,
"type": {
"id": "2a042d91d89e4d5bde38b6e0619cc96e",
"name": "MailingFormat",
"namespace": "ResponseMailingFormat",
"fullNamespace": [
"Get_MailingId",
"ResponseMailingFormat"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "MailingFormat",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "Text",
"value": "Text"
},
{
"name": "TextAndHtml",
"value": "TextAndHtml"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "GroupId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AddressId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FromEmail",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FromName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ReplyToEmail",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "HtmlContent",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TextContent",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "PreHeader",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "IncludeSendToAFriendLink",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SendToAFriendLinkText",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TrackedLinks",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TrackedLinks",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "TrackedLink",
"type": {
"id": "641605cff3f7a476bc274df44693c362",
"name": "TrackedLink",
"logicalName": "TrackedLinks",
"namespace": "TrackedLinks",
"fullNamespace": [
"Get_MailingId",
"TrackedLinks"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Url",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LinkMailingFormat",
"optional": false,
"sampleValue": "Text",
"deprecated": false,
"type": {
"id": "7ee11c6687b34cdf122c67891d43e796",
"name": "TrackedLinkMailingFormat",
"namespace": "TrackedLinksLinkMailingFormat",
"fullNamespace": [
"Get_MailingId",
"TrackedLinks",
"TrackedLinksLinkMailingFormat"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "TrackedLinkMailingFormat",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "Text",
"value": "Text"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DkimInstallationStatus",
"optional": false,
"sampleValue": "Installed",
"deprecated": false,
"type": {
"id": "f3be26e1420500da064d7727466d1df8",
"name": "string",
"namespace": "ResponseDkimInstallationStatus",
"fullNamespace": [
"Get_MailingId",
"ResponseDkimInstallationStatus"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Installed",
"enumeration": {
"name": "DkimDomainInstallationStatus",
"options": [
{
"name": "Installed",
"value": "Installed"
},
{
"name": "InvalidKeyType",
"value": "InvalidKeyType"
},
{
"name": "InvalidVersion",
"value": "InvalidVersion"
},
{
"name": "NotQueried",
"value": "NotQueried"
},
{
"name": "PublicKeyMismatch",
"value": "PublicKeyMismatch"
},
{
"name": "PublicKeyNotFound",
"value": "PublicKeyNotFound"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AnnotationId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AnalyticsVendor",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "11cab89a73a4d467bc1b8d4470952c8a",
"name": "string",
"namespace": "ResponseAnalyticsVendor",
"fullNamespace": [
"Get_MailingId",
"ResponseAnalyticsVendor"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "GoogleAnalytics",
"enumeration": {
"name": "AnalyticsVendor",
"options": [
{
"name": "GoogleAnalytics",
"value": "GoogleAnalytics"
},
{
"name": "Matomo",
"value": "Matomo"
},
{
"name": "None",
"value": "None"
},
{
"name": "OpenWebAnalytics",
"value": "OpenWebAnalytics"
},
{
"name": "Oribi",
"value": "Oribi"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "9ad2ffd1b717e207213f19bd553d7712",
"name": "",
"comments": "Modify a mailing.
", "methodName": "Put_MailingId", "namespace": [ "Mailings" ], "urlTemplate": "Mailings/{mailingId}", "method": "PUT", "urlParameters": [ { "name": "mailingId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "06d4b19624c684eab883163be65c8c0b",
"name": "MailingProperties",
"logicalName": "Request",
"namespace": "Put_MailingId",
"fullNamespace": [
"Put_MailingId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Subject",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailingFormat",
"optional": true,
"sampleValue": "Text",
"deprecated": false,
"type": {
"id": "221d02ff472cbfefbbb3342a756c5d02",
"name": "string",
"namespace": "RequestMailingFormat",
"fullNamespace": [
"Put_MailingId",
"RequestMailingFormat"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "MailingFormat",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "Text",
"value": "Text"
},
{
"name": "TextAndHtml",
"value": "TextAndHtml"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "GroupId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AddressId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FromEmail",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FromName",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ReplyToEmail",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "HtmlContent",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TextContent",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "PreHeader",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CustomHtmlUnsubscribeLinkText",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CustomTextUnsubscribeLinkText",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "IncludeSendToAFriendLink",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SendToAFriendLinkText",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TrackedLinks",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TrackedLinks",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "TrackedLink",
"type": {
"id": "6b8ce8f8415d762bbd587671495fc89e",
"name": "TrackedLink",
"logicalName": "TrackedLinks",
"namespace": "TrackedLinks",
"fullNamespace": [
"Put_MailingId",
"TrackedLinks"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "LinkMailingFormat",
"optional": false,
"sampleValue": "Any",
"deprecated": false,
"type": {
"id": "d3d39f8fb2b3968713db5cb1c6190598",
"name": "string",
"namespace": "TrackedLinksLinkMailingFormat",
"fullNamespace": [
"Put_MailingId",
"TrackedLinks",
"TrackedLinksLinkMailingFormat"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Any",
"enumeration": {
"name": "LinkMailingFormat",
"options": [
{
"name": "Any",
"value": "Any"
},
{
"name": "Html",
"value": "Html"
},
{
"name": "Text",
"value": "Text"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Url",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AdvertiserNumber",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "AnnotationId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CampaignProfileId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AnalyticsVendor",
"optional": true,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "11cab89a73a4d467bc1b8d4470952c8a",
"name": "string",
"namespace": "RequestAnalyticsVendor",
"fullNamespace": [
"Put_MailingId",
"RequestAnalyticsVendor"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "GoogleAnalytics",
"enumeration": {
"name": "AnalyticsVendor",
"options": [
{
"name": "GoogleAnalytics",
"value": "GoogleAnalytics"
},
{
"name": "Matomo",
"value": "Matomo"
},
{
"name": "None",
"value": "None"
},
{
"name": "OpenWebAnalytics",
"value": "OpenWebAnalytics"
},
{
"name": "Oribi",
"value": "Oribi"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [],
"isBinary": false,
"hasBody": false
}
},
{
"id": "611d9e9e4fb89d18b91e44f4d5d490ef",
"name": "",
"comments": "Delete a mailing.
", "methodName": "Delete_MailingId", "namespace": [ "Mailings" ], "urlTemplate": "Mailings/{mailingId}", "method": "DELETE", "urlParameters": [ { "name": "mailingId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [], "isBinary": false, "hasBody": false }, "response": { "headers": [], "isBinary": false, "hasBody": false } } ] }, { "name": "/Mailings/Bundled", "endpoints": [ { "id": "369ecb9342dc8e4023159f6e40edf23b", "name": "", "methodName": "Post", "namespace": [ "Mailings", "Bundled" ], "urlTemplate": "Mailings/Bundled", "method": "POST", "urlParameters": [], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "086d5192d9180d3b049bceb465e386a6",
"name": "ContentBundleRequestModel",
"logicalName": "Request",
"namespace": "Post",
"fullNamespace": [
"Post"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Data",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "39474da5b37452126bf560bb3caee1dc",
"name": "ContentBundleModel",
"logicalName": "Response",
"namespace": "Post",
"fullNamespace": [
"Post"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "HtmlContent",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "IsValid",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TextContent",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ValidationErrors",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "ValidationErrors",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "string",
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Mailings/Filtered",
"comments": "Mailing query.
", "endpoints": [ { "id": "6e3cd128bb38823c4f8a1c83e35db5c0", "name": "", "comments": "Query mailings.
", "methodName": "Post", "namespace": [ "Mailings", "Filtered" ], "urlTemplate": "Mailings/Filtered", "method": "POST", "urlParameters": [], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "836ca59742b59b1a892747ced445a6c3",
"name": "MailingFilter",
"logicalName": "Request",
"namespace": "Post",
"fullNamespace": [
"Post"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "GroupId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "IncludeSubGroups",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MaxResults",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "StartIndex",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "NewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "Mailings",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Mailing",
"type": {
"id": "80ab0c527d422e0f203012edd305ccd8",
"name": "Mailing",
"logicalName": "Response",
"namespace": "Post",
"fullNamespace": [
"Post"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Subject",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailingFormat",
"optional": false,
"sampleValue": "Text",
"deprecated": false,
"type": {
"id": "2a042d91d89e4d5bde38b6e0619cc96e",
"name": "MailingFormat",
"namespace": "ResponseMailingFormat",
"fullNamespace": [
"Post",
"ResponseMailingFormat"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "MailingFormat",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "Text",
"value": "Text"
},
{
"name": "TextAndHtml",
"value": "TextAndHtml"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "GroupId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AddressId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FromEmail",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FromName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ReplyToEmail",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "HtmlContent",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TextContent",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "PreHeader",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "IncludeSendToAFriendLink",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SendToAFriendLinkText",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TrackedLinks",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TrackedLinks",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "TrackedLink",
"type": {
"id": "641605cff3f7a476bc274df44693c362",
"name": "TrackedLink",
"logicalName": "TrackedLinks",
"namespace": "TrackedLinks",
"fullNamespace": [
"Post",
"TrackedLinks"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Url",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LinkMailingFormat",
"optional": false,
"sampleValue": "Text",
"deprecated": false,
"type": {
"id": "7ee11c6687b34cdf122c67891d43e796",
"name": "TrackedLinkMailingFormat",
"namespace": "TrackedLinksLinkMailingFormat",
"fullNamespace": [
"Post",
"TrackedLinks",
"TrackedLinksLinkMailingFormat"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "TrackedLinkMailingFormat",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "Text",
"value": "Text"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DkimInstallationStatus",
"optional": false,
"sampleValue": "Installed",
"deprecated": false,
"type": {
"id": "f3be26e1420500da064d7727466d1df8",
"name": "string",
"namespace": "ResponseDkimInstallationStatus",
"fullNamespace": [
"Post",
"ResponseDkimInstallationStatus"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Installed",
"enumeration": {
"name": "DkimDomainInstallationStatus",
"options": [
{
"name": "Installed",
"value": "Installed"
},
{
"name": "InvalidKeyType",
"value": "InvalidKeyType"
},
{
"name": "InvalidVersion",
"value": "InvalidVersion"
},
{
"name": "NotQueried",
"value": "NotQueried"
},
{
"name": "PublicKeyMismatch",
"value": "PublicKeyMismatch"
},
{
"name": "PublicKeyNotFound",
"value": "PublicKeyNotFound"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AnnotationId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AnalyticsVendor",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "11cab89a73a4d467bc1b8d4470952c8a",
"name": "string",
"namespace": "ResponseAnalyticsVendor",
"fullNamespace": [
"Post",
"ResponseAnalyticsVendor"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "GoogleAnalytics",
"enumeration": {
"name": "AnalyticsVendor",
"options": [
{
"name": "GoogleAnalytics",
"value": "GoogleAnalytics"
},
{
"name": "Matomo",
"value": "Matomo"
},
{
"name": "None",
"value": "None"
},
{
"name": "OpenWebAnalytics",
"value": "OpenWebAnalytics"
},
{
"name": "Oribi",
"value": "Oribi"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "8ca3f78fd3e2d4996992bd5afc190347",
"name": "",
"comments": "Query mailings.
", "methodName": "Post_AccountId", "namespace": [ "Mailings", "Filtered" ], "urlTemplate": "Mailings/Filtered/{accountId}", "method": "POST", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "836ca59742b59b1a892747ced445a6c3",
"name": "MailingFilter",
"logicalName": "Request",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "GroupId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "IncludeSubGroups",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": true,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MaxResults",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "StartIndex",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "NewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "Mailings",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Mailing",
"type": {
"id": "80ab0c527d422e0f203012edd305ccd8",
"name": "Mailing",
"logicalName": "Response",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Subject",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailingFormat",
"optional": false,
"sampleValue": "Text",
"deprecated": false,
"type": {
"id": "2a042d91d89e4d5bde38b6e0619cc96e",
"name": "MailingFormat",
"namespace": "ResponseMailingFormat",
"fullNamespace": [
"Post_AccountId",
"ResponseMailingFormat"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "MailingFormat",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "Text",
"value": "Text"
},
{
"name": "TextAndHtml",
"value": "TextAndHtml"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "GroupId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AddressId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FromEmail",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FromName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ReplyToEmail",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "HtmlContent",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TextContent",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "PreHeader",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "IncludeSendToAFriendLink",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SendToAFriendLinkText",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TrackedLinks",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "TrackedLinks",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "TrackedLink",
"type": {
"id": "641605cff3f7a476bc274df44693c362",
"name": "TrackedLink",
"logicalName": "TrackedLinks",
"namespace": "TrackedLinks",
"fullNamespace": [
"Post_AccountId",
"TrackedLinks"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Url",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LinkMailingFormat",
"optional": false,
"sampleValue": "Text",
"deprecated": false,
"type": {
"id": "7ee11c6687b34cdf122c67891d43e796",
"name": "TrackedLinkMailingFormat",
"namespace": "TrackedLinksLinkMailingFormat",
"fullNamespace": [
"Post_AccountId",
"TrackedLinks",
"TrackedLinksLinkMailingFormat"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "TrackedLinkMailingFormat",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "Text",
"value": "Text"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DkimInstallationStatus",
"optional": false,
"sampleValue": "Installed",
"deprecated": false,
"type": {
"id": "f3be26e1420500da064d7727466d1df8",
"name": "string",
"namespace": "ResponseDkimInstallationStatus",
"fullNamespace": [
"Post_AccountId",
"ResponseDkimInstallationStatus"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Installed",
"enumeration": {
"name": "DkimDomainInstallationStatus",
"options": [
{
"name": "Installed",
"value": "Installed"
},
{
"name": "InvalidKeyType",
"value": "InvalidKeyType"
},
{
"name": "InvalidVersion",
"value": "InvalidVersion"
},
{
"name": "NotQueried",
"value": "NotQueried"
},
{
"name": "PublicKeyMismatch",
"value": "PublicKeyMismatch"
},
{
"name": "PublicKeyNotFound",
"value": "PublicKeyNotFound"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AnnotationId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AnalyticsVendor",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "11cab89a73a4d467bc1b8d4470952c8a",
"name": "string",
"namespace": "ResponseAnalyticsVendor",
"fullNamespace": [
"Post_AccountId",
"ResponseAnalyticsVendor"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "GoogleAnalytics",
"enumeration": {
"name": "AnalyticsVendor",
"options": [
{
"name": "GoogleAnalytics",
"value": "GoogleAnalytics"
},
{
"name": "Matomo",
"value": "Matomo"
},
{
"name": "None",
"value": "None"
},
{
"name": "OpenWebAnalytics",
"value": "OpenWebAnalytics"
},
{
"name": "Oribi",
"value": "Oribi"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Mailings/Groups",
"comments": "Mailing group management.
", "endpoints": [ { "id": "d0d834bcb8688d9c5f80827505c3fdc4", "name": "", "comments": "Get all mailing groups.
", "methodName": "Get", "namespace": [ "Mailings", "Groups" ], "urlTemplate": "Mailings/Groups", "method": "GET", "urlParameters": [], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "accept", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "Groups",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Group",
"type": {
"id": "cb8e313f3e5d554650cb7933c7115e10",
"name": "Group",
"logicalName": "Response",
"namespace": "Get",
"fullNamespace": [
"Get"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "d1ea5a6e16e8acdd03387d3b0f8f759c",
"name": "",
"comments": "Create a mailing group.
", "methodName": "Post", "namespace": [ "Mailings", "Groups" ], "urlTemplate": "Mailings/Groups", "method": "POST", "urlParameters": [], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "cb7b29daa313275744793dcbb24ee6e9",
"name": "GroupProperties",
"logicalName": "Request",
"namespace": "Post",
"fullNamespace": [
"Post"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "e3f10e126ba9cefcffa0fd4bd98194c4",
"name": "Group",
"logicalName": "Response",
"namespace": "Post",
"fullNamespace": [
"Post"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "aa0082a70e91a0205ce18f22ee7dec4a",
"name": "",
"comments": "Get all mailing groups.
", "methodName": "Get_AccountId", "namespace": [ "Mailings", "Groups" ], "urlTemplate": "Mailings/Groups/{accountId}", "method": "GET", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "accept", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "Groups",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Group",
"type": {
"id": "cb8e313f3e5d554650cb7933c7115e10",
"name": "Group",
"logicalName": "Response",
"namespace": "Get_AccountId",
"fullNamespace": [
"Get_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "6ef6980ed019ac45f1fd2bdef6eff868",
"name": "",
"comments": "Create a mailing group.
", "methodName": "Post_AccountId", "namespace": [ "Mailings", "Groups" ], "urlTemplate": "Mailings/Groups/{accountId}", "method": "POST", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "cb7b29daa313275744793dcbb24ee6e9",
"name": "GroupProperties",
"logicalName": "Request",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "e3f10e126ba9cefcffa0fd4bd98194c4",
"name": "Group",
"logicalName": "Response",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "83d547f178c5462e2b98572e0886103f",
"name": "",
"comments": "Get all mailing groups.
", "methodName": "Get_AccountId_GroupId", "namespace": [ "Mailings", "Groups" ], "urlTemplate": "Mailings/Groups/{accountId}/{groupId}", "method": "GET", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "groupId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "accept", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "cb8e313f3e5d554650cb7933c7115e10",
"name": "Group",
"logicalName": "Response",
"namespace": "Get_AccountId_GroupId",
"fullNamespace": [
"Get_AccountId_GroupId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "554bcb847885112ba61e719784683ddf",
"name": "",
"comments": "Modify a mailing group.
", "methodName": "Put_AccountId_GroupId", "namespace": [ "Mailings", "Groups" ], "urlTemplate": "Mailings/Groups/{accountId}/{groupId}", "method": "PUT", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "groupId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "bd69691fde9aade8c65ad5af6d01deff",
"name": "GroupProperties",
"logicalName": "Request",
"namespace": "Put_AccountId_GroupId",
"fullNamespace": [
"Put_AccountId_GroupId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [],
"isBinary": false,
"hasBody": false
}
},
{
"id": "4f549981bddbd80c0edadf9df1b5b682",
"name": "",
"comments": "Delete a mailing group.
", "methodName": "Delete_AccountId_GroupId", "namespace": [ "Mailings", "Groups" ], "urlTemplate": "Mailings/Groups/{accountId}/{groupId}", "method": "DELETE", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "groupId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [], "isBinary": false, "hasBody": false }, "response": { "headers": [], "isBinary": false, "hasBody": false } }, { "id": "77634b094adc1aa7b42095b665f0ceae", "name": "", "comments": "Modify a mailing group.
", "methodName": "Put_GroupId", "namespace": [ "Mailings", "Groups" ], "urlTemplate": "Mailings/Groups/{groupId}", "method": "PUT", "urlParameters": [ { "name": "groupId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "bd69691fde9aade8c65ad5af6d01deff",
"name": "GroupProperties",
"logicalName": "Request",
"namespace": "Put_GroupId",
"fullNamespace": [
"Put_GroupId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [],
"isBinary": false,
"hasBody": false
}
},
{
"id": "81c73675df21004308d2c38b3129cad1",
"name": "",
"comments": "Delete a mailing group.
", "methodName": "Delete_GroupId", "namespace": [ "Mailings", "Groups" ], "urlTemplate": "Mailings/Groups/{groupId}", "method": "DELETE", "urlParameters": [ { "name": "groupId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [], "isBinary": false, "hasBody": false }, "response": { "headers": [], "isBinary": false, "hasBody": false } } ] } ] }, { "name": "Reports", "comments": "Reporting endpoint provides a comprehensive summary overview all aspects of sending and receiving emails measuring overall campaign effectiveness.
\nReporting components.
\napplication/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "ArrayOfAutoMessageSummaryModel",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageSummaryModel",
"type": {
"id": "333ce126bcffd67444b1ea25517fc9e6",
"name": "AutoMessageSummaryModel",
"logicalName": "Response",
"namespace": "Get",
"fullNamespace": [
"Get"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "ListId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ListName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MessageCount",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalRecipientCount",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ActiveRecipientCount",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Reports/AutoMessages/Detail",
"endpoints": [
{
"id": "ff939ae348a79fad5b5b07d4f000cd07",
"name": "",
"methodName": "Get_Detail_ListId",
"namespace": [
"Reports",
"AutoMessages",
"Detail"
],
"urlTemplate": "Reports/AutoMessages/Detail/{listId}",
"method": "GET",
"urlParameters": [
{
"name": "listId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "ArrayOfAutoMessageDetailModel",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "AutoMessageDetailModel",
"type": {
"id": "f08a18f2b68f99a1a14092bc1a0187e1",
"name": "AutoMessageDetailModel",
"logicalName": "Response",
"namespace": "Get_Detail_ListId",
"fullNamespace": [
"Get_Detail_ListId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "AutoMessageId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CampaignId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ListId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "RecipientsSent",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "RecipientsReceived",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "RecipientsRead",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OpenRate",
"optional": false,
"sampleValue": "0.00",
"deprecated": false,
"type": {
"name": "float",
"isNullable": false,
"isSimple": true,
"sampleValue": "0.00",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalClicks",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "UniqueClicks",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalBounces",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SoftBounces",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "HardBounces",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOuts",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SpamReports",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Reports/EasySmtp",
"endpoints": [
{
"id": "fc9e7c92a1791e57076b3b94047813d8",
"name": "",
"methodName": "Get_AccountId",
"namespace": [
"Reports",
"EasySmtp"
],
"urlTemplate": "Reports/EasySmtp/{accountId}",
"method": "GET",
"urlParameters": [
{
"name": "accountId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [
{
"name": "startdate",
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"multipleAllowed": false,
"required": false,
"isAuth": false
},
{
"name": "enddate",
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"multipleAllowed": false,
"required": false,
"isAuth": false
}
],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "Recipients",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Recipient",
"type": {
"id": "5d853da95e1febe05e033314e94e1ce9",
"name": "Recipient",
"logicalName": "Response",
"namespace": "Get_AccountId",
"fullNamespace": [
"Get_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "AccountId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "RecipientId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "UserId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "XCampaign",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "To",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Sender",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Subject",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ClickTracking",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Recipients",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "long",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Opens",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Clicks",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Bounces",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOuts",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SoftBounce",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "HardBounce",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SpamReport",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Suppressed",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionType",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "f97a4204e578c8d2f2e1f68d5bf291bc",
"name": "string",
"namespace": "ResponseSuppressionType",
"fullNamespace": [
"Get_AccountId",
"ResponseSuppressionType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "AccountOptOut",
"enumeration": {
"name": "SuppressionType",
"options": [
{
"name": "AccountOptOut",
"value": "AccountOptOut"
},
{
"name": "EscalatedBounce",
"value": "EscalatedBounce"
},
{
"name": "GlobalHardBounce",
"value": "GlobalHardBounce"
},
{
"name": "GlobalOptOut",
"value": "GlobalOptOut"
},
{
"name": "GlobalPatternOptOut",
"value": "GlobalPatternOptOut"
},
{
"name": "GlobalThreat",
"value": "GlobalThreat"
},
{
"name": "InvalidSyntax",
"value": "InvalidSyntax"
},
{
"name": "None",
"value": "None"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "7218d0c74bc23b4c5c5557b4eb960a04",
"name": "",
"methodName": "Post_AccountId",
"namespace": [
"Reports",
"EasySmtp"
],
"urlTemplate": "Reports/EasySmtp/{accountId}",
"method": "POST",
"urlParameters": [
{
"name": "accountId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "802be9ba1e5f671e54a5641cf87a4de7",
"name": "RecipientFilter",
"logicalName": "Request",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "NewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "Recipients",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Recipient",
"type": {
"id": "5d853da95e1febe05e033314e94e1ce9",
"name": "Recipient",
"logicalName": "Response",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "AccountId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "RecipientId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "UserId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "XCampaign",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "To",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Sender",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Subject",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ClickTracking",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Recipients",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "long",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Opens",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Clicks",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Bounces",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOuts",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SoftBounce",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "HardBounce",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SpamReport",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Suppressed",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionType",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "f97a4204e578c8d2f2e1f68d5bf291bc",
"name": "string",
"namespace": "ResponseSuppressionType",
"fullNamespace": [
"Post_AccountId",
"ResponseSuppressionType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "AccountOptOut",
"enumeration": {
"name": "SuppressionType",
"options": [
{
"name": "AccountOptOut",
"value": "AccountOptOut"
},
{
"name": "EscalatedBounce",
"value": "EscalatedBounce"
},
{
"name": "GlobalHardBounce",
"value": "GlobalHardBounce"
},
{
"name": "GlobalOptOut",
"value": "GlobalOptOut"
},
{
"name": "GlobalPatternOptOut",
"value": "GlobalPatternOptOut"
},
{
"name": "GlobalThreat",
"value": "GlobalThreat"
},
{
"name": "InvalidSyntax",
"value": "InvalidSyntax"
},
{
"name": "None",
"value": "None"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "a6fe969a980b98eebaa424d43177a537",
"name": "",
"methodName": "Get_AccountId_RecipientId",
"namespace": [
"Reports",
"EasySmtp"
],
"urlTemplate": "Reports/EasySmtp/{accountId}/{recipientId}",
"method": "GET",
"urlParameters": [
{
"name": "accountId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
},
{
"name": "recipientId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "5d853da95e1febe05e033314e94e1ce9",
"name": "Recipient",
"logicalName": "Response",
"namespace": "Get_AccountId_RecipientId",
"fullNamespace": [
"Get_AccountId_RecipientId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "AccountId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "RecipientId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "UserId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "XCampaign",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "To",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Sender",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Subject",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ClickTracking",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Recipients",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "long",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Opens",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Clicks",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Bounces",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOuts",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SoftBounce",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "HardBounce",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SpamReport",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Suppressed",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionType",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "f97a4204e578c8d2f2e1f68d5bf291bc",
"name": "string",
"namespace": "ResponseSuppressionType",
"fullNamespace": [
"Get_AccountId_RecipientId",
"ResponseSuppressionType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "AccountOptOut",
"enumeration": {
"name": "SuppressionType",
"options": [
{
"name": "AccountOptOut",
"value": "AccountOptOut"
},
{
"name": "EscalatedBounce",
"value": "EscalatedBounce"
},
{
"name": "GlobalHardBounce",
"value": "GlobalHardBounce"
},
{
"name": "GlobalOptOut",
"value": "GlobalOptOut"
},
{
"name": "GlobalPatternOptOut",
"value": "GlobalPatternOptOut"
},
{
"name": "GlobalThreat",
"value": "GlobalThreat"
},
{
"name": "InvalidSyntax",
"value": "InvalidSyntax"
},
{
"name": "None",
"value": "None"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Reports/EasySmtp/Bounces",
"endpoints": [
{
"id": "0384cd2c1390f1eccbcf090f7e7e18de",
"name": "",
"methodName": "Get_AccountId",
"namespace": [
"Reports",
"EasySmtp",
"Bounces"
],
"urlTemplate": "Reports/EasySmtp/Bounces/{accountId}",
"method": "GET",
"urlParameters": [
{
"name": "accountId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [
{
"name": "startdate",
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"multipleAllowed": false,
"required": false,
"isAuth": false
},
{
"name": "enddate",
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"multipleAllowed": false,
"required": false,
"isAuth": false
}
],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "Bounces",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Bounce",
"type": {
"id": "86be67f32e1057d7a734d491ec67622c",
"name": "Bounce",
"logicalName": "Response",
"namespace": "Get_AccountId",
"fullNamespace": [
"Get_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "RecipientId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Email",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CampaignName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Code",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Diagnostic",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Timestamp",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "6a717b4cf34e460ae1a0e42a511c5236",
"name": "",
"methodName": "Post_AccountId",
"namespace": [
"Reports",
"EasySmtp",
"Bounces"
],
"urlTemplate": "Reports/EasySmtp/Bounces/{accountId}",
"method": "POST",
"urlParameters": [
{
"name": "accountId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "281bc830fea9d54f4ad99a0c539559af",
"name": "BounceFilter",
"logicalName": "Request",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "NewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "Bounces",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Bounce",
"type": {
"id": "86be67f32e1057d7a734d491ec67622c",
"name": "Bounce",
"logicalName": "Response",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "RecipientId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Email",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CampaignName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Code",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Diagnostic",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Timestamp",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "08cf8cc5f48e14226051ef4a302a9720",
"name": "",
"methodName": "Get_AccountId_RecipientId",
"namespace": [
"Reports",
"EasySmtp",
"Bounces"
],
"urlTemplate": "Reports/EasySmtp/Bounces/{accountId}/{recipientId}",
"method": "GET",
"urlParameters": [
{
"name": "accountId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
},
{
"name": "recipientId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "86be67f32e1057d7a734d491ec67622c",
"name": "Bounce",
"logicalName": "Response",
"namespace": "Get_AccountId_RecipientId",
"fullNamespace": [
"Get_AccountId_RecipientId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "RecipientId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Email",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CampaignName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Code",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Diagnostic",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Timestamp",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Reports/EasySmtp/Clicks",
"endpoints": [
{
"id": "274ebf260b89916441843aa53e0c421d",
"name": "",
"methodName": "Get_AccountId",
"namespace": [
"Reports",
"EasySmtp",
"Clicks"
],
"urlTemplate": "Reports/EasySmtp/Clicks/{accountId}",
"method": "GET",
"urlParameters": [
{
"name": "accountId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [
{
"name": "startdate",
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"multipleAllowed": false,
"required": false,
"isAuth": false
},
{
"name": "enddate",
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"multipleAllowed": false,
"required": false,
"isAuth": false
}
],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "Clicks",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Click",
"type": {
"id": "d0c2cd5adcd129fb3c3748b492cc1179",
"name": "Click",
"logicalName": "Response",
"namespace": "Get_AccountId",
"fullNamespace": [
"Get_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "RecipientId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LinkId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Email",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CampaignName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Url",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Timestamp",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Browser",
"optional": false,
"sampleValue": "Firefox",
"deprecated": false,
"type": {
"id": "3dcc055704572316267cdf12d9fd9d86",
"name": "Browser",
"namespace": "ResponseBrowser",
"fullNamespace": [
"Get_AccountId",
"ResponseBrowser"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Chrome",
"enumeration": {
"name": "Browser",
"options": [
{
"name": "Chrome",
"value": "Chrome"
},
{
"name": "Firefox",
"value": "Firefox"
},
{
"name": "InternetExplorer",
"value": "InternetExplorer"
},
{
"name": "Opera",
"value": "Opera"
},
{
"name": "Other",
"value": "Other"
},
{
"name": "Safari",
"value": "Safari"
},
{
"name": "SeaMonkey",
"value": "SeaMonkey"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Platform",
"optional": false,
"sampleValue": "Desktop",
"deprecated": false,
"type": {
"id": "93e70853c1b071f3b6f619dacd83b44b",
"name": "Platform",
"namespace": "ResponsePlatform",
"fullNamespace": [
"Get_AccountId",
"ResponsePlatform"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Desktop",
"enumeration": {
"name": "Platform",
"options": [
{
"name": "Desktop",
"value": "Desktop"
},
{
"name": "Mobile",
"value": "Mobile"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Device",
"optional": false,
"sampleValue": "Android",
"deprecated": false,
"type": {
"id": "f7e38a52d2b6bba556017b2778a17b78",
"name": "Device",
"namespace": "ResponseDevice",
"fullNamespace": [
"Get_AccountId",
"ResponseDevice"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Android",
"enumeration": {
"name": "Device",
"options": [
{
"name": "Android",
"value": "Android"
},
{
"name": "Blackberry",
"value": "Blackberry"
},
{
"name": "iPad",
"value": "iPad"
},
{
"name": "iPhone",
"value": "iPhone"
},
{
"name": "Other",
"value": "Other"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "69c44d1c13353fbd9b2793ce213804f8",
"name": "",
"methodName": "Post_AccountId",
"namespace": [
"Reports",
"EasySmtp",
"Clicks"
],
"urlTemplate": "Reports/EasySmtp/Clicks/{accountId}",
"method": "POST",
"urlParameters": [
{
"name": "accountId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "f1a67a0da008773f8cd9ee46f8d010af",
"name": "ClickFilter",
"logicalName": "Request",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "NewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "Clicks",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Click",
"type": {
"id": "d0c2cd5adcd129fb3c3748b492cc1179",
"name": "Click",
"logicalName": "Response",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "RecipientId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LinkId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Email",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CampaignName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Url",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Timestamp",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Browser",
"optional": false,
"sampleValue": "Firefox",
"deprecated": false,
"type": {
"id": "3dcc055704572316267cdf12d9fd9d86",
"name": "Browser",
"namespace": "ResponseBrowser",
"fullNamespace": [
"Post_AccountId",
"ResponseBrowser"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Chrome",
"enumeration": {
"name": "Browser",
"options": [
{
"name": "Chrome",
"value": "Chrome"
},
{
"name": "Firefox",
"value": "Firefox"
},
{
"name": "InternetExplorer",
"value": "InternetExplorer"
},
{
"name": "Opera",
"value": "Opera"
},
{
"name": "Other",
"value": "Other"
},
{
"name": "Safari",
"value": "Safari"
},
{
"name": "SeaMonkey",
"value": "SeaMonkey"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Platform",
"optional": false,
"sampleValue": "Desktop",
"deprecated": false,
"type": {
"id": "93e70853c1b071f3b6f619dacd83b44b",
"name": "Platform",
"namespace": "ResponsePlatform",
"fullNamespace": [
"Post_AccountId",
"ResponsePlatform"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Desktop",
"enumeration": {
"name": "Platform",
"options": [
{
"name": "Desktop",
"value": "Desktop"
},
{
"name": "Mobile",
"value": "Mobile"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Device",
"optional": false,
"sampleValue": "Android",
"deprecated": false,
"type": {
"id": "f7e38a52d2b6bba556017b2778a17b78",
"name": "Device",
"namespace": "ResponseDevice",
"fullNamespace": [
"Post_AccountId",
"ResponseDevice"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Android",
"enumeration": {
"name": "Device",
"options": [
{
"name": "Android",
"value": "Android"
},
{
"name": "Blackberry",
"value": "Blackberry"
},
{
"name": "iPad",
"value": "iPad"
},
{
"name": "iPhone",
"value": "iPhone"
},
{
"name": "Other",
"value": "Other"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "6797093821b0a0d52d487b922b203ab7",
"name": "",
"methodName": "Get_AccountId_LinkId",
"namespace": [
"Reports",
"EasySmtp",
"Clicks"
],
"urlTemplate": "Reports/EasySmtp/Clicks/{accountId}/{linkId}",
"method": "GET",
"urlParameters": [
{
"name": "accountId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
},
{
"name": "linkId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "Clicks",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Click",
"type": {
"id": "d0c2cd5adcd129fb3c3748b492cc1179",
"name": "Click",
"logicalName": "Response",
"namespace": "Get_AccountId_LinkId",
"fullNamespace": [
"Get_AccountId_LinkId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "RecipientId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LinkId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Email",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CampaignName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Url",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Timestamp",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Browser",
"optional": false,
"sampleValue": "Firefox",
"deprecated": false,
"type": {
"id": "3dcc055704572316267cdf12d9fd9d86",
"name": "Browser",
"namespace": "ResponseBrowser",
"fullNamespace": [
"Get_AccountId_LinkId",
"ResponseBrowser"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Chrome",
"enumeration": {
"name": "Browser",
"options": [
{
"name": "Chrome",
"value": "Chrome"
},
{
"name": "Firefox",
"value": "Firefox"
},
{
"name": "InternetExplorer",
"value": "InternetExplorer"
},
{
"name": "Opera",
"value": "Opera"
},
{
"name": "Other",
"value": "Other"
},
{
"name": "Safari",
"value": "Safari"
},
{
"name": "SeaMonkey",
"value": "SeaMonkey"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Platform",
"optional": false,
"sampleValue": "Desktop",
"deprecated": false,
"type": {
"id": "93e70853c1b071f3b6f619dacd83b44b",
"name": "Platform",
"namespace": "ResponsePlatform",
"fullNamespace": [
"Get_AccountId_LinkId",
"ResponsePlatform"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Desktop",
"enumeration": {
"name": "Platform",
"options": [
{
"name": "Desktop",
"value": "Desktop"
},
{
"name": "Mobile",
"value": "Mobile"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Device",
"optional": false,
"sampleValue": "Android",
"deprecated": false,
"type": {
"id": "f7e38a52d2b6bba556017b2778a17b78",
"name": "Device",
"namespace": "ResponseDevice",
"fullNamespace": [
"Get_AccountId_LinkId",
"ResponseDevice"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Android",
"enumeration": {
"name": "Device",
"options": [
{
"name": "Android",
"value": "Android"
},
{
"name": "Blackberry",
"value": "Blackberry"
},
{
"name": "iPad",
"value": "iPad"
},
{
"name": "iPhone",
"value": "iPhone"
},
{
"name": "Other",
"value": "Other"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Reports/EasySmtp/Opens",
"endpoints": [
{
"id": "a220b160cc1cb10704dd2598a1667d89",
"name": "",
"methodName": "Get_AccountId",
"namespace": [
"Reports",
"EasySmtp",
"Opens"
],
"urlTemplate": "Reports/EasySmtp/Opens/{accountId}",
"method": "GET",
"urlParameters": [
{
"name": "accountId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [
{
"name": "startdate",
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"multipleAllowed": false,
"required": false,
"isAuth": false
},
{
"name": "enddate",
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"multipleAllowed": false,
"required": false,
"isAuth": false
}
],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "Opens",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Open",
"type": {
"id": "d544212477946d0fce98a07814a1bf22",
"name": "Open",
"logicalName": "Response",
"namespace": "Get_AccountId",
"fullNamespace": [
"Get_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "RecipientId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Email",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CampaignName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Timestamp",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Browser",
"optional": false,
"sampleValue": "Firefox",
"deprecated": false,
"type": {
"id": "3dcc055704572316267cdf12d9fd9d86",
"name": "Browser",
"namespace": "ResponseBrowser",
"fullNamespace": [
"Get_AccountId",
"ResponseBrowser"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Chrome",
"enumeration": {
"name": "Browser",
"options": [
{
"name": "Chrome",
"value": "Chrome"
},
{
"name": "Firefox",
"value": "Firefox"
},
{
"name": "InternetExplorer",
"value": "InternetExplorer"
},
{
"name": "Opera",
"value": "Opera"
},
{
"name": "Other",
"value": "Other"
},
{
"name": "Safari",
"value": "Safari"
},
{
"name": "SeaMonkey",
"value": "SeaMonkey"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Platform",
"optional": false,
"sampleValue": "Desktop",
"deprecated": false,
"type": {
"id": "93e70853c1b071f3b6f619dacd83b44b",
"name": "Platform",
"namespace": "ResponsePlatform",
"fullNamespace": [
"Get_AccountId",
"ResponsePlatform"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Desktop",
"enumeration": {
"name": "Platform",
"options": [
{
"name": "Desktop",
"value": "Desktop"
},
{
"name": "Mobile",
"value": "Mobile"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Device",
"optional": false,
"sampleValue": "Android",
"deprecated": false,
"type": {
"id": "f7e38a52d2b6bba556017b2778a17b78",
"name": "Device",
"namespace": "ResponseDevice",
"fullNamespace": [
"Get_AccountId",
"ResponseDevice"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Android",
"enumeration": {
"name": "Device",
"options": [
{
"name": "Android",
"value": "Android"
},
{
"name": "Blackberry",
"value": "Blackberry"
},
{
"name": "iPad",
"value": "iPad"
},
{
"name": "iPhone",
"value": "iPhone"
},
{
"name": "Other",
"value": "Other"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "04e64dbfe5846f496dcb464ee43c0a9a",
"name": "",
"methodName": "Post_AccountId",
"namespace": [
"Reports",
"EasySmtp",
"Opens"
],
"urlTemplate": "Reports/EasySmtp/Opens/{accountId}",
"method": "POST",
"urlParameters": [
{
"name": "accountId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "c273606a1f802777fe9cb448faa35fcf",
"name": "OpenFilter",
"logicalName": "Request",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "NewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "Opens",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Open",
"type": {
"id": "d544212477946d0fce98a07814a1bf22",
"name": "Open",
"logicalName": "Response",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "RecipientId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Email",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CampaignName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Timestamp",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Browser",
"optional": false,
"sampleValue": "Firefox",
"deprecated": false,
"type": {
"id": "3dcc055704572316267cdf12d9fd9d86",
"name": "Browser",
"namespace": "ResponseBrowser",
"fullNamespace": [
"Post_AccountId",
"ResponseBrowser"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Chrome",
"enumeration": {
"name": "Browser",
"options": [
{
"name": "Chrome",
"value": "Chrome"
},
{
"name": "Firefox",
"value": "Firefox"
},
{
"name": "InternetExplorer",
"value": "InternetExplorer"
},
{
"name": "Opera",
"value": "Opera"
},
{
"name": "Other",
"value": "Other"
},
{
"name": "Safari",
"value": "Safari"
},
{
"name": "SeaMonkey",
"value": "SeaMonkey"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Platform",
"optional": false,
"sampleValue": "Desktop",
"deprecated": false,
"type": {
"id": "93e70853c1b071f3b6f619dacd83b44b",
"name": "Platform",
"namespace": "ResponsePlatform",
"fullNamespace": [
"Post_AccountId",
"ResponsePlatform"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Desktop",
"enumeration": {
"name": "Platform",
"options": [
{
"name": "Desktop",
"value": "Desktop"
},
{
"name": "Mobile",
"value": "Mobile"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Device",
"optional": false,
"sampleValue": "Android",
"deprecated": false,
"type": {
"id": "f7e38a52d2b6bba556017b2778a17b78",
"name": "Device",
"namespace": "ResponseDevice",
"fullNamespace": [
"Post_AccountId",
"ResponseDevice"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Android",
"enumeration": {
"name": "Device",
"options": [
{
"name": "Android",
"value": "Android"
},
{
"name": "Blackberry",
"value": "Blackberry"
},
{
"name": "iPad",
"value": "iPad"
},
{
"name": "iPhone",
"value": "iPhone"
},
{
"name": "Other",
"value": "Other"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "ba83ee5ccf11c310f5ab59776b6cb9de",
"name": "",
"methodName": "Get_AccountId_RecipientId",
"namespace": [
"Reports",
"EasySmtp",
"Opens"
],
"urlTemplate": "Reports/EasySmtp/Opens/{accountId}/{recipientId}",
"method": "GET",
"urlParameters": [
{
"name": "accountId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
},
{
"name": "recipientId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "Opens",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Open",
"type": {
"id": "d544212477946d0fce98a07814a1bf22",
"name": "Open",
"logicalName": "Response",
"namespace": "Get_AccountId_RecipientId",
"fullNamespace": [
"Get_AccountId_RecipientId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "RecipientId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Email",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CampaignName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Timestamp",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Browser",
"optional": false,
"sampleValue": "Firefox",
"deprecated": false,
"type": {
"id": "3dcc055704572316267cdf12d9fd9d86",
"name": "Browser",
"namespace": "ResponseBrowser",
"fullNamespace": [
"Get_AccountId_RecipientId",
"ResponseBrowser"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Chrome",
"enumeration": {
"name": "Browser",
"options": [
{
"name": "Chrome",
"value": "Chrome"
},
{
"name": "Firefox",
"value": "Firefox"
},
{
"name": "InternetExplorer",
"value": "InternetExplorer"
},
{
"name": "Opera",
"value": "Opera"
},
{
"name": "Other",
"value": "Other"
},
{
"name": "Safari",
"value": "Safari"
},
{
"name": "SeaMonkey",
"value": "SeaMonkey"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Platform",
"optional": false,
"sampleValue": "Desktop",
"deprecated": false,
"type": {
"id": "93e70853c1b071f3b6f619dacd83b44b",
"name": "Platform",
"namespace": "ResponsePlatform",
"fullNamespace": [
"Get_AccountId_RecipientId",
"ResponsePlatform"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Desktop",
"enumeration": {
"name": "Platform",
"options": [
{
"name": "Desktop",
"value": "Desktop"
},
{
"name": "Mobile",
"value": "Mobile"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Device",
"optional": false,
"sampleValue": "Android",
"deprecated": false,
"type": {
"id": "f7e38a52d2b6bba556017b2778a17b78",
"name": "Device",
"namespace": "ResponseDevice",
"fullNamespace": [
"Get_AccountId_RecipientId",
"ResponseDevice"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Android",
"enumeration": {
"name": "Device",
"options": [
{
"name": "Android",
"value": "Android"
},
{
"name": "Blackberry",
"value": "Blackberry"
},
{
"name": "iPad",
"value": "iPad"
},
{
"name": "iPhone",
"value": "iPhone"
},
{
"name": "Other",
"value": "Other"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Reports/EasySmtp/OptOuts",
"endpoints": [
{
"id": "4b18edd1f2ec10056be0a8da000ff6d9",
"name": "",
"methodName": "Get_AccountId",
"namespace": [
"Reports",
"EasySmtp",
"OptOuts"
],
"urlTemplate": "Reports/EasySmtp/OptOuts/{accountId}",
"method": "GET",
"urlParameters": [
{
"name": "accountId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [
{
"name": "startdate",
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"multipleAllowed": false,
"required": false,
"isAuth": false
},
{
"name": "enddate",
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"multipleAllowed": false,
"required": false,
"isAuth": false
}
],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "OptOuts",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "OptOut",
"type": {
"id": "805b0fefc8e7aa9987f52e2c9fa2acc2",
"name": "OptOut",
"logicalName": "Response",
"namespace": "Get_AccountId",
"fullNamespace": [
"Get_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "RecipientId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Email",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CampaignName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Type",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Timestamp",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "932fcac1c9cd300d9a7352704071f120",
"name": "",
"methodName": "Post_AccountId",
"namespace": [
"Reports",
"EasySmtp",
"OptOuts"
],
"urlTemplate": "Reports/EasySmtp/OptOuts/{accountId}",
"method": "POST",
"urlParameters": [
{
"name": "accountId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "cb34da431ee1a6361fa241bae5c6ea81",
"name": "OptOutFilter",
"logicalName": "Request",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "NewerThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OlderThan",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "OptOuts",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "OptOut",
"type": {
"id": "805b0fefc8e7aa9987f52e2c9fa2acc2",
"name": "OptOut",
"logicalName": "Response",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "RecipientId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Email",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CampaignName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Type",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Timestamp",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "774333848ad8eea9a80be93b5ba785f6",
"name": "",
"methodName": "Get_AccountId_RecipientId",
"namespace": [
"Reports",
"EasySmtp",
"OptOuts"
],
"urlTemplate": "Reports/EasySmtp/OptOuts/{accountId}/{recipientId}",
"method": "GET",
"urlParameters": [
{
"name": "accountId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
},
{
"name": "recipientId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "805b0fefc8e7aa9987f52e2c9fa2acc2",
"name": "OptOut",
"logicalName": "Response",
"namespace": "Get_AccountId_RecipientId",
"fullNamespace": [
"Get_AccountId_RecipientId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "RecipientId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Email",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CampaignName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Type",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Timestamp",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Reports/Mailings/Bounces/Detail",
"comments": "Bounce reports.
", "endpoints": [ { "id": "290c4e6b77a5949daf89424c93a49c35", "name": "", "comments": "Report on bounces.
", "methodName": "Post_AccountId_CampaignId", "namespace": [ "Reports", "Mailings", "Bounces", "Detail" ], "urlTemplate": "Reports/Mailings/Bounces/Detail/{accountId}/{campaignId}", "method": "POST", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "campaignId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "9b55d032ab9201af4be0039cec9d9399",
"name": "DetailReportFilter",
"logicalName": "Request",
"namespace": "Post_AccountId_CampaignId",
"fullNamespace": [
"Post_AccountId_CampaignId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "MailingListId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FilterStartDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FilterEndDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BounceFilter",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "01e5d247b3b1d31d25ef0069029f8647",
"name": "BounceFilter",
"logicalName": "BounceFilter",
"namespace": "BounceFilter",
"fullNamespace": [
"Post_AccountId_CampaignId",
"BounceFilter"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "BounceSeverity",
"optional": true,
"sampleValue": "Hard",
"deprecated": false,
"type": {
"id": "00d9c898abda5d6f4dd78dc8e1ce7102",
"name": "string",
"namespace": "BounceFilterBounceSeverity",
"fullNamespace": [
"Post_AccountId_CampaignId",
"BounceFilter",
"BounceFilterBounceSeverity"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "Hard",
"enumeration": {
"name": "BounceSeverity",
"options": [
{
"name": "Hard",
"value": "Hard"
},
{
"name": "None",
"value": "None"
},
{
"name": "Soft",
"value": "Soft"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BounceTypeAbbreviation",
"optional": true,
"sampleValue": "NB",
"deprecated": false,
"type": {
"id": "f6ca7bed8b79fde2af8e07ec257c15db",
"name": "string",
"namespace": "BounceFilterBounceTypeAbbreviation",
"fullNamespace": [
"Post_AccountId_CampaignId",
"BounceFilter",
"BounceFilterBounceTypeAbbreviation"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "AR",
"enumeration": {
"name": "BounceCodes",
"options": [
{
"name": "AR",
"value": "AR",
"comments": "AUTO REPLY - (ie. Out Of Office)"
},
{
"name": "BN",
"value": "BN",
"comments": "BOUNCE - NO EMAIL ADDRESS."
},
{
"name": "CR",
"value": "CR",
"comments": "CHALLENGE-RESPONSE"
},
{
"name": "GB",
"value": "GB",
"comments": "GENERAL BOUNCE"
},
{
"name": "HB",
"value": "HB",
"comments": "HARD BOUNCE - (ie. User Unknown)"
},
{
"name": "MB",
"value": "MB",
"comments": "MAIL BLOCK - General"
},
{
"name": "MBAD",
"value": "MBAD",
"comments": "MAIL BLOCK - Attachment Detected"
},
{
"name": "MBKS",
"value": "MBKS",
"comments": "MAIL BLOCK - Known Spammer"
},
{
"name": "MBRD",
"value": "MBRD",
"comments": "MAIL BLOCK - Relay Denied"
},
{
"name": "MBSD",
"value": "MBSD",
"comments": "MAIL BLOCK - Spam Detected"
},
{
"name": "NB",
"value": "NB",
"comments": "UNDETERMINED - (ie. Recipient Reply)"
},
{
"name": "SB",
"value": "SB",
"comments": "SOFT BOUNCE - General"
},
{
"name": "SBAF",
"value": "SBAF",
"comments": "SOFT BOUNCE - Authentication Failed"
},
{
"name": "SBDF",
"value": "SBDF",
"comments": "SOFT BOUNCE - DNS Failure"
},
{
"name": "SBMF",
"value": "SBMF",
"comments": "SOFT BOUNCE - Mailbox Full"
},
{
"name": "SBMS",
"value": "SBMS",
"comments": "SOFT BOUNCE - Message Too Large"
},
{
"name": "SBRE",
"value": "SBRE",
"comments": "SOFT BOUNCE - Retries Exceeded"
},
{
"name": "SR",
"value": "SR",
"comments": "SUBSCRIBE Request"
},
{
"name": "TB",
"value": "TB",
"comments": "TRANSIENT BOUNCE"
},
{
"name": "UR",
"value": "UR",
"comments": "UNSUBSCRIBE/REMOVE Request"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "BounceDetails",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "BounceDetail",
"type": {
"id": "5c41639afaecafe2091621479b097534",
"name": "BounceDetail",
"logicalName": "Response",
"namespace": "Post_AccountId_CampaignId",
"fullNamespace": [
"Post_AccountId_CampaignId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "BounceDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "BounceType",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "d5c391590c35b4a02107777d3419fbcc",
"name": "BounceType",
"logicalName": "BounceType",
"namespace": "BounceType",
"fullNamespace": [
"Post_AccountId_CampaignId",
"BounceType"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Abbreviation",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LongDescription",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ShortDescription",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Severity",
"optional": false,
"sampleValue": "Hard",
"deprecated": false,
"type": {
"id": "7efe3e1cf4aea11626d780867d862524",
"name": "BounceSeverity",
"namespace": "BounceTypeSeverity",
"fullNamespace": [
"Post_AccountId_CampaignId",
"BounceType",
"BounceTypeSeverity"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Hard",
"enumeration": {
"name": "BounceSeverity",
"options": [
{
"name": "Hard",
"value": "Hard"
},
{
"name": "None",
"value": "None"
},
{
"name": "Soft",
"value": "Soft"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "Recipient",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "0b49c6029787b70c10b589163a36dc84",
"name": "RecipientModel",
"logicalName": "Recipient",
"namespace": "Recipient",
"fullNamespace": [
"Post_AccountId_CampaignId",
"Recipient"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "EmailAddress",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Active",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EmailFormatPreference",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "2d0855170510caa5ee9b0e2a55c3e337",
"name": "EmailFormatPreference",
"namespace": "RecipientEmailFormatPreference",
"fullNamespace": [
"Post_AccountId_CampaignId",
"Recipient",
"RecipientEmailFormatPreference"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "EmailFormatPreference",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "None",
"value": "None"
},
{
"name": "Text",
"value": "Text"
},
{
"name": "TextAndHtml",
"value": "TextAndHtml"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "RecipientProperties",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "RecipientProperties",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Property",
"type": {
"id": "817d4fa0f2f256418bfd02b5bfcf0bdf",
"name": "Property",
"logicalName": "RecipientProperties",
"namespace": "RecipientProperties",
"fullNamespace": [
"Post_AccountId_CampaignId",
"Recipient",
"RecipientProperties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Value",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Reports/Mailings/Detail",
"endpoints": [
{
"id": "1e18a11a5cf14c7114e51c5111c5737b",
"name": "",
"comments": "Report on multiple mailings.
", "methodName": "Post_AccountId", "namespace": [ "Reports", "Mailings", "Detail" ], "urlTemplate": "Reports/Mailings/Detail/{accountId}", "method": "POST", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "78abe6d3d34544b90e95df1673843cb8",
"name": "MailingReportFilter",
"logicalName": "Request",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "MailingId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CampaignType",
"optional": true,
"sampleValue": "Standard",
"deprecated": false,
"type": {
"id": "1fb67abdf62922584eef02c99d16be45",
"name": "string",
"namespace": "RequestCampaignType",
"fullNamespace": [
"Post_AccountId",
"RequestCampaignType"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "AbSplit",
"enumeration": {
"name": "CampaignType",
"options": [
{
"name": "AbSplit",
"value": "AbSplit"
},
{
"name": "AutoMessage",
"value": "AutoMessage"
},
{
"name": "Autoresponder",
"value": "Autoresponder"
},
{
"name": "Journey",
"value": "Journey"
},
{
"name": "ListWarming",
"value": "ListWarming"
},
{
"name": "Optimized",
"value": "Optimized"
},
{
"name": "OptimizedListWarming",
"value": "OptimizedListWarming"
},
{
"name": "SafeNotify",
"value": "SafeNotify"
},
{
"name": "Standard",
"value": "Standard"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "StartIndex",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MaxResults",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ScheduledDeliveryOnOrAfter",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ScheduledDeliveryOnOrBefore",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MessageId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ListId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "GroupId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "MailingReports",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "MailingReport",
"type": {
"id": "5cdcc9a2d30290562117b3020e77334c",
"name": "MailingReport",
"logicalName": "Response",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "MailingId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AccountId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ScheduledDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ScheduledDeliveryDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DeliveredDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Approved",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ApprovedBy",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CreatedBy",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ModifiedBy",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Message",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "30c1fe47073b7114cf43eec96d75c823",
"name": "Message",
"logicalName": "Message",
"namespace": "Message",
"fullNamespace": [
"Post_AccountId",
"Message"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "MailingId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MessageId",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MessageFormat",
"optional": false,
"sampleValue": "Text",
"deprecated": false,
"type": {
"id": "2a042d91d89e4d5bde38b6e0619cc96e",
"name": "MailingFormat",
"namespace": "MessageMessageFormat",
"fullNamespace": [
"Post_AccountId",
"Message",
"MessageMessageFormat"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "MailingFormat",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "Text",
"value": "Text"
},
{
"name": "TextAndHtml",
"value": "TextAndHtml"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Subject",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FromName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FromAddress",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ReplyToAddress",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ContentHtml",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ContentText",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AttachmentFile",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "Lists",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Lists",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "MailingListReport",
"type": {
"id": "aa1762463be2b2be948f886a519de786",
"name": "MailingListReport",
"logicalName": "Lists",
"namespace": "Lists",
"fullNamespace": [
"Post_AccountId",
"Lists"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "MailingListId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailingId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AccountId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DeliveredDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ListName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "RecipientCount",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "d5d9316435688d34115de0a5477e87ea",
"name": "RecipientSummary",
"logicalName": "RecipientCount",
"namespace": "RecipientCount",
"fullNamespace": [
"Post_AccountId",
"Lists",
"RecipientCount"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Active",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Text",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Html",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TextAndHtml",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Bounce",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "HardBounce",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOut",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Expected",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Sent",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Suppressed",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Received",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SoftBounce",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SpamReport",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Opens",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Openers",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OpensMobile",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OpenersMobile",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OpensDesktop",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OpenersDesktop",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Total",
"comments": "Deprecated Property",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Read",
"comments": "Deprecated Property",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ViewsMobile",
"comments": "Deprecated Property",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ViewsDesktop",
"comments": "Deprecated Property",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "ForwardSummary",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "dde8317ee48a8d029870841945fa5c3a",
"name": "Forwards",
"logicalName": "ForwardSummary",
"namespace": "ForwardSummary",
"fullNamespace": [
"Post_AccountId",
"Lists",
"ForwardSummary"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Total",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SendToFriend",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Facebook",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Twitter",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MySpace",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LinkedIn",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "GoogleBuzz",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TotalLists",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FirstListDeliveredDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastListDeliveredDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "RecipientSummary",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "d5d9316435688d34115de0a5477e87ea",
"name": "RecipientSummary",
"logicalName": "RecipientSummary",
"namespace": "RecipientSummary",
"fullNamespace": [
"Post_AccountId",
"RecipientSummary"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Active",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Text",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Html",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TextAndHtml",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Bounce",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "HardBounce",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOut",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Expected",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Sent",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Suppressed",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Received",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SoftBounce",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SpamReport",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Opens",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Openers",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OpensMobile",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OpenersMobile",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OpensDesktop",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OpenersDesktop",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Total",
"comments": "Deprecated Property",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Read",
"comments": "Deprecated Property",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ViewsMobile",
"comments": "Deprecated Property",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ViewsDesktop",
"comments": "Deprecated Property",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "ForwardSummary",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "dde8317ee48a8d029870841945fa5c3a",
"name": "Forwards",
"logicalName": "ForwardSummary",
"namespace": "ForwardSummary",
"fullNamespace": [
"Post_AccountId",
"ForwardSummary"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Total",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SendToFriend",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Facebook",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Twitter",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MySpace",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LinkedIn",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "GoogleBuzz",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "120dcadc2d14df491926baa868169aa3",
"name": "",
"comments": "Report on a individual mailing.
", "methodName": "Get_AccountId_CampaignId", "namespace": [ "Reports", "Mailings", "Detail" ], "urlTemplate": "Reports/Mailings/Detail/{accountId}/{campaignId}", "method": "GET", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "campaignId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "accept", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "5cdcc9a2d30290562117b3020e77334c",
"name": "MailingReport",
"logicalName": "Response",
"namespace": "Get_AccountId_CampaignId",
"fullNamespace": [
"Get_AccountId_CampaignId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "MailingId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AccountId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ScheduledDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ScheduledDeliveryDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DeliveredDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Approved",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ApprovedBy",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CreatedBy",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ModifiedBy",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Message",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "30c1fe47073b7114cf43eec96d75c823",
"name": "Message",
"logicalName": "Message",
"namespace": "Message",
"fullNamespace": [
"Get_AccountId_CampaignId",
"Message"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "MailingId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MessageId",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MessageFormat",
"optional": false,
"sampleValue": "Text",
"deprecated": false,
"type": {
"id": "2a042d91d89e4d5bde38b6e0619cc96e",
"name": "MailingFormat",
"namespace": "MessageMessageFormat",
"fullNamespace": [
"Get_AccountId_CampaignId",
"Message",
"MessageMessageFormat"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "MailingFormat",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "Text",
"value": "Text"
},
{
"name": "TextAndHtml",
"value": "TextAndHtml"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Subject",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FromName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FromAddress",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ReplyToAddress",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ContentHtml",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ContentText",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AttachmentFile",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "Lists",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Lists",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "MailingListReport",
"type": {
"id": "aa1762463be2b2be948f886a519de786",
"name": "MailingListReport",
"logicalName": "Lists",
"namespace": "Lists",
"fullNamespace": [
"Get_AccountId_CampaignId",
"Lists"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "MailingListId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailingId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AccountId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DeliveredDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ListName",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "RecipientCount",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "d5d9316435688d34115de0a5477e87ea",
"name": "RecipientSummary",
"logicalName": "RecipientCount",
"namespace": "RecipientCount",
"fullNamespace": [
"Get_AccountId_CampaignId",
"Lists",
"RecipientCount"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Active",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Text",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Html",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TextAndHtml",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Bounce",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "HardBounce",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOut",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Expected",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Sent",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Suppressed",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Received",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SoftBounce",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SpamReport",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Opens",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Openers",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OpensMobile",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OpenersMobile",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OpensDesktop",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OpenersDesktop",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Total",
"comments": "Deprecated Property",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Read",
"comments": "Deprecated Property",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ViewsMobile",
"comments": "Deprecated Property",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ViewsDesktop",
"comments": "Deprecated Property",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "ForwardSummary",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "dde8317ee48a8d029870841945fa5c3a",
"name": "Forwards",
"logicalName": "ForwardSummary",
"namespace": "ForwardSummary",
"fullNamespace": [
"Get_AccountId_CampaignId",
"Lists",
"ForwardSummary"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Total",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SendToFriend",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Facebook",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Twitter",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MySpace",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LinkedIn",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "GoogleBuzz",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "TotalLists",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FirstListDeliveredDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastListDeliveredDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "RecipientSummary",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "d5d9316435688d34115de0a5477e87ea",
"name": "RecipientSummary",
"logicalName": "RecipientSummary",
"namespace": "RecipientSummary",
"fullNamespace": [
"Get_AccountId_CampaignId",
"RecipientSummary"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Active",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Text",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Html",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TextAndHtml",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Bounce",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "HardBounce",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOut",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Expected",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Sent",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Suppressed",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Received",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SoftBounce",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SpamReport",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Opens",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Openers",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OpensMobile",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OpenersMobile",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OpensDesktop",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OpenersDesktop",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Total",
"comments": "Deprecated Property",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Read",
"comments": "Deprecated Property",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ViewsMobile",
"comments": "Deprecated Property",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ViewsDesktop",
"comments": "Deprecated Property",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
{
"name": "ForwardSummary",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "dde8317ee48a8d029870841945fa5c3a",
"name": "Forwards",
"logicalName": "ForwardSummary",
"namespace": "ForwardSummary",
"fullNamespace": [
"Get_AccountId_CampaignId",
"ForwardSummary"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Total",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SendToFriend",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Facebook",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Twitter",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MySpace",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LinkedIn",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "GoogleBuzz",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Reports/Mailings/MessageTesting",
"comments": "Message testing reports.
", "endpoints": [ { "id": "63f1a57efd528ee91f9b02614d2572ec", "name": "", "comments": "Report on message testing.
", "methodName": "Post_AccountId", "namespace": [ "Reports", "Mailings", "MessageTesting" ], "urlTemplate": "Reports/Mailings/MessageTesting/{accountId}", "method": "POST", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "521044264a9d6c0f5535abf2cb941c7d",
"name": "MessageTestReportFilter",
"logicalName": "Request",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "MailingId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "StartIndex",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MaxResults",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ScheduledDeliveryOnOrAfter",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ScheduledDeliveryOnOrBefore",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MessageId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "MessageTestReports",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "MessageTestReport",
"type": {
"id": "91adc8e80c9fa27e270f9113b0d82550",
"name": "MessageTestReport",
"logicalName": "Response",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Number",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AccountId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Scheduled",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ScheduledDelivery",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Delivered",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuppressionType",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "RecipientFilter",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Approved",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ApprovedBy",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CreatedBy",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ModifiedBy",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Messages",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Messages",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "TestMessage",
"type": {
"id": "d2dc4bf7f0181006af839c472b4b3075",
"name": "TestMessage",
"logicalName": "Messages",
"namespace": "Messages",
"fullNamespace": [
"Post_AccountId",
"Messages"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastEmailDelivered",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "RecipientCount",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "8dbca03fd8af8c549715dd17fc21d170",
"name": "RecipientCount",
"logicalName": "RecipientCount",
"namespace": "RecipientCount",
"fullNamespace": [
"Post_AccountId",
"Messages",
"RecipientCount"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Sent",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Delivered",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Views",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ViewsUnique",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Clicks",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ClicksUnique",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SoftBounce",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "HardBounce",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOut",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SpamReport",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OpenRate",
"optional": false,
"sampleValue": "0.00",
"deprecated": false,
"type": {
"name": "decimal",
"isNullable": false,
"isSimple": true,
"sampleValue": "0.00",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ClickRate",
"optional": false,
"sampleValue": "0.00",
"deprecated": false,
"type": {
"name": "decimal",
"isNullable": false,
"isSimple": true,
"sampleValue": "0.00",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "IsRemainderScheduled",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Reports/Mailings/Opens/Detail",
"comments": "Open reports.
", "endpoints": [ { "id": "182ac261d5cdaaada41562a33369b5d3", "name": "", "comments": "Report on opens.
", "methodName": "Post_AccountId_CampaignId", "namespace": [ "Reports", "Mailings", "Opens", "Detail" ], "urlTemplate": "Reports/Mailings/Opens/Detail/{accountId}/{campaignId}", "method": "POST", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "campaignId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "7d303d0a3e7ba3854e37077ad21b9aca",
"name": "DetailReportFilter",
"logicalName": "Request",
"namespace": "Post_AccountId_CampaignId",
"fullNamespace": [
"Post_AccountId_CampaignId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "MailingListId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FilterStartDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FilterEndDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Platform",
"optional": true,
"defaultValue": "All",
"sampleValue": "All",
"deprecated": false,
"type": {
"id": "ee3dac7a9de7caec7853ab617d06a827",
"name": "string",
"namespace": "RequestPlatform",
"fullNamespace": [
"Post_AccountId_CampaignId",
"RequestPlatform"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "All",
"enumeration": {
"name": "PlatformFilter",
"options": [
{
"name": "All",
"value": "All"
},
{
"name": "Desktop",
"value": "Desktop"
},
{
"name": "Mobile",
"value": "Mobile"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "ReadDetails",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "ReadDetail",
"type": {
"id": "8985f2bcfc684b61c15963624b457974",
"name": "ReadDetail",
"logicalName": "Response",
"namespace": "Post_AccountId_CampaignId",
"fullNamespace": [
"Post_AccountId_CampaignId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "FirstView",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastView",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalViews",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "UniqueViews",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalMobileViews",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "UniqueMobileViews",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalDesktopViews",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "UniqueDesktopViews",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Views",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Views",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "View",
"type": {
"id": "5cf4e7f56f45fbd90ee54976472abff6",
"name": "View",
"logicalName": "Views",
"namespace": "Views",
"fullNamespace": [
"Post_AccountId_CampaignId",
"Views"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "IpAddress",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "UserAgent",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Platform",
"optional": false,
"sampleValue": "Desktop",
"deprecated": false,
"type": {
"id": "93e70853c1b071f3b6f619dacd83b44b",
"name": "Platform",
"namespace": "ViewsPlatform",
"fullNamespace": [
"Post_AccountId_CampaignId",
"Views",
"ViewsPlatform"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Desktop",
"enumeration": {
"name": "Platform",
"options": [
{
"name": "Desktop",
"value": "Desktop"
},
{
"name": "Mobile",
"value": "Mobile"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Browser",
"optional": false,
"sampleValue": "Firefox",
"deprecated": false,
"type": {
"id": "3dcc055704572316267cdf12d9fd9d86",
"name": "Browser",
"namespace": "ViewsBrowser",
"fullNamespace": [
"Post_AccountId_CampaignId",
"Views",
"ViewsBrowser"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Chrome",
"enumeration": {
"name": "Browser",
"options": [
{
"name": "Chrome",
"value": "Chrome"
},
{
"name": "Firefox",
"value": "Firefox"
},
{
"name": "InternetExplorer",
"value": "InternetExplorer"
},
{
"name": "Opera",
"value": "Opera"
},
{
"name": "Other",
"value": "Other"
},
{
"name": "Safari",
"value": "Safari"
},
{
"name": "SeaMonkey",
"value": "SeaMonkey"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Recipient",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "0b49c6029787b70c10b589163a36dc84",
"name": "RecipientModel",
"logicalName": "Recipient",
"namespace": "Recipient",
"fullNamespace": [
"Post_AccountId_CampaignId",
"Recipient"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "EmailAddress",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Active",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EmailFormatPreference",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "2d0855170510caa5ee9b0e2a55c3e337",
"name": "EmailFormatPreference",
"namespace": "RecipientEmailFormatPreference",
"fullNamespace": [
"Post_AccountId_CampaignId",
"Recipient",
"RecipientEmailFormatPreference"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "EmailFormatPreference",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "None",
"value": "None"
},
{
"name": "Text",
"value": "Text"
},
{
"name": "TextAndHtml",
"value": "TextAndHtml"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "RecipientProperties",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "RecipientProperties",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Property",
"type": {
"id": "817d4fa0f2f256418bfd02b5bfcf0bdf",
"name": "Property",
"logicalName": "RecipientProperties",
"namespace": "RecipientProperties",
"fullNamespace": [
"Post_AccountId_CampaignId",
"Recipient",
"RecipientProperties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Value",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Reports/Mailings/OptOuts/Detail",
"comments": "Opt out reports.
", "endpoints": [ { "id": "b099a29c3ab8b34ad9e02b99eb3742b8", "name": "", "comments": "Report on opt outs.
", "methodName": "Post_AccountId_CampaignId", "namespace": [ "Reports", "Mailings", "OptOuts", "Detail" ], "urlTemplate": "Reports/Mailings/OptOuts/Detail/{accountId}/{campaignId}", "method": "POST", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "campaignId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "51c9e6077495413150c957a3c262d83d",
"name": "DetailReportFilter",
"logicalName": "Request",
"namespace": "Post_AccountId_CampaignId",
"fullNamespace": [
"Post_AccountId_CampaignId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "MailingListId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FilterStartDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FilterEndDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOutFilter",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "a298ba4e38c594b5dc2ef27d3d4466e9",
"name": "OptOutFilter",
"logicalName": "OptOutFilter",
"namespace": "OptOutFilter",
"fullNamespace": [
"Post_AccountId_CampaignId",
"OptOutFilter"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "OptOutType",
"optional": true,
"sampleValue": "List",
"deprecated": false,
"type": {
"id": "5cd8784017250225a20b0761e5660a10",
"name": "string",
"namespace": "OptOutFilterOptOutType",
"fullNamespace": [
"Post_AccountId_CampaignId",
"OptOutFilter",
"OptOutFilterOptOutType"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "GlobalOptOut",
"enumeration": {
"name": "OptOutType",
"options": [
{
"name": "GlobalOptOut",
"value": "GlobalOptOut"
},
{
"name": "List",
"value": "List"
},
{
"name": "UnsubscribeRequest",
"value": "UnsubscribeRequest"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "OptOutDetails",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "OptOutDetail",
"type": {
"id": "5b279c4d5169af67de9d60e76669b7b6",
"name": "OptOutDetail",
"logicalName": "Response",
"namespace": "Post_AccountId_CampaignId",
"fullNamespace": [
"Post_AccountId_CampaignId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "OptOutDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "OptOutType",
"optional": false,
"sampleValue": "List",
"deprecated": false,
"type": {
"id": "7b3c48222c5ba899998ac1af87be8847",
"name": "OptOutType",
"namespace": "ResponseOptOutType",
"fullNamespace": [
"Post_AccountId_CampaignId",
"ResponseOptOutType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "GlobalOptOut",
"enumeration": {
"name": "OptOutType",
"options": [
{
"name": "GlobalOptOut",
"value": "GlobalOptOut"
},
{
"name": "List",
"value": "List"
},
{
"name": "UnsubscribeRequest",
"value": "UnsubscribeRequest"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Recipient",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "0b49c6029787b70c10b589163a36dc84",
"name": "RecipientModel",
"logicalName": "Recipient",
"namespace": "Recipient",
"fullNamespace": [
"Post_AccountId_CampaignId",
"Recipient"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "EmailAddress",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Active",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EmailFormatPreference",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "2d0855170510caa5ee9b0e2a55c3e337",
"name": "EmailFormatPreference",
"namespace": "RecipientEmailFormatPreference",
"fullNamespace": [
"Post_AccountId_CampaignId",
"Recipient",
"RecipientEmailFormatPreference"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "EmailFormatPreference",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "None",
"value": "None"
},
{
"name": "Text",
"value": "Text"
},
{
"name": "TextAndHtml",
"value": "TextAndHtml"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "RecipientProperties",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "RecipientProperties",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Property",
"type": {
"id": "817d4fa0f2f256418bfd02b5bfcf0bdf",
"name": "Property",
"logicalName": "RecipientProperties",
"namespace": "RecipientProperties",
"fullNamespace": [
"Post_AccountId_CampaignId",
"Recipient",
"RecipientProperties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Value",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Reports/Mailings/Summary",
"endpoints": [
{
"id": "e9d44d7ada79c4d8375fc604a9c2ae8e",
"name": "",
"methodName": "Post_AccountId",
"namespace": [
"Reports",
"Mailings",
"Summary"
],
"urlTemplate": "Reports/Mailings/Summary/{accountId}",
"method": "POST",
"urlParameters": [
{
"name": "accountId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "78abe6d3d34544b90e95df1673843cb8",
"name": "MailingReportFilter",
"logicalName": "Request",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "MailingId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CampaignType",
"optional": true,
"sampleValue": "Standard",
"deprecated": false,
"type": {
"id": "1fb67abdf62922584eef02c99d16be45",
"name": "string",
"namespace": "RequestCampaignType",
"fullNamespace": [
"Post_AccountId",
"RequestCampaignType"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "AbSplit",
"enumeration": {
"name": "CampaignType",
"options": [
{
"name": "AbSplit",
"value": "AbSplit"
},
{
"name": "AutoMessage",
"value": "AutoMessage"
},
{
"name": "Autoresponder",
"value": "Autoresponder"
},
{
"name": "Journey",
"value": "Journey"
},
{
"name": "ListWarming",
"value": "ListWarming"
},
{
"name": "Optimized",
"value": "Optimized"
},
{
"name": "OptimizedListWarming",
"value": "OptimizedListWarming"
},
{
"name": "SafeNotify",
"value": "SafeNotify"
},
{
"name": "Standard",
"value": "Standard"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "StartIndex",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MaxResults",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": true,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ScheduledDeliveryOnOrAfter",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ScheduledDeliveryOnOrBefore",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MessageId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ListId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "GroupId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "MailingSummaryReports",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "MailingSummaryReport",
"type": {
"id": "c73b967885a27b169e25bd2ffe774311",
"name": "MailingSummaryReport",
"logicalName": "Response",
"namespace": "Post_AccountId",
"fullNamespace": [
"Post_AccountId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "MailingId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Type",
"optional": false,
"sampleValue": "Standard",
"deprecated": false,
"type": {
"id": "61c83d6beda9eec93245df97474d6816",
"name": "Type",
"namespace": "ResponseType",
"fullNamespace": [
"Post_AccountId",
"ResponseType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "AbSplit",
"enumeration": {
"name": "Type",
"options": [
{
"name": "AbSplit",
"value": "AbSplit"
},
{
"name": "AutoMessage",
"value": "AutoMessage"
},
{
"name": "Autoresponder",
"value": "Autoresponder"
},
{
"name": "ListWarming",
"value": "ListWarming"
},
{
"name": "Standard",
"value": "Standard"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ScheduledDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ScheduledDeliveryDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DeliveredDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Approved",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ApprovedBy",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "RecipientsSent",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CreatedBy",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ModifiedBy",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "3ea7c0dea2bfcf3b64ae65e2965b6360",
"name": "",
"methodName": "Get_AccountId_CampaignId",
"namespace": [
"Reports",
"Mailings",
"Summary"
],
"urlTemplate": "Reports/Mailings/Summary/{accountId}/{campaignId}",
"method": "GET",
"urlParameters": [
{
"name": "accountId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
},
{
"name": "campaignId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "c73b967885a27b169e25bd2ffe774311",
"name": "MailingSummaryReport",
"logicalName": "Response",
"namespace": "Get_AccountId_CampaignId",
"fullNamespace": [
"Get_AccountId_CampaignId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "MailingId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Type",
"optional": false,
"sampleValue": "Standard",
"deprecated": false,
"type": {
"id": "61c83d6beda9eec93245df97474d6816",
"name": "Type",
"namespace": "ResponseType",
"fullNamespace": [
"Get_AccountId_CampaignId",
"ResponseType"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "AbSplit",
"enumeration": {
"name": "Type",
"options": [
{
"name": "AbSplit",
"value": "AbSplit"
},
{
"name": "AutoMessage",
"value": "AutoMessage"
},
{
"name": "Autoresponder",
"value": "Autoresponder"
},
{
"name": "ListWarming",
"value": "ListWarming"
},
{
"name": "Standard",
"value": "Standard"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ScheduledDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ScheduledDeliveryDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "DeliveredDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Approved",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ApprovedBy",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "RecipientsSent",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "CreatedBy",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ModifiedBy",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Reports/Mailings/TrackedLinks/Detail",
"comments": "Tracked link detail reports.
", "endpoints": [ { "id": "fa6af9278ffbea6b3a7a082ebfae85c1", "name": "", "comments": "Detailed report on tracked links.
", "methodName": "Post_AccountId_CampaignId", "namespace": [ "Reports", "Mailings", "TrackedLinks", "Detail" ], "urlTemplate": "Reports/Mailings/TrackedLinks/Detail/{accountId}/{campaignId}", "method": "POST", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "campaignId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "f5381aefbafaafb4a02cd02485567373",
"name": "Filter",
"logicalName": "Request",
"namespace": "Post_AccountId_CampaignId",
"fullNamespace": [
"Post_AccountId_CampaignId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "ListId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TrackedLinkId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "AdvertiserId",
"optional": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": true,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "StartDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EndDate",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Platform",
"optional": true,
"defaultValue": "All",
"sampleValue": "All",
"deprecated": false,
"type": {
"id": "ee3dac7a9de7caec7853ab617d06a827",
"name": "string",
"namespace": "RequestPlatform",
"fullNamespace": [
"Post_AccountId_CampaignId",
"RequestPlatform"
],
"isNullable": true,
"isSimple": true,
"sampleValue": "All",
"enumeration": {
"name": "PlatformFilter",
"options": [
{
"name": "All",
"value": "All"
},
{
"name": "Desktop",
"value": "Desktop"
},
{
"name": "Mobile",
"value": "Mobile"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "TrackedLinks",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "TrackedLink",
"type": {
"id": "915fb7aaebf49cc6bf7a672450c9da27",
"name": "TrackedLink",
"logicalName": "Response",
"namespace": "Post_AccountId_CampaignId",
"fullNamespace": [
"Post_AccountId_CampaignId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Url",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "MailingFormat",
"optional": false,
"sampleValue": "Text",
"deprecated": false,
"type": {
"id": "7ee11c6687b34cdf122c67891d43e796",
"name": "TrackedLinkMailingFormat",
"namespace": "ResponseMailingFormat",
"fullNamespace": [
"Post_AccountId_CampaignId",
"ResponseMailingFormat"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "TrackedLinkMailingFormat",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "Text",
"value": "Text"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FirstClick",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastClick",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalClicks",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "UniqueClicks",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalMobileClicks",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "UniqueMobileClicks",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalDesktopClicks",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "UniqueDesktopClicks",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Clicks",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "Clicks",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Click",
"type": {
"id": "aab71c6073cc63ec089be8c0708a71fd",
"name": "Click",
"logicalName": "Clicks",
"namespace": "Clicks",
"fullNamespace": [
"Post_AccountId_CampaignId",
"Clicks"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "IpAddress",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "UserAgent",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Platform",
"optional": false,
"sampleValue": "Desktop",
"deprecated": false,
"type": {
"id": "93e70853c1b071f3b6f619dacd83b44b",
"name": "Platform",
"namespace": "ClicksPlatform",
"fullNamespace": [
"Post_AccountId_CampaignId",
"Clicks",
"ClicksPlatform"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Desktop",
"enumeration": {
"name": "Platform",
"options": [
{
"name": "Desktop",
"value": "Desktop"
},
{
"name": "Mobile",
"value": "Mobile"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Browser",
"optional": false,
"sampleValue": "Firefox",
"deprecated": false,
"type": {
"id": "3dcc055704572316267cdf12d9fd9d86",
"name": "Browser",
"namespace": "ClicksBrowser",
"fullNamespace": [
"Post_AccountId_CampaignId",
"Clicks",
"ClicksBrowser"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Chrome",
"enumeration": {
"name": "Browser",
"options": [
{
"name": "Chrome",
"value": "Chrome"
},
{
"name": "Firefox",
"value": "Firefox"
},
{
"name": "InternetExplorer",
"value": "InternetExplorer"
},
{
"name": "Opera",
"value": "Opera"
},
{
"name": "Other",
"value": "Other"
},
{
"name": "Safari",
"value": "Safari"
},
{
"name": "SeaMonkey",
"value": "SeaMonkey"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
},
{
"name": "Recipient",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"id": "0b49c6029787b70c10b589163a36dc84",
"name": "RecipientModel",
"logicalName": "Recipient",
"namespace": "Recipient",
"fullNamespace": [
"Post_AccountId_CampaignId",
"Recipient"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "EmailAddress",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Active",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EmailFormatPreference",
"optional": false,
"sampleValue": "None",
"deprecated": false,
"type": {
"id": "2d0855170510caa5ee9b0e2a55c3e337",
"name": "EmailFormatPreference",
"namespace": "RecipientEmailFormatPreference",
"fullNamespace": [
"Post_AccountId_CampaignId",
"Recipient",
"RecipientEmailFormatPreference"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "EmailFormatPreference",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "None",
"value": "None"
},
{
"name": "Text",
"value": "Text"
},
{
"name": "TextAndHtml",
"value": "TextAndHtml"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "RecipientProperties",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "RecipientProperties",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Property",
"type": {
"id": "817d4fa0f2f256418bfd02b5bfcf0bdf",
"name": "Property",
"logicalName": "RecipientProperties",
"namespace": "RecipientProperties",
"fullNamespace": [
"Post_AccountId_CampaignId",
"Recipient",
"RecipientProperties"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Value",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Reports/Mailings/TrackedLinks/Summary",
"comments": "Tracked link summary reports.
", "endpoints": [ { "id": "af0a90405cf35c46dc62a7161f968baf", "name": "", "methodName": "Get_AccountId_CampaignId", "namespace": [ "Reports", "Mailings", "TrackedLinks", "Summary" ], "urlTemplate": "Reports/Mailings/TrackedLinks/Summary/{accountId}/{campaignId}", "method": "GET", "urlParameters": [ { "name": "accountId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "campaignId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "accept", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "TrackedLinks",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "TrackedLink",
"type": {
"id": "c0f7a0f6d36804efa9c18f83e8ac81ef",
"name": "TrackedLink",
"logicalName": "Response",
"namespace": "Get_AccountId_CampaignId",
"fullNamespace": [
"Get_AccountId_CampaignId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Url",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LinkMailingFormat",
"optional": false,
"sampleValue": "Text",
"deprecated": false,
"type": {
"id": "7ee11c6687b34cdf122c67891d43e796",
"name": "TrackedLinkMailingFormat",
"namespace": "ResponseLinkMailingFormat",
"fullNamespace": [
"Get_AccountId_CampaignId",
"ResponseLinkMailingFormat"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "TrackedLinkMailingFormat",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "Text",
"value": "Text"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FirstClick",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastClick",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalClicks",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "UniqueClicks",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalMobileClicks",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "UniqueMobileClicks",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalDesktopClicks",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "UniqueDesktopClicks",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "b56ef690ea1d757892d0fe8e34a97e5c",
"name": "",
"methodName": "Get_AccountId_CampaignId_ListId",
"namespace": [
"Reports",
"Mailings",
"TrackedLinks",
"Summary"
],
"urlTemplate": "Reports/Mailings/TrackedLinks/Summary/{accountId}/{campaignId}/{listId}",
"method": "GET",
"urlParameters": [
{
"name": "accountId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
},
{
"name": "campaignId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
},
{
"name": "listId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "TrackedLinks",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "TrackedLink",
"type": {
"id": "c0f7a0f6d36804efa9c18f83e8ac81ef",
"name": "TrackedLink",
"logicalName": "Response",
"namespace": "Get_AccountId_CampaignId_ListId",
"fullNamespace": [
"Get_AccountId_CampaignId_ListId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Url",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LinkMailingFormat",
"optional": false,
"sampleValue": "Text",
"deprecated": false,
"type": {
"id": "7ee11c6687b34cdf122c67891d43e796",
"name": "TrackedLinkMailingFormat",
"namespace": "ResponseLinkMailingFormat",
"fullNamespace": [
"Get_AccountId_CampaignId_ListId",
"ResponseLinkMailingFormat"
],
"isNullable": false,
"isSimple": true,
"sampleValue": "Html",
"enumeration": {
"name": "TrackedLinkMailingFormat",
"options": [
{
"name": "Html",
"value": "Html"
},
{
"name": "Text",
"value": "Text"
}
]
},
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "FirstClick",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastClick",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalClicks",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "UniqueClicks",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalMobileClicks",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "UniqueMobileClicks",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "TotalDesktopClicks",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "UniqueDesktopClicks",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
}
]
}
]
},
{
"name": "Tags",
"comments": "Tags give you the ability to further classify your list recipients by storing additional information about your recipients so you can further target/filter groups at send time.
\nA tag has one required component:
\nOnce a tag is created, it can be assigned to a recipient and it can be used as a filter when scheduling a Campaign.
\nTag Events provide the ability to automatically assign a tag to a recipient based on a selected event type. For example, you can have a tag automatically assigned when a recipient opens your email or when a recipient click on a tracked link from your email.\nTag events are created when scheduling a campaign, see Campaign for more information.
", "resources": [ { "name": "/Tags", "comments": "Tag management.
", "endpoints": [ { "id": "b576c1e4a3e2e5754fc4f4c0b51da7a7", "name": "", "methodName": "Get", "namespace": [ "Tags" ], "urlTemplate": "Tags", "method": "GET", "urlParameters": [], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "accept", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "Tags",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "Tag",
"type": {
"id": "564f8a9730587a294e9e77daa965ff5a",
"name": "Tag",
"logicalName": "Response",
"namespace": "Get",
"fullNamespace": [
"Get"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "bf751d78046354dc2421a695024de888",
"name": "",
"comments": "Create a tag.
", "methodName": "Post", "namespace": [ "Tags" ], "urlTemplate": "Tags", "method": "POST", "urlParameters": [], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "dbf2eea8b4c912c3768929b463a8809f",
"name": "Tag",
"logicalName": "Request",
"namespace": "Post",
"fullNamespace": [
"Post"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "564f8a9730587a294e9e77daa965ff5a",
"name": "Tag",
"logicalName": "Response",
"namespace": "Post",
"fullNamespace": [
"Post"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "3c334e09aea0c9463a6755ab2cca29e4",
"name": "",
"methodName": "Get_TagId",
"namespace": [
"Tags"
],
"urlTemplate": "Tags/{tagId}",
"method": "GET",
"urlParameters": [
{
"name": "tagId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "564f8a9730587a294e9e77daa965ff5a",
"name": "Tag",
"logicalName": "Response",
"namespace": "Get_TagId",
"fullNamespace": [
"Get_TagId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "4591e8317d2d823059c02f088381149d",
"name": "",
"comments": "Modify a tag.
", "methodName": "Put_TagId", "namespace": [ "Tags" ], "urlTemplate": "Tags/{tagId}", "method": "PUT", "urlParameters": [ { "name": "tagId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "a41c65e41844d83b944e5d0d23185d9c",
"name": "Tag",
"logicalName": "Request",
"namespace": "Put_TagId",
"fullNamespace": [
"Put_TagId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Name",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [],
"isBinary": false,
"hasBody": false
}
},
{
"id": "3ba45ae0498bb7e22bc478ecac4970b4",
"name": "",
"comments": "Delete a tag.
", "methodName": "Delete_TagId", "namespace": [ "Tags" ], "urlTemplate": "Tags/{tagId}", "method": "DELETE", "urlParameters": [ { "name": "tagId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [], "isBinary": false, "hasBody": false }, "response": { "headers": [], "isBinary": false, "hasBody": false } } ] }, { "name": "/Tags/Recipients", "endpoints": [ { "id": "4d46962a8737dd505d9b2686ce321e25", "name": "", "comments": "Assign a tag to a recipient.
", "methodName": "Post_TagId", "namespace": [ "Tags", "Recipients" ], "urlTemplate": "Tags/Recipients/{tagId}", "method": "POST", "urlParameters": [ { "name": "tagId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "8440119133477c9ca72ddff8207e224f",
"name": "PostRequest",
"logicalName": "Request",
"namespace": "Post_TagId",
"fullNamespace": [
"Post_TagId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "ListId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "RecipientId",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "42ba125757a36e268af540ee481df041",
"name": "TagAssignmentResponse",
"logicalName": "Response",
"namespace": "Post_TagId",
"fullNamespace": [
"Post_TagId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "TagId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ListId",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "RecipientId",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "23247bdaea2789ed7619c32505a74993",
"name": "",
"comments": "Remove a tag from a recipient.
", "methodName": "Delete_TagId_ListId_RecipientId", "namespace": [ "Tags", "Recipients" ], "urlTemplate": "Tags/Recipients/{tagId}/{listId}/{recipientId}", "method": "DELETE", "urlParameters": [ { "name": "tagId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "listId", "type": { "name": "uuid", "isNullable": false, "isSimple": true, "sampleValue": "00000000-0000-0000-0000-000000000000", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "00000000-0000-0000-0000-000000000000", "isAuth": false }, { "name": "recipientId", "type": { "name": "int", "isNullable": false, "isSimple": true, "sampleValue": "0", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "0", "isAuth": false } ], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [], "isBinary": false, "hasBody": false }, "response": { "headers": [], "isBinary": false, "hasBody": false } } ] } ] }, { "name": "Verify", "comments": "This endpoint is used to perform an Email Hygiene check for the provided email address
\nExample\n/verify?email=email@totest.com
", "resources": [ { "name": "/Verify", "comments": "Email Hygiene verification
", "endpoints": [ { "id": "5c71d2ab7b286e578a1f2bc205d5a6ba", "name": "", "methodName": "Get", "namespace": [ "Verify" ], "urlTemplate": "Verify", "method": "GET", "urlParameters": [], "querystringParameters": [ { "name": "email", "type": { "name": "string", "isNullable": false, "isSimple": true, "sampleValue": "", "isComplex": false, "isArray": false, "isDictionary": false }, "sampleValue": "", "multipleAllowed": false, "required": true, "isAuth": false } ], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "accept", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "13f3992c519716340622236f939c1d88",
"name": "Verify",
"logicalName": "Response",
"namespace": "Get",
"fullNamespace": [
"Get"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "AvailableCredits",
"comments": "Remaining Email Hygiene credits.",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Email",
"comments": "The tested email. In some cases this will be a corrected to fix common typos, etc.",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "IsCreditRefillError",
"comments": "True if an automatic credit refill failed.",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "IsInsufficientCreditError",
"comments": "True if there were insuffcient credits for the request.",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "IsSuccess",
"comments": "True when the request was completed without errors.",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "IsVendorError",
"comments": "True when there was a vendor error. Please contact support.",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ResultCode",
"comments": "One of MinimalRisk, LowRisk, ModerateRisk, HighRisk, InsufficientCredits, CreditRefillError, or VendorError",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "9b58300a1569061582f99db5e010b0a1",
"name": "",
"methodName": "Post",
"namespace": [
"Verify"
],
"urlTemplate": "Verify",
"method": "POST",
"urlParameters": [],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "dc2b2a5526e22336488e510df4dbdc5d",
"name": "EmailVerificationRequestModel",
"logicalName": "Request",
"namespace": "Post",
"fullNamespace": [
"Post"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Email",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "13f3992c519716340622236f939c1d88",
"name": "Verify",
"logicalName": "Response",
"namespace": "Post",
"fullNamespace": [
"Post"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "AvailableCredits",
"comments": "Remaining Email Hygiene credits.",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Email",
"comments": "The tested email. In some cases this will be a corrected to fix common typos, etc.",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "IsCreditRefillError",
"comments": "True if an automatic credit refill failed.",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "IsInsufficientCreditError",
"comments": "True if there were insuffcient credits for the request.",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "IsSuccess",
"comments": "True when the request was completed without errors.",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "IsVendorError",
"comments": "True when there was a vendor error. Please contact support.",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ResultCode",
"comments": "One of MinimalRisk, LowRisk, ModerateRisk, HighRisk, InsufficientCredits, CreditRefillError, or VendorError",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
}
]
}
]
},
{
"name": "Webhooks",
"comments": "Event webhooks will notify a URL of your choosing via HTTP POST with\r\ninformation about recipient actions as they occur. You can use this\r\ndata to track unsubscribes, bounces, opens, and clicks. You can read\r\nmore about the POSTed data below.
\nWebhook responses will be handled with one of three patterns:
\nHTTP 200 responses will be considered successful; no retries will occur.HTTP 406 responses will be considered a permanent reject; no retries will occur.To ensure the authenticity of webhook requests, they are signed, and the signature is posted along with other webhook parameters:
\n| Parameter | \n\tType | \n\tDescription | \n
|---|---|---|
| timestamp | \n\tint | \n\tUnix timestamp, i.e., a number of seconds passed since Jan. 1, 1970. | \n
| token | \n\tstring | \n\tRandom string with a length of 50. | \n
| signature | \n\tstring | \n\tHexadecimal string generated by HMAC algorithm. | \n
To verify the authenticity of the message, you must do the following:
\ntimestamp and token values.signature value.Parameters common to all webhook POSTs:
\n| Parameter | \n\tType | \n\tDescription | \n
|---|---|---|
| string | \n\tRecipient email address | \n|
| timestamp | \n\tint | \n\tUnix timestamp, i.e. seconds passed since Jan. 1, 1970 | \n
| eventType | \n\tstring | \n\tOne of 'Open', 'Click', 'Bounce', or 'Optout' | \n
| recipientId | \n\tstring | \n\tThe id for the recipient | \n
| xCampaign | \n\tstring | \n\tAny x-rm-Campaign header included in the original message | \n
Parameters common to all Open , Click , and Optout POSTs:
\nParameters labeled with RM are only available to ReachMail campaigns.\r\nEasySMTP campaigns will not supply those values.
| Parameter | \n\tType | \n\tDescription | \n
|---|---|---|
| ipAddress | \n\tstring | \n\tThe IP address originating the event. | \n
| userAgent | \n\tstring | \n\tThe UserAgent string of the client that originated the event. | \n
| eventId | \n\tstring | \n\tThe id for the event. | \n
listId RM | \n\tstring | \n\tThe id of the list used for the mailing. | \n
listName RM | \n\tstring | \n\tName of the list recipient was on. | \n
mailingId RM | \n\tstring | \n\tThe id of the list used in the mailing. | \n
mailingName RM | \n\tstring | \n\tName of the message list event was responding to. | \n
| location | \n\tGeoLocation | \n\tGeolocation data for the event. | \n
| device | \n\tDevice | \n\tDevice data for the event. | \n
| url | \n\tstring | \n\tThe clicked URL, available only for click events. | \n
Optout messages will not have geolocation or device data if they were generated by \r\nabuse feedback reports that were received over email channels.
\nParameters common to Geolocation models
\n| Parameter | \n\tType | \n\tDescription | \n
|---|---|---|
| city | \n\tstring | \n\tCity name | \n
| countryCode | \n\tstring | \n\tTwo character country code | \n
| region | \n\tstring | \n\tIP region | \n
Parameters common to Device models
\n| Parameter | \n\tType | \n\tDescription | \n
|---|---|---|
| clientName | \n\tstring | \n\tThe name of the client derived from the HTTP User-Agent header | \n
| clientOs | \n\tstring | \n\tThe name of the client OS derived from the HTTP User-Agent header | \n
| clientType | \n\tstring | \n\tThe application type of the client. | \n
| deviceType | \n\tstring | \n\tThe client device type, e.g. mobile, desktop. | \n
Parameters common to all Bounce POSTs:
\nParameters labeled with RM are only available to ReachMail campaigns.\r\nEasySMTP campaigns will not supply those values.
| Parameter | \n\tType | \n\tDescription | \n
|---|---|---|
| bounceCode | \n\tstring | \n\tThe evaluated bounce code for the recipient. | \n
| reason | \n\tstring | \n\tAn interpreted reason for the bounce. | \n
| smtpStatus | \n\tstring | \n\tThe original SMTP status returned by the remote host. | \n
| smtpDiagnostic | \n\tstring | \n\tThe original SMTP diagnostic returned by the remote host. | \n
listId RM | \n\tstring | \n\tThe id of the list used for the mailing. | \n
listName RM | \n\tstring | \n\tName of the list recipient was on. | \n
mailingId RM | \n\tstring | \n\tThe id of the list used in the mailing. | \n
mailingName RM | \n\tstring | \n\tName of the message list event was responding to. | \n
Interpreted bounce reasons:
\nAll webhook bodies are sent as JSON.
\nExample Open , Click , or Optout body:
\n{\n timestamp: 1552927113,\n token: \"eec6leeraghooNohk8eu4ohshei5IY2biek6aepeixi7maf5be\",\n signature: \"74e90deabaea9693ca34ea0c59a5d893c2952b3fab82782fce599f9dfb39e494\",\n email: \"user@domain.com\",\n eventType: \"Open\",\n recipientId: \"a8f3ff76-f915-4c8e-a67f-bf3a2179c6a5\",\n xCampaign: \"\",\n ipAddress: \"4.3.2.1\",\n userAgent: \"Mozilla 5.0\",\n eventId: \"52e9b845-bb5a-45bb-b8a7-a4946603058b\",\n listId: \"4f96c5ac-128c-4824-8ffe-8dfa43e3d6eb\",\n listName: \"My Customers\",\n mailingId: \"76fb82a5-42a8-4f6d-bf00-d05bac5e9a7d\",\n mailingName: \"Company Newsletter\",\n location: {\n city: \"Chicago\",\n countryCode: \"US\",\n region: \"IL\"\n },\n device: {\n clientName: \"Outlook\",\n clientOs: \"Windows\",\n clientType: \"Outlook\",\n deviceType: \"Desktop\"\n }\n}\nExample Bounce body.
\n{\n timestamp: 1552927113,\n token: \"eec6leeraghooNohk8eu4ohshei5IY2biek6aepeixi7maf5be\",\n signature: \"74e90deabaea9693ca34ea0c59a5d893c2952b3fab82782fce599f9dfb39e494\",\n email: \"user@domain.com\",\n eventType: \"Bounce\",\n recipientId: \"a8f3ff76-f915-4c8e-a67f-bf3a2179c6a5\",\n listId: \"4f96c5ac-128c-4824-8ffe-8dfa43e3d6eb\",\n listName: \"My Customers\",\n mailingId: \"76fb82a5-42a8-4f6d-bf00-d05bac5e9a7d\",\n mailingName: \"Company Newsletter\",\n bounceCode: \"HB\",\n reason: \"HardBounce\",\n smtpStatus: \"550\",\n smtpDiagnostic: \"550 invalid user\"\n}\nWebhook Management
", "endpoints": [ { "id": "a1f1ea731425643868e7adba662ba459", "name": "", "methodName": "Get", "namespace": [ "Webhooks" ], "urlTemplate": "Webhooks", "method": "GET", "urlParameters": [], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "accept", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"name": "ArrayOfWebhookModel",
"isNullable": false,
"isSimple": false,
"isComplex": false,
"isArray": true,
"arrayItem": {
"name": "WebhookModel",
"type": {
"id": "5b36ad32c23c626948e02e9ef3939e40",
"name": "WebhookModel",
"logicalName": "Response",
"namespace": "Get",
"fullNamespace": [
"Get"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Active",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ErrorCount",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "long",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EventType",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastErrorUtc",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastSuccessUtc",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuccessCount",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "long",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Url",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
}
},
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "1cec5bdd378b4b1fdbc2221fab42c09c",
"name": "",
"methodName": "Put_WebhookId",
"namespace": [
"Webhooks"
],
"urlTemplate": "Webhooks/{webhookId}",
"method": "PUT",
"urlParameters": [
{
"name": "webhookId",
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
},
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isAuth": false
}
],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "5b36ad32c23c626948e02e9ef3939e40",
"name": "WebhookModel",
"logicalName": "Request",
"namespace": "Put_WebhookId",
"fullNamespace": [
"Put_WebhookId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Active",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ErrorCount",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "long",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EventType",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastErrorUtc",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastSuccessUtc",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuccessCount",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "long",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Url",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "5b36ad32c23c626948e02e9ef3939e40",
"name": "WebhookModel",
"logicalName": "Response",
"namespace": "Put_WebhookId",
"fullNamespace": [
"Put_WebhookId"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Active",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ErrorCount",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "long",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EventType",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastErrorUtc",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastSuccessUtc",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuccessCount",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "long",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Url",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
}
]
},
{
"name": "/Webhooks/Bounce",
"comments": "Webhook Management
", "endpoints": [ { "id": "7c301e21b4ea58400ac58aa87e4d3e6b", "name": "", "methodName": "Post_Bounce", "namespace": [ "Webhooks", "Bounce" ], "urlTemplate": "Webhooks/Bounce", "method": "POST", "urlParameters": [], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "5b36ad32c23c626948e02e9ef3939e40",
"name": "WebhookModel",
"logicalName": "Request",
"namespace": "Post_Bounce",
"fullNamespace": [
"Post_Bounce"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Active",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ErrorCount",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "long",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EventType",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastErrorUtc",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastSuccessUtc",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuccessCount",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "long",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Url",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "5b36ad32c23c626948e02e9ef3939e40",
"name": "WebhookModel",
"logicalName": "Response",
"namespace": "Post_Bounce",
"fullNamespace": [
"Post_Bounce"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Active",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ErrorCount",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "long",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EventType",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastErrorUtc",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastSuccessUtc",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuccessCount",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "long",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Url",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "4558fdf73f2ae1019bd19b08dc32a2a7",
"name": "",
"methodName": "Delete_Bounce",
"namespace": [
"Webhooks",
"Bounce"
],
"urlTemplate": "Webhooks/Bounce",
"method": "DELETE",
"urlParameters": [],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [],
"isBinary": false,
"hasBody": false
}
}
]
},
{
"name": "/Webhooks/Click",
"comments": "Webhook Management
", "endpoints": [ { "id": "c917d0f0eb94467e89990dded3f05541", "name": "", "methodName": "Post_Click", "namespace": [ "Webhooks", "Click" ], "urlTemplate": "Webhooks/Click", "method": "POST", "urlParameters": [], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "5b36ad32c23c626948e02e9ef3939e40",
"name": "WebhookModel",
"logicalName": "Request",
"namespace": "Post_Click",
"fullNamespace": [
"Post_Click"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Active",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ErrorCount",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "long",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EventType",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastErrorUtc",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastSuccessUtc",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuccessCount",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "long",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Url",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "5b36ad32c23c626948e02e9ef3939e40",
"name": "WebhookModel",
"logicalName": "Response",
"namespace": "Post_Click",
"fullNamespace": [
"Post_Click"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Active",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ErrorCount",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "long",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EventType",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastErrorUtc",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastSuccessUtc",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuccessCount",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "long",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Url",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "efe9e12f90b458bc6d7df4f9ac7415c6",
"name": "",
"methodName": "Delete_Click",
"namespace": [
"Webhooks",
"Click"
],
"urlTemplate": "Webhooks/Click",
"method": "DELETE",
"urlParameters": [],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [],
"isBinary": false,
"hasBody": false
}
}
]
},
{
"name": "/Webhooks/Open",
"comments": "Webhook Management
", "endpoints": [ { "id": "fab4630c8cb635e58fda0e1e2216c433", "name": "", "methodName": "Post_Open", "namespace": [ "Webhooks", "Open" ], "urlTemplate": "Webhooks/Open", "method": "POST", "urlParameters": [], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "5b36ad32c23c626948e02e9ef3939e40",
"name": "WebhookModel",
"logicalName": "Request",
"namespace": "Post_Open",
"fullNamespace": [
"Post_Open"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Active",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ErrorCount",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "long",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EventType",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastErrorUtc",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastSuccessUtc",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuccessCount",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "long",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Url",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "5b36ad32c23c626948e02e9ef3939e40",
"name": "WebhookModel",
"logicalName": "Response",
"namespace": "Post_Open",
"fullNamespace": [
"Post_Open"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Active",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ErrorCount",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "long",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EventType",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastErrorUtc",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastSuccessUtc",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuccessCount",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "long",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Url",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "b7f40985b90bf2fae7174f90c341e27e",
"name": "",
"methodName": "Delete_Open",
"namespace": [
"Webhooks",
"Open"
],
"urlTemplate": "Webhooks/Open",
"method": "DELETE",
"urlParameters": [],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [],
"isBinary": false,
"hasBody": false
}
}
]
},
{
"name": "/Webhooks/Optout",
"comments": "Webhook Management
", "endpoints": [ { "id": "326c7e9b085341f0c254ef6ab1fca2c1", "name": "", "methodName": "Post_Optout", "namespace": [ "Webhooks", "Optout" ], "urlTemplate": "Webhooks/Optout", "method": "POST", "urlParameters": [], "querystringParameters": [], "secure": true, "statusCodes": [ { "name": "Bad Request", "comments": "Request is malformed or fails validation. See the status description for more information.", "code": 400 }, { "name": "Unauthorized", "comments": "Authentication failed or you did not provide credentials.", "code": 401 }, { "name": "Forbidden", "comments": "You do not have permission to perform the action.", "code": 403 }, { "name": "Not Found", "comments": "An item you are referring to is not found.", "code": 404 }, { "name": "Service Unavailable", "comments": "The server is too busy to handle the request. Try your request again later.", "code": 503 }, { "name": "Internal Error", "comments": "An internal error occurred; contact support with the error id in the http status description.", "code": 500 } ], "request": { "headers": [ { "name": "Content-Type", "comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "5b36ad32c23c626948e02e9ef3939e40",
"name": "WebhookModel",
"logicalName": "Request",
"namespace": "Post_Optout",
"fullNamespace": [
"Post_Optout"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Active",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ErrorCount",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "long",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EventType",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastErrorUtc",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastSuccessUtc",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuccessCount",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "long",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Url",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "5b36ad32c23c626948e02e9ef3939e40",
"name": "WebhookModel",
"logicalName": "Response",
"namespace": "Post_Optout",
"fullNamespace": [
"Post_Optout"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "Active",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Created",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": false,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ErrorCount",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "long",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "EventType",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Id",
"optional": false,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"deprecated": false,
"type": {
"name": "uuid",
"isNullable": false,
"isSimple": true,
"sampleValue": "00000000-0000-0000-0000-000000000000",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Modified",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastErrorUtc",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "LastSuccessUtc",
"comments": "Note: Datetime values are formatted as ISO 8601 and always expressed in UTC (yyyy-MM-ddThh:mm:ss.nZ).",
"optional": false,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"deprecated": false,
"type": {
"name": "dateTime",
"isNullable": true,
"isSimple": true,
"sampleValue": "1985-10-26T05:21:00.0000000Z",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "SuccessCount",
"optional": false,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "long",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Url",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
},
{
"id": "d9efa42eba0a3d9bf6e2553e34aabb2d",
"name": "",
"methodName": "Delete_Optout",
"namespace": [
"Webhooks",
"Optout"
],
"urlTemplate": "Webhooks/Optout",
"method": "DELETE",
"urlParameters": [],
"querystringParameters": [],
"secure": true,
"statusCodes": [
{
"name": "Bad Request",
"comments": "Request is malformed or fails validation. See the status description for more information.",
"code": 400
},
{
"name": "Unauthorized",
"comments": "Authentication failed or you did not provide credentials.",
"code": 401
},
{
"name": "Forbidden",
"comments": "You do not have permission to perform the action.",
"code": 403
},
{
"name": "Not Found",
"comments": "An item you are referring to is not found.",
"code": 404
},
{
"name": "Service Unavailable",
"comments": "The server is too busy to handle the request. Try your request again later.",
"code": 503
},
{
"name": "Internal Error",
"comments": "An internal error occurred; contact support with the error id in the http status description.",
"code": 500
}
],
"request": {
"headers": [],
"isBinary": false,
"hasBody": false
},
"response": {
"headers": [],
"isBinary": false,
"hasBody": false
}
}
]
},
{
"name": "/Webhooks/Test",
"comments": "Webhooks target URLs can be tested using this endpoint.
\nTo test URLs that will handle bounces set AsDeliveryAction to true. When AsDeliveryAction is false the \r\nendpoint will generate the webhook body with parameters that match the open, click, and opt-out webhook bodies.
application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
},
{
"name": "accept",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": false,
"isAccept": true,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "e29a3468c0bf0cfed3a5d9d61aee494a",
"name": "WebhookTestModel",
"logicalName": "Request",
"namespace": "Post",
"fullNamespace": [
"Post"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [
{
"name": "AsDeliveryAction",
"optional": false,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "ForReachMail",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "HttpStatusCode",
"optional": true,
"sampleValue": "0",
"deprecated": false,
"type": {
"name": "int",
"isNullable": false,
"isSimple": true,
"sampleValue": "0",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "HttpReasonMessage",
"optional": true,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Success",
"optional": true,
"sampleValue": "false",
"deprecated": false,
"type": {
"name": "boolean",
"isNullable": false,
"isSimple": true,
"sampleValue": "false",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
},
{
"name": "Url",
"optional": false,
"sampleValue": "",
"deprecated": false,
"type": {
"name": "string",
"isNullable": false,
"isSimple": true,
"sampleValue": "",
"isComplex": false,
"isArray": false,
"isDictionary": false
}
}
],
"isArray": false,
"isDictionary": false
},
"hasBody": true
},
"response": {
"headers": [
{
"name": "Content-Type",
"comments": "application/json ",
"optional": false,
"required": true,
"isContentType": true,
"isAccept": false,
"isAuth": false
}
],
"isBinary": false,
"type": {
"id": "37a14220191bffb049758cb52cb0f878",
"name": "Object",
"logicalName": "Response",
"namespace": "Post",
"fullNamespace": [
"Post"
],
"isNullable": false,
"isSimple": false,
"isComplex": true,
"members": [],
"isArray": false,
"isDictionary": false
},
"hasBody": true
}
}
]
}
]
}
]