Jump to

• Request
• Response
• Examples

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

Body ()

The request body defines the details of the microsite to be updated.

Root Schema : Microsite

Type: object

Title: Microsite

Show Source

• 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, and complete. Any other values passed are reset to complete 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.

{
    "title":"Microsite",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property. "
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the microsite. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The campaign's current status."
        },
        "name":{
            "type":"string",
            "description":"The name of the microsite."
        },
        "description":{
            "type":"string",
            "description":"The description of the microsite."
        },
        "permissions":{
            "type":"string",
            "description":"The permissions for the microsite granted to your current instance. This is a read-only property."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the microsite."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the microsite was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the microsite."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the microsite was last updated."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "domains":{
            "type":"array",
            "description":"A collection of associated sub domains.",
            "items":{
                "type":"string"
            }
        },
        "defaultLandingPageId":{
            "type":"string",
            "description":"The id for the associated default landing page."
        },
        "isAllowedInFrame":{
            "type":"string",
            "description":"Whether pages associated to the microsite can be embedded within frames, iframes, or objects. <a href='https://docs.oracle.com/en/cloud/saas/marketing/eloqua-user/index.html#CSHID=PreventEmbedding'>Learn more</a>."
        }
    }
}

Nested Schema : domains

Type: array

A collection of associated sub domains.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A collection of associated sub domains.",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Success.

Body ()

Root Schema : Microsite

Type: object

Title: Microsite

Show Source

• 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, and complete. Any other values passed are reset to complete 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.

{
    "title":"Microsite",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property. "
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the microsite. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The campaign's current status."
        },
        "name":{
            "type":"string",
            "description":"The name of the microsite."
        },
        "description":{
            "type":"string",
            "description":"The description of the microsite."
        },
        "permissions":{
            "type":"string",
            "description":"The permissions for the microsite granted to your current instance. This is a read-only property."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the microsite."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the microsite was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the microsite."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the microsite was last updated."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "domains":{
            "type":"array",
            "description":"A collection of associated sub domains.",
            "items":{
                "type":"string"
            }
        },
        "defaultLandingPageId":{
            "type":"string",
            "description":"The id for the associated default landing page."
        },
        "isAllowedInFrame":{
            "type":"string",
            "description":"Whether pages associated to the microsite can be embedded within frames, iframes, or objects. <a href='https://docs.oracle.com/en/cloud/saas/marketing/eloqua-user/index.html#CSHID=PreventEmbedding'>Learn more</a>."
        }
    }
}

Nested Schema : domains

Type: array

A collection of associated sub domains.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A collection of associated sub domains.",
    "items":{
        "type":"string"
    }
}

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.

Back to Top

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"
    ]
}
			

Back to Top