{"id":31382,"date":"2018-04-21T15:47:46","date_gmt":"2018-04-21T15:47:46","guid":{"rendered":"https:\/\/ampscript.guide\/functions-invokeperform\/"},"modified":"2021-04-06T01:18:21","modified_gmt":"2021-04-06T01:18:21","slug":"invokeperform","status":"publish","type":"post","link":"https:\/\/ampscript.guide\/invokeperform\/","title":{"rendered":"InvokePerform"},"content":{"rendered":"

InvokePerform<\/h2>\n

This function performs the instantiated Marketing Cloud API Object<\/a>. It returns a status code value and a status message.<\/p>\n

\n

NOTE: Only certain API Objects can be performed. Current objects are listed in documentation for the Perform API Method<\/a>.<\/p>\n<\/blockquote>\n

<\/p>\n

Arguments<\/h3>\n

InvokePerform(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 to be performed<\/td>\n<\/tr>\n
2<\/td>\nString<\/td>\nTrue<\/td>\nThe action to perform on the object. Must be a valid action for the object<\/a> specified in the first argument.<\/td>\n<\/tr>\n
3<\/td>\nVariable<\/td>\nFalse<\/td>\nThe AMPscript variable in which the resulting status message is stored<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

<\/p>\n

Example<\/h3>\n

The following example retrieves the ObjectID<\/code> of a QueryDefinition<\/code> and then performs it.<\/p>\n

%%[\n\nvar @rr, @objectID, @queryDefinitions\nset @rr = CreateObject(\"RetrieveRequest\")\nSetObjectProperty(@rr, \"ObjectType\", \"QueryDefinition\")\nAddObjectArrayItem(@rr, \"Properties\", \"ObjectID\")\n\nset @sfp = CreateObject(\"SimpleFilterPart\")\nSetObjectProperty(@sfp, \"Property\", \"CustomerKey\")\nSetObjectProperty(@sfp, \"SimpleOperator\", \"equals\")\nAddObjectArrayItem(@sfp, \"Value\", \"LoyaltyMembers\")\n\nSetObjectProperty(@rr,\"Filter\", @sfp)\n\nset @queryDefinitions = InvokeRetrieve(@rr, @rrStatus, @rrRequestID)\n\noutput(concat(\"rrStatus: \", @rrStatus))\noutput(concat(\"<br>rrRequestID: \", @rrRequestID))\n\nif rowcount(@queryDefinitions) > 0 then\n\n  var @queryDefinition, @ObjectID, @obj\n\n  set @queryDefinition = Row(@queryDefinitions, 1)\n  set @ObjectID = Field(@queryDefinition, \"ObjectID\")\n\n  set @obj = CreateObject(\"QueryDefinition\")\n\n  SetObjectProperty(@obj, \"ObjectID\", @ObjectID)\n  Set @performStatusCode = InvokePerform(@obj, \"start\", @performStatusMessage)\n\nendif\n\n]%%\n<br>queryDefinitions: %%=rowcount(@queryDefinitions)=%%\n<br>performStatusCode: %%=v(@performStatusCode)=%%\n<br>performStatusMessage: %%=v(@performStatusMessage)=%%<\/code><\/pre>\n
Output<\/h4>\n
rrStatus: OK\nrrRequestID: 3a78779e-6ed3-44b1-a381-3d5134949445 queryDefinitions: 1\nperformStatusCode: OK\nperformStatusMessage: QueryDefinition perform called successfully<\/code><\/pre>\n","protected":false},"excerpt":{"rendered":"
InvokePerform This function performs the instantiated Marketing Cloud API Object. It returns a status code value and a status message. NOTE: Only certain API Objects can be performed. Current objects are listed in documentation for the Perform API Method. Arguments InvokePerform(1,2,3) Ordinal Type Required Description 1 API Object True The API Object to be performed […]<\/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 - InvokePerform<\/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\/invokeperform\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"The AMPscript Guide - InvokePerform\" \/>\n<meta property=\"og:description\" content=\"InvokePerform This function performs the instantiated Marketing Cloud API Object. It returns a status code value and a status message. NOTE: Only certain API Objects can be performed. Current objects are listed in documentation for the Perform API Method. Arguments InvokePerform(1,2,3) Ordinal Type Required Description 1 API Object True The API Object to be performed […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/ampscript.guide\/invokeperform\/\" \/>\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-04-06T01:18:21+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\/invokeperform\/#webpage\",\"url\":\"https:\/\/ampscript.guide\/invokeperform\/\",\"name\":\"The AMPscript Guide - InvokePerform\",\"isPartOf\":{\"@id\":\"https:\/\/ampscript.guide\/#website\"},\"datePublished\":\"2018-04-21T15:47:46+00:00\",\"dateModified\":\"2021-04-06T01:18:21+00:00\",\"author\":{\"@id\":\"https:\/\/ampscript.guide\/#\/schema\/person\/5335042f77731e84f9808aecef25daec\"},\"breadcrumb\":{\"@id\":\"https:\/\/ampscript.guide\/invokeperform\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/ampscript.guide\/invokeperform\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/ampscript.guide\/invokeperform\/#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\/invokeperform\/\",\"url\":\"https:\/\/ampscript.guide\/invokeperform\/\",\"name\":\"InvokePerform\"}}]},{\"@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\/31382"}],"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=31382"}],"version-history":[{"count":0,"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/posts\/31382\/revisions"}],"wp:attachment":[{"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/media?parent=31382"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/categories?post=31382"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/tags?post=31382"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}