Create a microsite
post
/api/REST/1.0/assets/microsite
Creates a microsite that matches the criteria specified by the request body.
Request
Supported Media Types
- application/json
The request body defines the details of the microsite to be updated.
Root Schema : Microsite
Type:
object
Title:
Show Source
Microsite
-
createdAt:
string
Read Only:
true
The date and time the microsite was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the microsite. -
currentStatus:
string
The campaign's current status.
-
defaultLandingPageId:
string
The id for the associated default landing page.
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. -
description:
string
The description of the microsite.
-
domains:
array domains
A collection of associated sub domains.
-
id:
string
Read Only:
true
Id of the microsite. This is a read-only property. -
isAllowedInFrame:
string
Whether pages associated to the microsite can be embedded within frames, iframes, or objects. Learn more.
-
name:
string
The name of the microsite.
-
permissions:
string
The permissions for the microsite granted to your current instance. This is a read-only property.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the microsite was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the microsite.
Response
Supported Media Types
- application/json
201 Response
Success.
Root Schema : Microsite
Type:
object
Title:
Show Source
Microsite
-
createdAt:
string
Read Only:
true
The date and time the microsite was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the microsite. -
currentStatus:
string
The campaign's current status.
-
defaultLandingPageId:
string
The id for the associated default landing page.
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. -
description:
string
The description of the microsite.
-
domains:
array domains
A collection of associated sub domains.
-
id:
string
Read Only:
true
Id of the microsite. This is a read-only property. -
isAllowedInFrame:
string
Whether pages associated to the microsite can be embedded within frames, iframes, or objects. Learn more.
-
name:
string
The name of the microsite.
-
permissions:
string
The permissions for the microsite granted to your current instance. This is a read-only property.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the microsite was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the microsite.
400 Response
Bad request. See Status Codes for information about other possible HTTP status codes.
401 Response
Unauthorized. See Status Codes for information about other possible HTTP status codes.
403 Response
Forbidden. See Status Codes for information about other possible HTTP status codes.
404 Response
The requested resource was not found. See Status Codes for information about other possible HTTP status codes.
500 Response
The service has encountered an error. See Status Codes for information about other possible HTTP status codes.
Examples
Create a microsite:
POST /api/REST/1.0/assets/microsite
Content-Type: application/json
Request body:
{
"name":"My First Microsite",
"domains":[
"https://docs.oracle.com/cloud/latest/marketingcs_gs/index.html"
],
}
Response:
{
"type":"Microsite",
"id":"3",
"createdAt":"1435607724",
"createdBy":"19",
"depth":"complete",
"name":"My First Microsite",
"updatedAt":"1435607724",
"updatedBy":"19",
"domains":[
"https://docs.oracle.com/cloud/latest/marketingcs_gs/index.html"
]
}