Runtime verified Differs from official docs Test scripts included

Syntax

HTTPPost2(url, contentType, contentToPost[, exceptionOnError, @response, @responseRowSet, headerName1, headerValue1, ...])  →  number

Parameters

Name Type Required Description
url string Yes The URL to post the content to
contentType string Yes The Content-Type header for the request
contentToPost string Yes The content to send in the POST body
exceptionOnError boolean No When true, raise an exception on failure; when false, continue after an error
response string No Output variable that receives the response body
responseRowSet string No Output variable that receives the response headers as a rowset
headerName1 string No Name of an additional request header
headerValue1 string No Value of an additional request header

There is no upper bound on the argument count — additional request headers are passed as repeated name/value pairs after the rowset variable.

Example

%%[ VAR @status, @body, @headers
  SET @status = HTTPPost2("https://postman-echo.com/post", "application/json", '{"marker":"amp-post2-yy8"}', true, @body, @headers)
]%%
%%=v(@status)=%%

Renders 200; @body holds the echoed response and @headers is a rowset of the response headers.

Read a single response header from the rowset by row:

%%[
  VAR @status, @body, @headers
  SET @status = HTTPPost2("https://postman-echo.com/post", "application/json", @payload, true, @body, @headers)
]%%
Header rows: %%=v(RowCount(@headers))=%%

Return value

number — the HTTP status code of the response, which is 200 on a successful POST. There is no closed set of values to test for a success.

Behaviour

The response argument holds the body, and a separate rowset holds the headers. The official reference labels the fifth argument as the request “status”, but at runtime it receives the response body (289 characters of echoed JSON) while the sixth argument receives the response headers as a rowset — 11 header rows in the proof. This body/headers split is what HTTPPost2 adds over plain HTTPPost. See the differs-from-docs note.

The exception-on-error flag is accepted. Passing true at the fourth position was accepted and the successful call returned 200.

The HTTP status code is the return value. As with HTTPPost, the numeric status comes back as the function’s own return value, not through an output variable.

Show test script
%%[
  VAR @b, @s2, @body2, @hdr2
  SET @b = RequestParameter("b")
  OutputLine(Concat("CTRL=[", Uppercase("ok"), "]"))

  /* 6-arg form: status is the return value, @body2 the body, @hdr2 the header rowset. fetch ?b=post2 */
  IF @b == "post2" THEN
    SET @s2 = HTTPPost2("https://postman-echo.com/post", "application/json", '{"marker":"amp-post2-yy8"}', true, @body2, @hdr2)
    OutputLine(Concat("status=[", @s2, "] bodylen=[", Length(@body2), "]"))
    OutputLine(Concat("hdrRows=[", RowCount(@hdr2), "]"))
  ENDIF
]%%

Availability

Platform Available
Marketing Cloud Engagement Yes
Marketing Cloud Next No

See also