{"id":31388,"date":"2018-04-21T15:47:46","date_gmt":"2018-04-21T15:47:46","guid":{"rendered":"https:\/\/ampscript.guide\/setobjectproperty\/"},"modified":"2021-12-15T14:07:44","modified_gmt":"2021-12-15T14:07:44","slug":"setobjectproperty","status":"publish","type":"post","link":"https:\/\/ampscript.guide\/setobjectproperty\/","title":{"rendered":"SetObjectProperty"},"content":{"rendered":"

SetObjectProperty<\/h2>\n

This function sets a property value for an object created with the CreateObject<\/a> function.<\/p>\n

Arguments<\/h3>\n

SetObjectProperty(1,2,3)<\/code><\/p>\n\n\n\n\n\n\n\n
Ordinal<\/th>\nType<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
1<\/td>\nAPI Object<\/td>\nTrue<\/td>\nThe API Object for which the property is set<\/td>\n<\/tr>\n
2<\/td>\nString<\/td>\nTrue<\/td>\nThe name of the property to set<\/td>\n<\/tr>\n
3<\/td>\nString<\/td>\nTrue<\/td>\nThe value of the property<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Example<\/h3>\n

The following example executes an insert or update on a Subscriber record, setting the Status to Active<\/code>. The SetObjectProperty()<\/code> function is used to set the properties to add to or update the Subscriber<\/code> object.<\/p>\n

%%[\n\nvar @sub, @updateStatusCode, @updateStatusMessage, @updateErrorCode\nset @sub = CreateObject(\"Subscriber\")\nSetObjectProperty(@sub, \"EmailAddress\", \"barb@limedash.com\")\nSetObjectProperty(@sub, \"SubscriberKey\", \"5767\")\nSetObjectProperty(@sub, \"Status\", \"Active\")\n\nset @updateOptions = CreateObject(\"UpdateOptions\")\nset @saveOptions = CreateObject(\"SaveOption\")\nSetObjectProperty(@saveOptions,\"SaveAction\",\"UpdateAdd\")\nSetObjectProperty(@saveOptions,\"PropertyName\",\"*\")\nAddObjectArrayItem(@updateOptions,\"SaveOptions\", @saveOptions)\n\nset @updateStatusCode = InvokeUpdate(@sub, @updateStatusMessage, @updateErrorCode, @updateOptions)\n\n]%%\nupdateStatusCode: %%=v(@updateStatusCode)=%%\n<br>updateStatusMessage: %%=v(@updateStatusMessage)=%%\n<br>updateErrorCode: %%=v(@updateErrorCode)=%%<\/code><\/pre>\n
Output<\/h4>\n
updateStatusCode: OK\nupdateStatusMessage: Updated Subscriber.\nupdateErrorCode: 0<\/code><\/pre>\n","protected":false},"excerpt":{"rendered":"
SetObjectProperty This function sets a property value for an object created with the CreateObject function. Arguments SetObjectProperty(1,2,3) Ordinal Type Required Description 1 API Object True The API Object for which the property is set 2 String True The name of the property to set 3 String True The value of the property Example The following […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":[],"categories":[1],"tags":[],"yoast_head":"\nThe AMPscript Guide - SetObjectProperty<\/title>\n<meta name=\"robots\" content=\"index, follow\" \/>\n<meta name=\"googlebot\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<meta name=\"bingbot\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/ampscript.guide\/setobjectproperty\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"The AMPscript Guide - SetObjectProperty\" \/>\n<meta property=\"og:description\" content=\"SetObjectProperty This function sets a property value for an object created with the CreateObject function. Arguments SetObjectProperty(1,2,3) Ordinal Type Required Description 1 API Object True The API Object for which the property is set 2 String True The name of the property to set 3 String True The value of the property Example The following […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/ampscript.guide\/setobjectproperty\/\" \/>\n<meta property=\"og:site_name\" content=\"The AMPscript Guide\" \/>\n<meta property=\"article:published_time\" content=\"2018-04-21T15:47:46+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2021-12-15T14:07:44+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebSite\",\"@id\":\"https:\/\/ampscript.guide\/#website\",\"url\":\"https:\/\/ampscript.guide\/\",\"name\":\"The AMPscript Guide\",\"description\":\"The Definitive Scripting Manual for Salesforce Marketing Cloud\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":\"https:\/\/ampscript.guide\/?s={search_term_string}\",\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/ampscript.guide\/setobjectproperty\/#webpage\",\"url\":\"https:\/\/ampscript.guide\/setobjectproperty\/\",\"name\":\"The AMPscript Guide - SetObjectProperty\",\"isPartOf\":{\"@id\":\"https:\/\/ampscript.guide\/#website\"},\"datePublished\":\"2018-04-21T15:47:46+00:00\",\"dateModified\":\"2021-12-15T14:07:44+00:00\",\"author\":{\"@id\":\"https:\/\/ampscript.guide\/#\/schema\/person\/5335042f77731e84f9808aecef25daec\"},\"breadcrumb\":{\"@id\":\"https:\/\/ampscript.guide\/setobjectproperty\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/ampscript.guide\/setobjectproperty\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/ampscript.guide\/setobjectproperty\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"item\":{\"@type\":\"WebPage\",\"@id\":\"https:\/\/ampscript.guide\/\",\"url\":\"https:\/\/ampscript.guide\/\",\"name\":\"Home\"}},{\"@type\":\"ListItem\",\"position\":2,\"item\":{\"@type\":\"WebPage\",\"@id\":\"https:\/\/ampscript.guide\/setobjectproperty\/\",\"url\":\"https:\/\/ampscript.guide\/setobjectproperty\/\",\"name\":\"SetObjectProperty\"}}]},{\"@type\":[\"Person\"],\"@id\":\"https:\/\/ampscript.guide\/#\/schema\/person\/5335042f77731e84f9808aecef25daec\",\"name\":\"dev\"}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","_links":{"self":[{"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/posts\/31388"}],"collection":[{"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/comments?post=31388"}],"version-history":[{"count":0,"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/posts\/31388\/revisions"}],"wp:attachment":[{"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/media?parent=31388"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/categories?post=31388"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/tags?post=31388"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}