Syntax

Platform.Function.HTTPPost(url, contentType, payload [, headerNames, headerValues [, returnCodeAndResponse]])
3–6 arguments

Parameters

Name Type Required Description
url string Yes Target URL
contentType string Yes MIME type of the request body, e.g. "application/json"
payload string Yes Request body
headerNames string[] No Array of additional header names
headerValues string[] No Array of corresponding header values
returnCodeAndResponse boolean No When true, returns an array [statusCode, body] instead of just the body

Examples

// Simple JSON POST
var payload = Stringify({ event: "pageview", page: "/home" });
var response = Platform.Function.HTTPPost(
    "https://api.example.com/events",
    "application/json",
    payload
);
var result = Platform.Function.ParseJSON(response + "");

// POST with auth header and status code
var headers = ["Authorization"];
var vals = ["Bearer " + token];
var res = Platform.Function.HTTPPost(
    "https://api.example.com/track",
    "application/json",
    payload,
    headers,
    vals,
    true // [statusCode, body]
);
var statusCode = res[0];
var body = res[1];

Return Value

By default, returns the response body as a string. When returnCodeAndResponse is true, returns a two-element array: [httpStatusCode, responseBody].

See Also