schemas = { "API_ActionSchemas" : { "title" : "Retrieve the API action schemas", "description" : "Retrieves the API action schemas. This is derived from the raw content located at /js/api/v2.js . ", "type" : "object", "properties" : {} }, "API_ResponseCodes" : { "title" : "Retrieve the API response codes", "description" : "Retrieves the API response codes.", "type" : "object", "properties" : {} }, "API_Documentation" : { "title" : "Retrieve the API documentation", "description" : "Retrieves the API documentation. This is derived from the raw content located at /js/api/v2.js . ", "type" : "object", "properties" : {} }, "APIKey_Add" : { "title" : "Add an API key", "description" : "Adds an API key. Requires authUsername and authPassword parameters instead of authAPIKey.", "type" : "object", "properties" : { "userId" : { "type" : "integer", "minimum" : 1, "optional" : true }, "label" : { "type" : "string", "optional" : true, "maxLength" : 255 } } }, "APIKey_Expire" : { "title" : "Expire an API key", "description" : "Expires an API key. Requires authUsername and authPassword parameters instead of authAPIKey.", "type" : "object", "properties" : { "apiKey" : { "type" : "string", "pattern" : "[a-zA-z0-9]{16}" } } }, "APIKey_List" : { "title" : "List API keys", "description" : "Lists all API keys. Requires authUsername and authPassword parameters instead of authAPIKey.", "type" : "object", "properties" : { "userId" : { "type" : "integer", "minimum" : 1, "optional" : true } } }, "APIKey_Rename" : { "title" : "Rename API key", "description" : "Renames an API key. Requires authUsername and authPassword parameters instead of authAPIKey.", "type" : "object", "properties" : { "apiKey" : { "type" : "string", "pattern" : "[a-zA-z0-9]{16}" }, "label" : { "description" : "The new label for the key", "type" : "string", "maxLength" : 255 } } }, "User_Add" : { "title" : "Add a user", "description" : "Adds a user.", "type" : "object", "properties" : { "username" : { "type" : "string", "minLength" : 1, "maxLength" : 255 }, "password" : { "description" : "The password must not measure Weak on the strength test.", "type" : "string", "minLength" : 1 }, "contactFirstName" : { "type" : "string", "minLength" : 1, "maxLength" : 32 }, "contactLastName" : { "type" : "string", "minLength" : 1, "maxLength" : 32 }, "contactEmail[]" : { "type" : "array", "minItems" : 1, "items" : { "type" : "string", "format" : "email", "minLength" : 1, "maxLength" : 64 } }, "verifiedEmailAddress[]" : { "description" : "This property is ignored without administrator privileges.", "type" : "array", "optional" : true, "default" : [], "items" : { "type" : "string", "format" : "email", "minLength" : 1, "maxLength" : 64 } }, "websiteURL" : { "type" : "string", "maxLength" : "64", "optional" : true }, "footerLogoLinkHref" : { "description" : "This property is ignored without administrator privileges.", "type" : "string", "maxLength" : "255", "optional" : true }, "footerLogoSrc" : { "description" : "This property is ignored without administrator privileges.", "type" : "string", "maxLength" : "255", "optional" : true }, "businessName" : { "type" : "string", "maxLength" : 64 }, "businessCountry" : { "type" : "string", "default" : "USA", "optional" : true, "enum": [ "USA", "AFG", "ALA", "ALB", "DZA", "ASM", "AND", "AGO", "AIA", "ATA", "ATG", "ARG", "ARM", "ABW", "AUS", "AUT", "AZE", "BHS", "BHR", "BGD", "BRB", "BLR", "BEL", "BLZ", "BEN", "BMU", "BTN", "BOL", "BES", "BIH", "BWA", "BVT", "BRA", "IOT", "BRN", "BGR", "BFA", "BDI", "KHM", "CMR", "CAN", "CPV", "CYM", "CAF", "TCD", "CHL", "CHN", "CXR", "CCK", "COL", "COM", "COG", "COD", "COK", "CRI", "CIV", "HRV", "CUB", "CUW", "CYP", "CZE", "DNK", "DJI", "DMA", "DOM", "ECU", "EGY", "SLV", "GNQ", "ERI", "EST", "ETH", "FLK", "FRO", "FJI", "FIN", "FRA", "GUF", "PYF", "ATF", "GAB", "GMB", "GEO", "DEU", "GHA", "GIB", "GRC", "GRL", "GRD", "GLP", "GUM", "GTM", "GGY", "GIN", "GNB", "GUY", "HTI", "HMD", "VAT", "HND", "HKG", "HUN", "ISL", "IND", "IDN", "IRN", "IRQ", "IRL", "IMN", "ISR", "ITA", "JAM", "JPN", "JEY", "JOR", "KAZ", "KEN", "KIR", "PRK", "KOR", "KWT", "KGZ", "LAO", "LVA", "LBN", "LSO", "LBR", "LBY", "LIE", "LTU", "LUX", "MAC", "MKD", "MDG", "MWI", "MYS", "MDV", "MLI", "MLT", "MHL", "MTQ", "MRT", "MUS", "MYT", "MEX", "FSM", "MDA", "MCO", "MNG", "MNE", "MSR", "MAR", "MOZ", "MMR", "NAM", "NRU", "NPL", "NLD", "NCL", "NZL", "NIC", "NER", "NGA", "NIU", "NFK", "MNP", "NOR", "OMN", "PAK", "PLW", "PSE", "PAN", "PNG", "PRY", "PER", "PHL", "PCN", "POL", "PRT", "PRI", "QAT", "REU", "ROU", "RUS", "RWA", "BLM", "SHN", "KNA", "LCA", "MAF", "SPM", "VCT", "WSM", "SMR", "STP", "SAU", "SEN", "SRB", "SYC", "SLE", "SGP", "SXM", "SVK", "SVN", "SLB", "SOM", "ZAF", "SGS", "SSD", "ESP", "LKA", "SDN", "SUR", "SJM", "SWZ", "SWE", "CHE", "SYR", "TWN", "TJK", "TZA", "THA", "TLS", "TGO", "TKL", "TON", "TTO", "TUN", "TUR", "TKM", "TCA", "TUV", "UGA", "UKR", "ARE", "GBR", "UMI", "URY", "UZB", "VUT", "VEN", "VNM", "VGB", "VIR", "WLF", "ESH", "YEM", "ZMB", "ZWE" ] }, "businessStreetAddress" : { "type" : "string", "maxLength" : 128 }, "businessCity" : { "type" : "string", "maxLength" : 64 }, "businessState" : { "description" : "If businessCountry is not the USA, then use businessStateInternational.", "type" : "string", "maxLength" : 32, "enum" : [ "Alabama", "AL", "Alaska", "AK", "Alberta", "AB", "American Samoa", "AS", "Arizona", "AZ", "Arkansas", "AR", "British Columbia", "BC", "California", "CA", "Colorado", "CO", "Connecticut", "CT", "Delaware", "DE", "District of Columbia", "DC", "Florida", "FL", "Georgia", "GA", "Guam", "GU", "Hawaii", "HI", "Idaho", "ID", "Illinois", "IL", "Indiana", "IN", "Iowa", "IA", "Kansas", "KS", "Kentucky", "KY", "Louisiana", "LA", "Maine", "ME", "Manitoba", "MB", "Maryland", "MD", "Massachusetts", "MA", "Michigan", "MI", "Minnesota", "MN", "Mississippi", "MS", "Missouri", "MO", "Montana", "MT", "Nebraska", "NE", "Nevada", "NV", "New Brunswick", "NB", "New Hampshire", "NH", "New Jersey", "NJ", "New Mexico", "NM", "New York", "NY", "Newfoundland", "NL", "North Carolina", "NC", "North Dakota", "ND", "Northern Mariana Islands", "MP", "North West Territory", "NT", "Nova Scotia", "NS", "Ohio", "OH", "Oklahoma", "OK", "Ontario", "ON", "Oregon", "OR", "Pennsylvania", "PA", "Puerto Rico", "PR", "Quebec", "QC", "Rhode Island", "RI", "Saskatchewan", "SK", "South Carolina", "SC", "South Dakota", "SD", "Tennessee", "TN", "Texas", "TX", "Trust Territories", "TT", "Utah", "UT", "Vermont", "VT", "Virgin Islands", "VI", "Virginia", "VA", "Washington", "WA", "West Virginia", "WV", "Wisconsin", "WI", "Wyoming", "WY", "Yukon", "YT", "Other" ], "optional" : true }, "businessStateInternational" : { "description" : "Will be ignored if businessCountry is the USA.", "type" : "string", "maxLength" : 32, "optional" : true }, "businessZIPCode" : { "type" : "string", "maxLength" : 32 }, "businessPhone" : { "type" : "string", "maxLength" : 32, "optional" : true }, "businessFax" : { "type" : "string", "maxLength" : 32, "optional" : true }, "timeZone" : { "type" : "string", "optional" : true, "default" : "PST8PDT", "enum" : [ "Etc/GMT+12", "Etc/GMT+11", "America/Adak", "Pacific/Honolulu", "Pacific/Marquesas", "America/Anchorage", "Etc/GMT+9", "America/Tijuana", "Etc/GMT+8", "PST8PDT", "America/Phoenix", "America/Chihuahua", "MST7MDT", "Etc/GMT+6", "CST6CDT", "Pacific/Easter", "America/Mexico_City", "America/Regina", "Etc/GMT+5", "America/Cancun", "EST5EDT", "America/Port-au-Prince", "America/Havana", "America/Indianapolis", "America/Asuncion", "America/Halifax", "America/Caracas", "America/Cuibaba", "Etc/GMT+4", "America/Santiago", "America/Grand_Turk", "America/St_Johns", "America/Araguaina", "America/Sao_Paulo", "Etc/GMT+3", "America/Buenos_Aires", "America/Godthab", "America/Montevideo", "America/Punta_Arenas", "America/Miquelon", "America/Bahia", "Etc/GMT+2", "Atlantic/Azores", "Atlantic/Cape_Verde", "Etc/GMT", "Africa/Casablanca", "Europe/London", "Africa/Monrovia", "Europe/Berlin", "Europe/Budapest", "Europe/Paris", "Europe/Warsaw", "Etc/GMT-1", "Asia/Amman", "Europe/Bucharest", "Asia/Beirut", "Africa/Cairo", "Europe/Chisinau", "Asia/Damascus", "Asia/Hebron", "Etc/GMT-2", "Europe/Kiev", "Asia/Jerusalem", "Europe/Kaliningrad", "Africa/Khartoum", "Africa/Tripoli", "Africa/Windhoek", "Asia/Baghdad", "Europe/Istanbul", "Asia/Riyadh", "Europe/Minsk", "Europe/Moscow", "Etc/GMT-3", "Asia/Tehran", "Etc/GMT-4", "Europe/Astrakhan", "Asia/Baku", "Europe/Samara", "Indian/Mauritius", "Europe/Saratov", "Asia/Tbilisi", "Asia/Yerevan", "Asia/Kabul", "Etc/GMT-5", "Asia/Yekaterinburg", "Asia/Karachi", "Asia/Calcutta", "Asia/Colombo", "Asia/Katmandu", "Etc/GMT-6", "Asia/Dhaka", "Asia/Omsk", "Asia/Rangoon", "Etc/GMT-7", "Asia/Barnaul", "Asia/Hovd", "Asia/Krasnoyarsk", "Asia/Novosibirsk", "Asia/Tomsk", "Asia/Shanghai", "Asia/Irkutsk", "Etc/GMT-8", "Australia/Perth", "Asia/Taipei", "Asia/Ulaanbaatar", "Australia/Eucla", "Asia/Chita", "Etc/GMT-9", "Asia/Pyongyang", "Asia/Seoul", "Asia/Yakutsk", "Australia/Adelaide", "Australia/Darwin", "Australia/Brisbane", "Australia/Sydney", "Etc/GMT-10", "Australia/Hobart", "Asia/Vladivostok", "Australia/Lord_Howe", "Pacific/Bougainville", "Asia/Srednekolymsk", "Asia/Magadan", "Pacific/Norfolk", "Asia/Sakhalin", "Etc/GMT-11", "Asia/Kamchatka", "Pacific/Auckland", "Etc/GMT-12", "Pacific/Fiji", "Pacific/Chatham", "Etc/GMT-13", "Pacific/Tongatapu", "Pacific/Apia", "Etc/GMT-14" ] }, "billingCompanyName" : { "type" : "string", "maxLength" : 64, "optional" : true }, "billingCountry" : { "type" : "string", "default" : "USA", "optional" : true, "enum": [ "USA", "AFG", "ALA", "ALB", "DZA", "ASM", "AND", "AGO", "AIA", "ATA", "ATG", "ARG", "ARM", "ABW", "AUS", "AUT", "AZE", "BHS", "BHR", "BGD", "BRB", "BLR", "BEL", "BLZ", "BEN", "BMU", "BTN", "BOL", "BES", "BIH", "BWA", "BVT", "BRA", "IOT", "BRN", "BGR", "BFA", "BDI", "KHM", "CMR", "CAN", "CPV", "CYM", "CAF", "TCD", "CHL", "CHN", "CXR", "CCK", "COL", "COM", "COG", "COD", "COK", "CRI", "CIV", "HRV", "CUB", "CUW", "CYP", "CZE", "DNK", "DJI", "DMA", "DOM", "ECU", "EGY", "SLV", "GNQ", "ERI", "EST", "ETH", "FLK", "FRO", "FJI", "FIN", "FRA", "GUF", "PYF", "ATF", "GAB", "GMB", "GEO", "DEU", "GHA", "GIB", "GRC", "GRL", "GRD", "GLP", "GUM", "GTM", "GGY", "GIN", "GNB", "GUY", "HTI", "HMD", "VAT", "HND", "HKG", "HUN", "ISL", "IND", "IDN", "IRN", "IRQ", "IRL", "IMN", "ISR", "ITA", "JAM", "JPN", "JEY", "JOR", "KAZ", "KEN", "KIR", "PRK", "KOR", "KWT", "KGZ", "LAO", "LVA", "LBN", "LSO", "LBR", "LBY", "LIE", "LTU", "LUX", "MAC", "MKD", "MDG", "MWI", "MYS", "MDV", "MLI", "MLT", "MHL", "MTQ", "MRT", "MUS", "MYT", "MEX", "FSM", "MDA", "MCO", "MNG", "MNE", "MSR", "MAR", "MOZ", "MMR", "NAM", "NRU", "NPL", "NLD", "NCL", "NZL", "NIC", "NER", "NGA", "NIU", "NFK", "MNP", "NOR", "OMN", "PAK", "PLW", "PSE", "PAN", "PNG", "PRY", "PER", "PHL", "PCN", "POL", "PRT", "PRI", "QAT", "REU", "ROU", "RUS", "RWA", "BLM", "SHN", "KNA", "LCA", "MAF", "SPM", "VCT", "WSM", "SMR", "STP", "SAU", "SEN", "SRB", "SYC", "SLE", "SGP", "SXM", "SVK", "SVN", "SLB", "SOM", "ZAF", "SGS", "SSD", "ESP", "LKA", "SDN", "SUR", "SJM", "SWZ", "SWE", "CHE", "SYR", "TWN", "TJK", "TZA", "THA", "TLS", "TGO", "TKL", "TON", "TTO", "TUN", "TUR", "TKM", "TCA", "TUV", "UGA", "UKR", "ARE", "GBR", "UMI", "URY", "UZB", "VUT", "VEN", "VNM", "VGB", "VIR", "WLF", "ESH", "YEM", "ZMB", "ZWE" ] }, "billingStreetAddress" : { "type" : "string", "maxLength" : 128, "optional" : true }, "billingCity" : { "type" : "string", "maxLength" : 64, "optional" : true }, "billingState" : { "description" : "If billingCountry is not the USA, then use billingStateInternational.", "type" : "string", "maxLength" : 32, "optional" : true, "enum" : [ "Alabama", "AL", "Alaska", "AK", "Alberta", "AB", "American Samoa", "AS", "Arizona", "AZ", "Arkansas", "AR", "British Columbia", "BC", "California", "CA", "Colorado", "CO", "Connecticut", "CT", "Delaware", "DE", "District of Columbia", "DC", "Florida", "FL", "Georgia", "GA", "Guam", "GU", "Hawaii", "HI", "Idaho", "ID", "Illinois", "IL", "Indiana", "IN", "Iowa", "IA", "Kansas", "KS", "Kentucky", "KY", "Louisiana", "LA", "Maine", "ME", "Manitoba", "MB", "Maryland", "MD", "Massachusetts", "MA", "Michigan", "MI", "Minnesota", "MN", "Mississippi", "MS", "Missouri", "MO", "Montana", "MT", "Nebraska", "NE", "Nevada", "NV", "New Brunswick", "NB", "New Hampshire", "NH", "New Jersey", "NJ", "New Mexico", "NM", "New York", "NY", "Newfoundland", "NL", "North Carolina", "NC", "North Dakota", "ND", "Northern Mariana Islands", "MP", "North West Territory", "NT", "Nova Scotia", "NS", "Ohio", "OH", "Oklahoma", "OK", "Ontario", "ON", "Oregon", "OR", "Pennsylvania", "PA", "Puerto Rico", "PR", "Quebec", "QC", "Rhode Island", "RI", "Saskatchewan", "SK", "South Carolina", "SC", "South Dakota", "SD", "Tennessee", "TN", "Texas", "TX", "Trust Territories", "TT", "Utah", "UT", "Vermont", "VT", "Virgin Islands", "VI", "Virginia", "VA", "Washington", "WA", "West Virginia", "WV", "Wisconsin", "WI", "Wyoming", "WY", "Yukon", "YT", "Other" ] }, "billingStateInternational" : { "description" : "Will be ignored if billingCountry is the USA.", "type" : "string", "maxLength" : 32, "optional" : true }, "billingZIPCode" : { "type" : "string", "maxLength" : 32, "optional" : true }, "billingPhone" : { "type" : "string", "maxLength" : 32, "optional" : true }, "businessDescription" : { "type" : "string", "maxLength" : 255, "optional" : true }, "businessCategoryId[]" : { "type" : "array", "minItems" : 0, "optional": true, "items" : { "type" : "integer", "minimum" : 0 } }, "businessCategory[]" : { "type" : "array", "minItems" : 0, "optional": true, "items" : { "type" : "string", "enum" : [ "Arts and Artists", "Banking", "Bar", "Business and Finance", "Chambers and Networking", "Computers and Electronics", "Construction", "Consulting", "Corporate", "eCommerce", "Education and Training", "Entertainment", "Events", "Financial", "Golf Course", "Government", "Health and Fitness", "Hobbies", "Home and Garden", "Hospitality", "Insurance", "Legal", "Marketing and Advertising", "Media and Publishing", "Medical/Healthcare and Dental", "Music and Musicians", "Night Club", "Non Profit", "Other", "Photo and Video", "Politics", "Professional Services", "Public Relations", "Real Estate", "Recruitment and Staffing", "Religion", "Restaurant", "Retail", "Schools and Universities", "Service", "Social Networks and Online Communities", "Software and Web Applications", "Sports", "Telecommunications", "Travel and Transportation", "Wedding", "Wholesale" ] } }, "parentUserId" : { "description" : "Use 0 to indicate that this should be a top-level user.", "type" : "integer", "minimum" : 0, "optional" : true }, "accountRepId" : { "description" : "This property is ignored without administrator privileges. If not specified, then this property will be inherited from a parent user.", "type" : "integer", "minimum" : 1, "optional" : true }, "designerId" : { "description" : "This property is ignored without administrator privileges. If not specified, then this property will be inherited from a parent user.", "type" : "integer", "minimum" : 1, "optional" : true }, "birthdayCampaignsEnabled" : { "description" : "This property is ignored without administrator privileges.", "type" : "boolean", "optional" : true, "default" : false }, "anniversaryCampaignsEnabled" : { "description" : "This property is ignored without administrator privileges.", "type" : "boolean", "optional" : true, "default" : false }, "welcomeCampaignsEnabled" : { "description" : "This property is ignored without administrator privileges.", "type" : "boolean", "optional" : true, "default" : false }, "memberFieldCompany" : { "type" : "string", "optional" : true, "default" : "private", "enum" : [ "private", "public" ] }, "memberFieldAddress" : { "type" : "string", "optional" : true, "default" : "private", "enum" : [ "private", "public" ] }, "memberFieldAddress2" : { "type" : "string", "optional" : true, "default" : "private", "enum" : [ "private", "public" ] }, "memberFieldCity" : { "type" : "string", "optional" : true, "default" : "private", "enum" : [ "private", "public" ] }, "memberFieldState" : { "type" : "string", "optional" : true, "default" : "private", "enum" : [ "private", "public" ] }, "memberFieldZip" : { "type" : "string", "optional" : true, "default" : "private", "enum" : [ "private", "public" ] }, "memberFieldPhone" : { "type" : "string", "optional" : true, "default" : "private", "enum" : [ "private", "public" ] }, "memberFieldMobilePhone" : { "type" : "string", "optional" : true, "default" : "private", "enum" : [ "private", "public" ] }, "memberFieldFax" : { "type" : "string", "optional" : true, "default" : "private", "enum" : [ "private", "public" ] }, "memberFieldGender" : { "type" : "string", "optional" : true, "default" : "private", "enum" : [ "private", "public" ] }, "memberDuplicateDetectionFields" : { "type" : "string", "optional" : true, "default" : "email", "enum" : [ "email", "firstName,lastName,email" ] }, "memberOptInReminderEnabled" : { "description" : "This property is ignored without administrator privileges.", "type" : "boolean", "optional" : true, "default" : true }, "memberOptInReminderCustomizationEnabled" : { "description" : "This property is ignored without administrator privileges.", "type" : "boolean", "optional" : true, "default" : false }, "memberOptInReminderPosition" : { "description" : "This property is ignored without administrator privileges.", "type" : "string", "optional" : true, "default" : "top", "enum" : [ "top", "bottom" ] }, "campaignSharing" : { "description" : "This property is ignored without administrator privileges.", "type" : "boolean", "optional" : true, "default" : false }, "dashboardStyle" : { "type" : "string", "optional" : true, "default" : "basic", "enum" : [ "basic", "advanced" ] }, "notes" : { "description" : "This property is ignored without administrator privileges.", "type" : "string", "optional" : true, "maxLength" : 1000 }, "memberExportEnabled" : { "description" : "This property is ignored without administrator privileges. If not specified, then this property will be inherited from a parent user.", "type" : "boolean", "optional" : true, "default" : true }, "templateUploadEnabled" : { "description" : "This property is ignored without administrator privileges. If not specified, then this property will be inherited from a parent user. If not specified for a top-level user, this will default to true.", "type" : "boolean", "optional" : true }, "documentUploadEnabled" : { "description" : "This property is ignored without administrator privileges. If not specified, then this property will be inherited from a parent user. If not specified for a top-level user, then this will default to false.", "type" : "boolean", "optional" : true }, "accountRepDisplayEnabled" : { "description" : "This property is ignored without administrator privileges. If not specified, then this property will be inherited from a parent user. If not specified for a top-level user, then this will default to true.", "type" : "boolean", "optional" : true }, "designerDisplayEnabled" : { "description" : "This property is ignored without administrator privileges. If not specified, then this property will be inherited from a parent user. If not specified for a top-level user, then this will default to true.", "type" : "boolean", "optional" : true }, "fromEmailAddressVerificationRequired" : { "description" : "This property is ignored without administrator privileges.", "type" : "boolean", "optional" : true, "default" : true }, "memberDoubleOptInRequired" : { "description" : "This property is ignored without administrator privileges. If not specified, then this property will be inherited from a parent user. If not specified for a top-level user, then this will default to true.", "type" : "boolean", "optional" : true }, "reCaptchaEnabled" : { "description" : "This property is ignored without administrator privileges.", "type" : "boolean", "optional" : true, "default" : true }, "clickthroughTrackingEnabled" : { "description" : "This property is ignored without administrator privileges.", "type" : "boolean", "optional" : true, "default" : true }, "mailtoClickthroughTrackingEnabled" : { "type" : "boolean", "optional" : true, "default" : true }, "saveAsTemplateEnabled" : { "description" : "This property is ignored without administrator privileges.", "type" : "boolean", "optional" : true, "default" : true }, "legacyTemplatesEnabled" : { "description" : "This property is ignored without administrator privileges.", "type" : "boolean", "optional" : true, "default" : false }, "memberDeactivationConsecutiveColdSoftBounceLimit" : { "description" : "This property is ignored without administrator privileges.", "type" : "integer", "optional" : true, "default" : 8, "minimum" : 1, "maximum" : 12 }, "memberDeactivationConsecutiveHotSoftBounceLimit" : { "description" : "This property is ignored without administrator privileges.", "type" : "integer", "optional" : true, "default" : 16, "minimum" : 1, "maximum" : 20 }, "memberDeactivationConsecutiveHardBounceLimit" : { "description" : "This property is ignored without administrator privileges.", "type" : "integer", "optional" : true, "default" : 1, "minimum" : 1, "maximum" : 5 }, "businessNameChangeEnabled" : { "description" : "This property is ignored without administrator privileges. Only affects users who signed up online, i.e. whose onlineSignup property is true.", "type" : "boolean", "optional" : true, "default" : false }, "accountMenuEnabled" : { "description" : "This property is ignored without administrator privileges. Only affects users who did not sign up online, i.e. whose onlineSignup property is false.", "type" : "boolean", "optional" : true, "default" : true }, "campaignsMenuEnabled" : { "description" : "This property is ignored without administrator privileges. Only affects users who did not sign up online, i.e. whose onlineSignup property is false.", "type" : "boolean", "optional" : true, "default" : true }, "reportsMenuEnabled" : { "description" : "This property is ignored without administrator privileges. Only affects users who did not sign up online, i.e. whose onlineSignup property is false.", "type" : "boolean", "optional" : true, "default" : true }, "domain" : { "description" : "This property is ignored without administrator privileges. Only applicable when multiple domains are enabled. A top-level user is allowed to have a different domain than the admin. A sub-user must have the same domain as the parent user.", "type" : "string", "optional" : true, "maxLength" : 255 }, "userLogoURL" : { "type" : "string", "optional" : true }, "userLogo2URL" : { "type" : "string", "optional" : true }, "socialLogoURL" : { "type" : "string", "optional" : true }, "recurringSendingEnabled" : { "type" : "boolean", "optional" : true, "default" : false }, "excludeUnengagedGmailMembersEnabled" : { "type" : "boolean", "optional" : true, "default" : false }, "footerDesignDefaults" : { "type" : "object", "optional" : true, "properties" : { "logo" : { "type" : "boolean", "optional" : true } } }, "initialCategory" : { "type" : "object", "optional" : true, "properties" : { "name" : { "type" : "string", "minLength" : 1, "maxLength" : 255 }, "publicDisplay" : { "type" : "boolean", "optional" : true, "default" : true } }, "default" : { "name" : "Monthly Newsletter", "publicDisplay" : true } }, "initialCampaign" : { "type" : "object", "optional" : true, "properties" : { "name" : { "type" : "string", "maxLength" : 255 }, "googleAnalytics" : { "type" : "boolean", "optional" : true, "default" : false }, "authentication" : { "type" : "boolean", "optional" : true, "default" : false }, "publicDisplay" : { "type" : "boolean", "optional" : true, "default" : false } } } } }, "User_Update" : { "title" : "Update a user", "description" : "Updates a user.", "type" : "object", "properties" : { "id" : { "type" : "integer", "minimum" : 1 }, "username" : { "description" : "This property can also apply to the admin account.", "type" : "string", "minLength" : 1, "maxLength" : 255, "optional" : true }, "password" : { "description" : "The password must not measure Weak on the strength test. This property can also apply to the admin account.", "type" : "string", "minLength" : 1, "optional" : true }, "contactFirstName" : { "description" : "This property can also apply to the admin account.", "type" : "string", "minLength" : 1, "maxLength" : 32, "optional" : true }, "contactLastName" : { "description" : "This property can also apply to the admin account.", "type" : "string", "minLength" : 1, "maxLength" : 32, "optional" : true }, "contactEmail[]" : { "description" : "This property can also apply to the admin account.", "type" : "array", "minItems" : 1, "items" : { "type" : "string", "format" : "email", "minLength" : 1, "maxLength" : 64 }, "optional" : true }, "verifiedEmailAddress[]" : { "description" : "This property is ignored without administrator privileges.", "type" : "array", "optional" : true, "items" : { "type" : "string", "format" : "email", "minLength" : 1, "maxLength" : 64 } }, "websiteURL" : { "type" : "string", "maxLength" : "64", "optional" : true }, "footerLogoLinkHref" : { "description" : "This property is ignored without administrator privileges.", "type" : "string", "maxLength" : "255", "optional" : true }, "footerLogoSrc" : { "description" : "This property is ignored without administrator privileges.", "type" : "string", "maxLength" : "255", "optional" : true }, "businessName" : { "description" : "This property can also apply to the admin account.", "type" : "string", "maxLength" : 64, "optional" : true }, "businessCountry" : { "description" : "This property can also apply to the admin account.", "type" : "string", "optional" : true, "enum": [ "USA", "AFG", "ALA", "ALB", "DZA", "ASM", "AND", "AGO", "AIA", "ATA", "ATG", "ARG", "ARM", "ABW", "AUS", "AUT", "AZE", "BHS", "BHR", "BGD", "BRB", "BLR", "BEL", "BLZ", "BEN", "BMU", "BTN", "BOL", "BES", "BIH", "BWA", "BVT", "BRA", "IOT", "BRN", "BGR", "BFA", "BDI", "KHM", "CMR", "CAN", "CPV", "CYM", "CAF", "TCD", "CHL", "CHN", "CXR", "CCK", "COL", "COM", "COG", "COD", "COK", "CRI", "CIV", "HRV", "CUB", "CUW", "CYP", "CZE", "DNK", "DJI", "DMA", "DOM", "ECU", "EGY", "SLV", "GNQ", "ERI", "EST", "ETH", "FLK", "FRO", "FJI", "FIN", "FRA", "GUF", "PYF", "ATF", "GAB", "GMB", "GEO", "DEU", "GHA", "GIB", "GRC", "GRL", "GRD", "GLP", "GUM", "GTM", "GGY", "GIN", "GNB", "GUY", "HTI", "HMD", "VAT", "HND", "HKG", "HUN", "ISL", "IND", "IDN", "IRN", "IRQ", "IRL", "IMN", "ISR", "ITA", "JAM", "JPN", "JEY", "JOR", "KAZ", "KEN", "KIR", "PRK", "KOR", "KWT", "KGZ", "LAO", "LVA", "LBN", "LSO", "LBR", "LBY", "LIE", "LTU", "LUX", "MAC", "MKD", "MDG", "MWI", "MYS", "MDV", "MLI", "MLT", "MHL", "MTQ", "MRT", "MUS", "MYT", "MEX", "FSM", "MDA", "MCO", "MNG", "MNE", "MSR", "MAR", "MOZ", "MMR", "NAM", "NRU", "NPL", "NLD", "NCL", "NZL", "NIC", "NER", "NGA", "NIU", "NFK", "MNP", "NOR", "OMN", "PAK", "PLW", "PSE", "PAN", "PNG", "PRY", "PER", "PHL", "PCN", "POL", "PRT", "PRI", "QAT", "REU", "ROU", "RUS", "RWA", "BLM", "SHN", "KNA", "LCA", "MAF", "SPM", "VCT", "WSM", "SMR", "STP", "SAU", "SEN", "SRB", "SYC", "SLE", "SGP", "SXM", "SVK", "SVN", "SLB", "SOM", "ZAF", "SGS", "SSD", "ESP", "LKA", "SDN", "SUR", "SJM", "SWZ", "SWE", "CHE", "SYR", "TWN", "TJK", "TZA", "THA", "TLS", "TGO", "TKL", "TON", "TTO", "TUN", "TUR", "TKM", "TCA", "TUV", "UGA", "UKR", "ARE", "GBR", "UMI", "URY", "UZB", "VUT", "VEN", "VNM", "VGB", "VIR", "WLF", "ESH", "YEM", "ZMB", "ZWE" ] }, "businessStreetAddress" : { "description" : "This property can also apply to the admin account.", "type" : "string", "maxLength" : 128, "optional" : true }, "businessCity" : { "description" : "This property can also apply to the admin account.", "type" : "string", "maxLength" : 64, "optional" : true }, "businessState" : { "description" : "If businessCountry is not the USA, then use businessStateInternational. This property can also apply to the admin account.", "type" : "string", "maxLength" : 32, "enum" : [ "Alabama", "AL", "Alaska", "AK", "Alberta", "AB", "American Samoa", "AS", "Arizona", "AZ", "Arkansas", "AR", "British Columbia", "BC", "California", "CA", "Colorado", "CO", "Connecticut", "CT", "Delaware", "DE", "District of Columbia", "DC", "Florida", "FL", "Georgia", "GA", "Guam", "GU", "Hawaii", "HI", "Idaho", "ID", "Illinois", "IL", "Indiana", "IN", "Iowa", "IA", "Kansas", "KS", "Kentucky", "KY", "Louisiana", "LA", "Maine", "ME", "Manitoba", "MB", "Maryland", "MD", "Massachusetts", "MA", "Michigan", "MI", "Minnesota", "MN", "Mississippi", "MS", "Missouri", "MO", "Montana", "MT", "Nebraska", "NE", "Nevada", "NV", "New Brunswick", "NB", "New Hampshire", "NH", "New Jersey", "NJ", "New Mexico", "NM", "New York", "NY", "Newfoundland", "NL", "North Carolina", "NC", "North Dakota", "ND", "Northern Mariana Islands", "MP", "North West Territory", "NT", "Nova Scotia", "NS", "Ohio", "OH", "Oklahoma", "OK", "Ontario", "ON", "Oregon", "OR", "Pennsylvania", "PA", "Puerto Rico", "PR", "Quebec", "QC", "Rhode Island", "RI", "Saskatchewan", "SK", "South Carolina", "SC", "South Dakota", "SD", "Tennessee", "TN", "Texas", "TX", "Trust Territories", "TT", "Utah", "UT", "Vermont", "VT", "Virgin Islands", "VI", "Virginia", "VA", "Washington", "WA", "West Virginia", "WV", "Wisconsin", "WI", "Wyoming", "WY", "Yukon", "YT", "Other" ], "optional" : true }, "businessStateInternational" : { "description" : "Will be ignored if businessCountry is the USA. This property can also apply to the admin account.", "type" : "string", "maxLength" : 32, "optional" : true }, "businessZIPCode" : { "description" : "This property can also apply to the admin account.", "type" : "string", "maxLength" : 32, "optional" : true }, "businessPhone" : { "description" : "This property can also apply to the admin account.", "type" : "string", "maxLength" : 32, "optional" : true }, "businessFax" : { "description" : "This property can also apply to the admin account.", "type" : "string", "maxLength" : 32, "optional" : true }, "billingId" : { "description" : "This is only set for automated billing users.", "type" : "string", "maxLength" : 32, "optional" : true }, "timeZone" : { "description" : "This property can also apply to the admin account.", "type" : "string", "optional" : true, "enum" : [ "Etc/GMT+12", "Etc/GMT+11", "America/Adak", "Pacific/Honolulu", "Pacific/Marquesas", "America/Anchorage", "Etc/GMT+9", "America/Tijuana", "Etc/GMT+8", "PST8PDT", "America/Phoenix", "America/Chihuahua", "MST7MDT", "Etc/GMT+6", "CST6CDT", "Pacific/Easter", "America/Mexico_City", "America/Regina", "Etc/GMT+5", "America/Cancun", "EST5EDT", "America/Port-au-Prince", "America/Havana", "America/Indianapolis", "America/Asuncion", "America/Halifax", "America/Caracas", "America/Cuibaba", "Etc/GMT+4", "America/Santiago", "America/Grand_Turk", "America/St_Johns", "America/Araguaina", "America/Sao_Paulo", "Etc/GMT+3", "America/Buenos_Aires", "America/Godthab", "America/Montevideo", "America/Punta_Arenas", "America/Miquelon", "America/Bahia", "Etc/GMT+2", "Atlantic/Azores", "Atlantic/Cape_Verde", "Etc/GMT", "Africa/Casablanca", "Europe/London", "Africa/Monrovia", "Europe/Berlin", "Europe/Budapest", "Europe/Paris", "Europe/Warsaw", "Etc/GMT-1", "Asia/Amman", "Europe/Bucharest", "Asia/Beirut", "Africa/Cairo", "Europe/Chisinau", "Asia/Damascus", "Asia/Hebron", "Etc/GMT-2", "Europe/Kiev", "Asia/Jerusalem", "Europe/Kaliningrad", "Africa/Khartoum", "Africa/Tripoli", "Africa/Windhoek", "Asia/Baghdad", "Europe/Istanbul", "Asia/Riyadh", "Europe/Minsk", "Europe/Moscow", "Etc/GMT-3", "Asia/Tehran", "Etc/GMT-4", "Europe/Astrakhan", "Asia/Baku", "Europe/Samara", "Indian/Mauritius", "Europe/Saratov", "Asia/Tbilisi", "Asia/Yerevan", "Asia/Kabul", "Etc/GMT-5", "Asia/Yekaterinburg", "Asia/Karachi", "Asia/Calcutta", "Asia/Colombo", "Asia/Katmandu", "Etc/GMT-6", "Asia/Dhaka", "Asia/Omsk", "Asia/Rangoon", "Etc/GMT-7", "Asia/Barnaul", "Asia/Hovd", "Asia/Krasnoyarsk", "Asia/Novosibirsk", "Asia/Tomsk", "Asia/Shanghai", "Asia/Irkutsk", "Etc/GMT-8", "Australia/Perth", "Asia/Taipei", "Asia/Ulaanbaatar", "Australia/Eucla", "Asia/Chita", "Etc/GMT-9", "Asia/Pyongyang", "Asia/Seoul", "Asia/Yakutsk", "Australia/Adelaide", "Australia/Darwin", "Australia/Brisbane", "Australia/Sydney", "Etc/GMT-10", "Australia/Hobart", "Asia/Vladivostok", "Australia/Lord_Howe", "Pacific/Bougainville", "Asia/Srednekolymsk", "Asia/Magadan", "Pacific/Norfolk", "Asia/Sakhalin", "Etc/GMT-11", "Asia/Kamchatka", "Pacific/Auckland", "Etc/GMT-12", "Pacific/Fiji", "Pacific/Chatham", "Etc/GMT-13", "Pacific/Tongatapu", "Pacific/Apia", "Etc/GMT-14" ] }, "billingCompanyName" : { "description" : "This property can also apply to the admin account.", "type" : "string", "maxLength" : 64, "optional" : true }, "billingCountry" : { "description" : "This property can also apply to the admin account.", "type" : "string", "optional" : true, "enum": [ "USA", "AFG", "ALA", "ALB", "DZA", "ASM", "AND", "AGO", "AIA", "ATA", "ATG", "ARG", "ARM", "ABW", "AUS", "AUT", "AZE", "BHS", "BHR", "BGD", "BRB", "BLR", "BEL", "BLZ", "BEN", "BMU", "BTN", "BOL", "BES", "BIH", "BWA", "BVT", "BRA", "IOT", "BRN", "BGR", "BFA", "BDI", "KHM", "CMR", "CAN", "CPV", "CYM", "CAF", "TCD", "CHL", "CHN", "CXR", "CCK", "COL", "COM", "COG", "COD", "COK", "CRI", "CIV", "HRV", "CUB", "CUW", "CYP", "CZE", "DNK", "DJI", "DMA", "DOM", "ECU", "EGY", "SLV", "GNQ", "ERI", "EST", "ETH", "FLK", "FRO", "FJI", "FIN", "FRA", "GUF", "PYF", "ATF", "GAB", "GMB", "GEO", "DEU", "GHA", "GIB", "GRC", "GRL", "GRD", "GLP", "GUM", "GTM", "GGY", "GIN", "GNB", "GUY", "HTI", "HMD", "VAT", "HND", "HKG", "HUN", "ISL", "IND", "IDN", "IRN", "IRQ", "IRL", "IMN", "ISR", "ITA", "JAM", "JPN", "JEY", "JOR", "KAZ", "KEN", "KIR", "PRK", "KOR", "KWT", "KGZ", "LAO", "LVA", "LBN", "LSO", "LBR", "LBY", "LIE", "LTU", "LUX", "MAC", "MKD", "MDG", "MWI", "MYS", "MDV", "MLI", "MLT", "MHL", "MTQ", "MRT", "MUS", "MYT", "MEX", "FSM", "MDA", "MCO", "MNG", "MNE", "MSR", "MAR", "MOZ", "MMR", "NAM", "NRU", "NPL", "NLD", "NCL", "NZL", "NIC", "NER", "NGA", "NIU", "NFK", "MNP", "NOR", "OMN", "PAK", "PLW", "PSE", "PAN", "PNG", "PRY", "PER", "PHL", "PCN", "POL", "PRT", "PRI", "QAT", "REU", "ROU", "RUS", "RWA", "BLM", "SHN", "KNA", "LCA", "MAF", "SPM", "VCT", "WSM", "SMR", "STP", "SAU", "SEN", "SRB", "SYC", "SLE", "SGP", "SXM", "SVK", "SVN", "SLB", "SOM", "ZAF", "SGS", "SSD", "ESP", "LKA", "SDN", "SUR", "SJM", "SWZ", "SWE", "CHE", "SYR", "TWN", "TJK", "TZA", "THA", "TLS", "TGO", "TKL", "TON", "TTO", "TUN", "TUR", "TKM", "TCA", "TUV", "UGA", "UKR", "ARE", "GBR", "UMI", "URY", "UZB", "VUT", "VEN", "VNM", "VGB", "VIR", "WLF", "ESH", "YEM", "ZMB", "ZWE" ] }, "billingStreetAddress" : { "description" : "This property can also apply to the admin account.", "type" : "string", "maxLength" : 128, "optional" : true }, "billingCity" : { "description" : "This property can also apply to the admin account.", "type" : "string", "maxLength" : 64, "optional" : true }, "billingState" : { "description" : "If billingCountry is not the USA, then use billingStateInternational. This property can also apply to the admin account.", "type" : "string", "maxLength" : 32, "optional" : true, "enum" : [ "Alabama", "AL", "Alaska", "AK", "Alberta", "AB", "American Samoa", "AS", "Arizona", "AZ", "Arkansas", "AR", "British Columbia", "BC", "California", "CA", "Colorado", "CO", "Connecticut", "CT", "Delaware", "DE", "District of Columbia", "DC", "Florida", "FL", "Georgia", "GA", "Guam", "GU", "Hawaii", "HI", "Idaho", "ID", "Illinois", "IL", "Indiana", "IN", "Iowa", "IA", "Kansas", "KS", "Kentucky", "KY", "Louisiana", "LA", "Maine", "ME", "Manitoba", "MB", "Maryland", "MD", "Massachusetts", "MA", "Michigan", "MI", "Minnesota", "MN", "Mississippi", "MS", "Missouri", "MO", "Montana", "MT", "Nebraska", "NE", "Nevada", "NV", "New Brunswick", "NB", "New Hampshire", "NH", "New Jersey", "NJ", "New Mexico", "NM", "New York", "NY", "Newfoundland", "NL", "North Carolina", "NC", "North Dakota", "ND", "Northern Mariana Islands", "MP", "North West Territory", "NT", "Nova Scotia", "NS", "Ohio", "OH", "Oklahoma", "OK", "Ontario", "ON", "Oregon", "OR", "Pennsylvania", "PA", "Puerto Rico", "PR", "Quebec", "QC", "Rhode Island", "RI", "Saskatchewan", "SK", "South Carolina", "SC", "South Dakota", "SD", "Tennessee", "TN", "Texas", "TX", "Trust Territories", "TT", "Utah", "UT", "Vermont", "VT", "Virgin Islands", "VI", "Virginia", "VA", "Washington", "WA", "West Virginia", "WV", "Wisconsin", "WI", "Wyoming", "WY", "Yukon", "YT", "Other" ] }, "billingStateInternational" : { "description" : "Will be ignored if billingCountry is the USA. This property can also apply to the admin account.", "type" : "string", "maxLength" : 32, "optional" : true }, "billingZIPCode" : { "description" : "This property can also apply to the admin account.", "type" : "string", "maxLength" : 32, "optional" : true }, "billingPhone" : { "description" : "This property can also apply to the admin account.", "type" : "string", "maxLength" : 32, "optional" : true }, "businessDescription" : { "description" : "This property can also apply to the admin account.", "type" : "string", "maxLength" : 255, "optional" : true }, "businessCategoryId[]" : { "description" : "This property can also apply to the admin account.", "type" : "array", "minItems" : 0, "optional": true, "items" : { "type" : "integer", "minimum" : 0 } }, "businessCategory[]" : { "description" : "This property can also apply to the admin account.", "type" : "array", "minItems" : 0, "optional": true, "items" : { "type" : "string", "enum" : [ "Arts and Artists", "Banking", "Bar", "Business and Finance", "Chambers and Networking", "Computers and Electronics", "Construction", "Consulting", "Corporate", "eCommerce", "Education and Training", "Entertainment", "Events", "Financial", "Golf Course", "Government", "Health and Fitness", "Hobbies", "Home and Garden", "Hospitality", "Insurance", "Legal", "Marketing and Advertising", "Media and Publishing", "Medical/Healthcare and Dental", "Music and Musicians", "Night Club", "Non Profit", "Other", "Photo and Video", "Politics", "Professional Services", "Public Relations", "Real Estate", "Recruitment and Staffing", "Religion", "Restaurant", "Retail", "Schools and Universities", "Service", "Social Networks and Online Communities", "Software and Web Applications", "Sports", "Telecommunications", "Travel and Transportation", "Wedding", "Wholesale" ] } }, "parentUserId" : { "description" : "This property is ignored without administrator privileges. Use 0 to indicate that this should be a top-level user.", "type" : "integer", "minimum" : 0, "optional" : true }, "accountRepId" : { "description" : "This property is ignored without administrator privileges.", "type" : "integer", "minimum" : 1, "optional" : true }, "designerId" : { "description" : "This property is ignored without administrator privileges.", "type" : "integer", "minimum" : 1, "optional" : true }, "birthdayCampaignsEnabled" : { "description" : "This property is ignored without administrator privileges.", "type" : "boolean", "optional" : true }, "anniversaryCampaignsEnabled" : { "description" : "This property is ignored without administrator privileges.", "type" : "boolean", "optional" : true }, "welcomeCampaignsEnabled" : { "description" : "This property is ignored without administrator privileges.", "type" : "boolean", "optional" : true }, "memberFieldCompany" : { "type" : "string", "optional" : true, "enum" : [ "private", "public" ] }, "memberFieldAddress" : { "type" : "string", "optional" : true, "enum" : [ "private", "public" ] }, "memberFieldAddress2" : { "type" : "string", "optional" : true, "enum" : [ "private", "public" ] }, "memberFieldCity" : { "type" : "string", "optional" : true, "enum" : [ "private", "public" ] }, "memberFieldState" : { "type" : "string", "optional" : true, "enum" : [ "private", "public" ] }, "memberFieldZip" : { "type" : "string", "optional" : true, "enum" : [ "private", "public" ] }, "memberFieldPhone" : { "type" : "string", "optional" : true, "enum" : [ "private", "public" ] }, "memberFieldMobilePhone" : { "type" : "string", "optional" : true, "enum" : [ "private", "public" ] }, "memberFieldFax" : { "type" : "string", "optional" : true, "enum" : [ "private", "public" ] }, "memberFieldGender" : { "type" : "string", "optional" : true, "enum" : [ "private", "public" ] }, "memberDuplicateDetectionFields" : { "type" : "string", "optional" : true, "enum" : [ "email", "firstName,lastName,email" ] }, "memberOptInReminderEnabled" : { "description" : "This property is ignored without administrator privileges.", "type" : "boolean", "optional" : true }, "memberOptInReminderCustomizationEnabled" : { "description" : "This property is ignored without administrator privileges.", "type" : "boolean", "optional" : true }, "memberOptInReminderPosition" : { "description" : "This property is ignored without administrator privileges.", "type" : "string", "optional" : true, "enum" : [ "top", "bottom" ] }, "campaignSharing" : { "description" : "This property is ignored without administrator privileges.", "type" : "boolean", "optional" : true }, "dashboardStyle" : { "type" : "string", "optional" : true, "enum" : [ "basic", "advanced" ] }, "additionalNotes" : { "description" : "This property is ignored without administrator privileges. This is only new notes to append to existing notes.", "type" : "string", "optional" : true, "maxLength" : 1000 }, "memberExportEnabled" : { "description" : "This property is ignored without administrator privileges.", "type" : "boolean", "optional" : true }, "templateUploadEnabled" : { "description" : "This property is ignored without administrator privileges.", "type" : "boolean", "optional" : true }, "documentUploadEnabled" : { "description" : "This property is ignored without administrator privileges.", "type" : "boolean", "optional" : true }, "accountRepDisplayEnabled" : { "description" : "This property is ignored without administrator privileges.", "type" : "boolean", "optional" : true }, "designerDisplayEnabled" : { "description" : "This property is ignored without administrator privileges.", "type" : "boolean", "optional" : true }, "fromEmailAddressVerificationRequired" : { "description" : "This property is ignored without administrator privileges.", "type" : "boolean", "optional" : true }, "memberDoubleOptInRequired" : { "description" : "This property is ignored without administrator privileges.", "type" : "boolean", "optional" : true }, "reCaptchaEnabled" : { "description" : "This property is ignored without administrator privileges.", "type" : "boolean", "optional" : true }, "clickthroughTrackingEnabled" : { "description" : "This property is ignored without administrator privileges.", "type" : "boolean", "optional" : true }, "mailtoClickthroughTrackingEnabled" : { "type" : "boolean", "optional" : true }, "saveAsTemplateEnabled" : { "description" : "This property is ignored without administrator privileges.", "type" : "boolean", "optional" : true }, "legacyTemplatesEnabled" : { "description" : "This property is ignored without administrator privileges.", "type" : "boolean", "optional" : true }, "memberDeactivationConsecutiveColdSoftBounceLimit" : { "description" : "This property is ignored without administrator privileges.", "type" : "integer", "optional" : true, "minimum" : 1, "maximum" : 12 }, "memberDeactivationConsecutiveHotSoftBounceLimit" : { "description" : "This property is ignored without administrator privileges.", "type" : "integer", "optional" : true, "minimum" : 1, "maximum" : 20 }, "memberDeactivationConsecutiveHardBounceLimit" : { "description" : "This property is ignored without administrator privileges.", "type" : "integer", "optional" : true, "minimum" : 1, "maximum" : 5 }, "businessNameChangeEnabled" : { "description" : "This property is ignored without administrator privileges. Only affects users who signed up online, i.e. whose onlineSignup property is true.", "type" : "boolean", "optional" : true }, "accountMenuEnabled" : { "description" : "This property is ignored without administrator privileges. Only affects users who did not sign up online, i.e. whose onlineSignup property is false.", "type" : "boolean", "optional" : true }, "campaignsMenuEnabled" : { "description" : "This property is ignored without administrator privileges. Only affects users who did not sign up online, i.e. whose onlineSignup property is false.", "type" : "boolean", "optional" : true }, "reportsMenuEnabled" : { "description" : "This property is ignored without administrator privileges. Only affects users who did not sign up online, i.e. whose onlineSignup property is false.", "type" : "boolean", "optional" : true }, "domain" : { "description" : "This property is ignored without administrator privileges. Only applicable when multiple domains are enabled. A top-level user is allowed to have a different domain than the admin. A sub-user must have the same domain as the parent user.", "type" : "string", "optional" : true, "maxLength" : 255 }, "userLogoURL" : { "type" : "string", "optional" : true }, "userLogo2URL" : { "type" : "string", "optional" : true }, "socialLogoURL" : { "type" : "string", "optional" : true }, "userLogo": { "type": "object", "optional": true, "properties": { "filename" : { "type" : "string", "description" : "The logo file's name." }, "content" : { "type" : "string", "description" : "The Base64 encoded content of the logo file.", "pattern" : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" } } }, "userLogo2": { "type": "object", "optional": true, "properties": { "filename" : { "type" : "string", "description" : "The second logo file's name." }, "content" : { "type" : "string", "description" : "The Base64 encoded content of the second logo file.", "pattern" : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" } } }, "socialLogo": { "type": "object", "optional": true, "properties": { "filename" : { "type" : "string", "description" : "The social share logo file's name." }, "content" : { "type" : "string", "description" : "The Base64 encoded content of the social share logo file.", "pattern" : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" } } }, "recurringSendingEnabled" : { "type" : "boolean", "optional" : true }, "excludeUnengagedGmailMembersEnabled" : { "type" : "boolean", "optional" : true }, "footerDesignDefaults" : { "type" : "object", "optional" : true, "properties" : { "logo" : { "type" : "boolean", "optional" : true } } }, "applyToSubUsers" : { "description" : "This property is ignored without administrator privileges.", "type" : "array", "optional" : true, "items" : { "type" : "string", "enum" : [ "accountRepDisplayEnabled", "designerDisplayEnabled", "fromEmailAddressVerificationRequired", "saveAsTemplateEnabled", "templateUploadEnabled", "documentUploadEnabled", "birthdayCampaignsEnabled", "anniversaryCampaignsEnabled", "welcomeCampaignsEnabled", "memberExportEnabled", "memberDoubleOptInRequired", "reCaptchaEnabled" ] } } } }, "User_List" : { "title" : "List users", "description" : "Lists users and subusers. Only one of id[], username or email may be specified. Invoke with no parameters to retrieve the entire user list.", "type" : "object", "properties" : { "id[]" : { "type" : "array", "optional" : true, "items" : { "type" : "integer", "minimum" : 1 } }, "username" : { "type" : "string", "optional" : true }, "email" : { "type" : "string", "optional" : true } } }, "User_AuthenticateDKIMDomain" : { "title" : "Attempt to authenticate a DKIM domain", "description" : "Attempts to authenticate a DKIM domain.", "type" : "object", "properties" : { "userId" : { "type" : "integer", "minimum" : 1, "optional" : true }, "domain" : { "type" : "string", "minLength" : 1 } } }, "User_RemoveDKIMDomain" : { "title" : "Remove an authenticated DKIM domain", "description" : "Removes an authenticated DKIM domain.", "type" : "object", "properties" : { "userId" : { "type" : "integer", "minimum" : 1, "optional" : true }, "domain" : { "type" : "string", "minLength" : 1 } } }, "User_Dashboard_List" : { "title" : "List dashboard configurations for a user", "description" : "Lists dashboard configurations for a user.", "type" : "object", "properties": { "userId" : { "type" : "integer", "minimum" : 1, "optional" : true }, "type" : { "type" : "string", "maxLength" : 64, "optional" : true } } }, "User_Dashboard_Update" : { "title" : "Update a dashboard configurations for a user", "description" : "Updates a dashboard configurations for a user.", "type" : "object", "properties": { "userId" : { "type" : "integer", "minimum" : 1, "optional" : true }, "type" : { "type" : "string", "maxLength" : 64 }, "data" : { "type" : "array", "items": { "type" : "object" } } } }, "Member_Add" : { "title" : "Add a member", "description" : "
Adds a member.
If you are sure that the contact information to be sent to this endpoint was submitted to you by a person, either because the contact information is coming from another system that has already verified the authenticity of the contact, or you have implemented CAPTCHA or a Honeypot on whatever public HTML form you are using to collect the information, simply specify skipCaptcha=true
when calling this endpoint.
If you are NOT sure that the contact information to be sent to this endpoint was submitted to you by a person, you MUST implement a CAPTCHA or Honeypot on the public facing HTML form used to collect information. Once you do this, you may use <code>skipCaptcha=true</code> as explained above.
One option to implement CAPTCHA on a public facing HTML form would be to use our builtin CAPTCHA backend. To do so, follow the following procedure:
If the Member_Add operation fails due to the builtin CAPTCHA detecting a bot, it will return the ResponseCode MEMBER_BOT_DETECTED_BY_RECAPTCHA.
NOTE: If using our builtin CAPTCHA, do NOT specify the skipCaptcha parameter!
", "type" : "object", "properties" : { "userId" : { "type" : "integer", "minimum" : 1, "optional" : true }, "firstName" : { "type" : "string", "maxLength" : 64, "optional" : true }, "lastName" : { "type" : "string", "maxLength" : 64, "optional" : true }, "email" : { "type" : "string", "format" : "email", "minLength" : 1, "maxLength" : 64 }, "company" : { "type" : "string", "maxLength" : 255, "optional" : true }, "address" : { "type" : "string", "maxLength" : 255, "optional" : true }, "address2" : { "type" : "string", "maxLength" : 64, "optional" : true }, "city" : { "type" : "string", "maxLength" : 64, "optional" : true }, "state" : { "type" : "string", "maxLength" : 64, "optional" : true }, "zip" : { "type" : "string", "maxLength" : 64, "optional" : true }, "mobilePhone" : { "type" : "string", "maxLength" : 64, "optional" : true }, "phone" : { "type" : "string", "maxLength" : 64, "optional" : true }, "fax" : { "type" : "string", "maxLength" : 64, "optional" : true }, "gender" : { "type" : "string", "maxLength" : 64, "optional" : true }, "birthDate" : { "description" : "This is not affected by useUTC.", "type" : "string", "pattern" : "(\\d{4}-)?\\d{2}-\\d{2}", "optional" : true }, "anniversaryDate" : { "description" : "This is not affected by useUTC.", "type" : "string", "pattern" : "(\\d{4}-)?\\d{2}-\\d{2}", "optional" : true }, "categoryId[]" : { "type" : "array", "items" : { "type" : "integer", "minimum" : 1 } }, "customField[]" : { "type" : "array", "items" : { "type" : "object", "properties" : { "id": { "description" : "Either id or name must be specified.", "type" : "integer", "minimum" : 1, "optional" : true }, "name" : { "description" : "Either id or name must be specified.", "type" : "string", "minLength" : 1, "maxLength" : 255, "optional" : true }, "value" : { "description" : "If type is date, then use pattern (\\d{4}-)?\\d{2}-\\d{2}", "type" : "string", "minLength" : 0, "maxLength" : 255 } } }, "optional" : true }, "updateIfExists" : { "type" : "boolean", "optional" : true, "default" : false }, "replaceCategories" : { "description" : "Indicates how the categoryId[] parameter should be handled:Adds a referral.
If you are sure that the referral information to be sent to this endpoint was submitted to you by a person, either because the referral information is coming from another system that has already verified the authenticity of the referral, or you have implemented CAPTCHA or a Honeypot on whatever public HTML form you are using to collect the information, simply specify skipCaptcha=true
when calling this endpoint.
If you are NOT sure that the referral information to be sent to this endpoint was submitted to you by a person, you MUST implement a CAPTCHA or Honeypot on the public facing HTML form used to collect information. Once you do this, you may use <code>skipCaptcha=true</code> as explained above.
One option to implement CAPTCHA on a public facing HTML form would be to use our builtin CAPTCHA backend. To do so, follow the following procedure:
If the Referral_Add operation fails due to the builtin CAPTCHA detecting a bot, it will return the ResponseCode REFERRAL_BOT_DETECTED_BY_RECAPTCHA.
NOTE: If using our builtin CAPTCHA, do NOT specify the skipCaptcha parameter!
", "type" : "object", "properties" : { "userId" : { "type" : "integer", "minimum" : 1, "optional" : true }, "campaignId" : { "type" : "integer", "minimum" : 1, "description" : "The referreral campaign to send." }, "firstName" : { "type" : "string", "optional" : true, "minLength" : 1, "maxLength" : 64, "description" : "The referrer’s first name." }, "lastName" : { "type" : "string", "optional" : true, "minLength" : 1, "maxLength" : 64, "description" : "The referrer’s last name." }, "email" : { "type" : "string", "optional" : true, "format" : "email", "minLength" : 1, "maxLength" : 64, "description" : "The referrer’s email." }, "personalMessage" : { "type" : "string", "optional" : true, "minLength" : 1, "maxLength" : 64, "description" : "The referrer’s personal message." }, "referred[]" : { "type" : "array", "items" : { "type" : "object", "properties" : { "firstName" : { "type" : "string", "optional" : true, "minLength" : 1, "maxLength" : 64, "description" : "The referred individual’s first name." }, "lastName" : { "type" : "string", "optional" : true, "minLength" : 1, "maxLength" : 64, "description" : "The referred individual’s last name." }, "email" : { "type" : "string", "format" : "email", "minLength" : 1, "maxLength" : 64, "description" : "The referred individual’s email." } } }, "minItems" : 1 }, "skipCaptcha" : { "description" : "Indicates whether the referral information being added has already been verified as coming from a real person. See endpoint description below.", "type" : "boolean", "optional" : true, "default" : false }, "g-recaptcha-response" : { "description" : "The g-recaptcha-response parameter returned by Google's Invisible ReCaptcha service. See endpoint description below.", "type" : "string", "optional" : true } } }, "Referral_Delete" : { "title" : "Delete a referral", "description" : "Deletes a referral and all associated data.", "type" : "object", "properties" : { "userId" : { "type" : "integer", "minimum" : 1, "optional" : true }, "id": { "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89aAbB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}" } } }, "Referral_List" : { "title" : "Lists all referrals", "description" : "Lists all referrals.", "type" : "object", "properties" : { "userId" : { "type" : "integer", "minimum" : 1, "optional" : true }, } }, "Test_Ping" : { "title" : "Unauthenticated ping", "description" : "Returns nothing but a success code. Used for testing connectivity only.", "type" : "object", "properties" : { } }, "Test_Validation" : { "title" : "Allows for testing of validation rules", "description" : "Allows for testing of validation rules. This action has one of each of validation rules represented.", "type" : "object", "properties" : { "requiredString" : { "type" : "string" }, "optionalNull" : { "type" : "null", "optional" : true, "default" : null }, "optionalString" : { "type" : "string", "optional" : true, "default" : "defaultValue" }, "optionalStringWithoutDefault" : { "type" : "string", "optional" : true }, "optionalStringWithLengthRestrictions" : { "type" : "string", "optional" : true, "default" : "value", "minLength" : 1, "maxLength" : 5 }, "optionalStringWithLengthRestrictionsAndZeroMinLength" : { "type" : "string", "optional" : true, "default" : "", "minLength" : 0, "maxLength" : 5 }, "optionalStringWithPattern" : { "type" : "string", "pattern" : "ab?c+.*d", "optional" : true, "default" : "accessed" }, "optionalStringWithFormat" : { "type" : "string", "format" : "date", "optional" : true, "default" : "2012-02-29" }, "optionalBoolean" : { "type" : "boolean", "optional" : true, "default" : true }, "optionalNumber" : { "type" : "number", "optional" : true, "default" : 5.27 }, "optionalInteger" : { "type" : "integer", "optional" : true, "default" : 5 }, "optionalAny" : { "type" : "any", "optional" : true, "default" : "defaultValue" }, "optionalObject" : { "type" : "object", "properties" : { "propertyA" : { "type" : "string" }, "propertyB" : { "type" : "integer" } }, "optional" : true, "default" : { "propertyA" : "defaultValueA", "propertyB" : 5 } }, "optionalArrayOfStrings[]" : { "type" : "array", "items" : { "type" : "string" }, "minItems" : 1, "maxItems" : 3, "optional" : true, "default" : [ "default1", "default2" ] }, "optionalArrayOfStringsWithZeroMinItems[]" : { "type" : "array", "items" : { "type" : "string" }, "minItems" : 0, "maxItems" : 3, "optional" : true, "default" : [] }, "optionalArrayOfIntegers[]" : { "type" : "array", "items" : { "type" : "integer" }, "optional" : true, "default" : [ 5, 7, 11 ] }, "optionalArrayOfObjects[]" : { "type" : "array", "items" : { "type" : "object", "properties" : { "propertyA" : { "type" : "string" }, "propertyB" : { "type" : "integer" } } }, "optional" : true, "default" : [ { "propertyA" : "defaultValueA1", "propertyB" : 1 }, { "propertyA" : "defaultValueA2", "propertyB" : 2 } ] }, "optionalEnumOfStrings" : { "type" : "string", "enum" : [ "one", "two", "three" ], "optional" : true, "default" : "two" }, "optionalEnumOfIntegers" : { "type" : "integer", "enum" : [ 4, 5, 6 ], "optional" : true, "default" : 5 } } }, "PublicAppProperties_Retrieve" : { "title" : "Retrieves the application configuration", "description" : "Retrieves the application configuration.", "properties" : { "userId" : { "type" : "integer", "minimum" : 1, "optional" : true }, "templateId" : { "type" : "integer", "minimum" : 1, "optional" : true } } }, "Webhook_List" : { "title" : "List Webhooks", "description" : "Lists all Webhooks.", "type" : "object", "properties" : { "includeLastResponseData" : { "type" : "boolean", "optional" : true, "default" : false } } }, "Webhook_Add" : { "title" : "Add a Webhook", "description" : "Adds a Webhook.", "type" : "object", "properties" : { "label" : { "type" : "string", "maxLength" : 128 }, "trigger" : { "type" : "string", "enum" : [ "ADD_CAMPAIGN", "ADD_CONTACT", "ADD_CUSTOM_FIELD", "ADD_LIST", "ADD_SAVED_SEARCH", "ADD_USER", "ADD_TAG", "ADD_TEMPLATE", "ADD_CONTACT_TO_LIST" ] }, "url" : { "type" : "string", "maxLength" : 2048 }, "enabled" : { "description" : "This has no effect if useHookSecrets is set to true.", "type" : "boolean", "optional" : true, "default" : false }, "useHookSecrets" : { "description" : "Enables X-Hook-Secret and X-Hook-Signature support. For more information, see the resthooks.org security documentation.", "type" : "boolean", "optional" : true, "default" : false } } }, "Webhook_Update" : { "title" : "Update a Webhook", "description" : "Updates a Webhook.", "type" : "object", "properties" : { "id" : { "type" : "string" }, "label" : { "type" : "string", "optional" : true, "maxLength" : 128 }, "trigger" : { "type" : "string", "optional" : true, "enum" : [ "ADD_CAMPAIGN", "ADD_CONTACT", "ADD_CUSTOM_FIELD", "ADD_LIST", "ADD_SAVED_LIST", "ADD_USER", "ADD_TAG", "ADD_TEMPLATE", "ADD_CONTACT_TO_LIST" ] }, "url" : { "type" : "string", "optional" : true, "maxLength" : 2048 }, "enabled" : { "type" : "boolean", "optional" : true } } }, "Webhook_Delete" : { "title" : "Delete a Webhook", "description" : "Deletes a Webhook.", "type" : "object", "properties" : { "id" : { "type" : "string" }, } }, "Webhook_Test" : { "title" : "Test a Webhook", "description" : "Tests a Webhook.", "type" : "object", "properties" : { "id" : { "type" : "string" }, } } };