Create a custom object

post

/api/REST/1.0/assets/customObject

Creates a custom object that matches the criteria specified by the request body.

Request

Supported Media Types
Body ()
The request body defines the details of the custom object to be created.
Root Schema : CustomObject
Type: object
Title: CustomObject
Show Source
Nested Schema : fields
Type: array
Array consisting of custom object field properties.
Show Source
Nested Schema : CustomObjectField
Type: object
Title: CustomObjectField
Show Source
Back to Top

Response

Supported Media Types

201 Response

Success
Body ()
Root Schema : CustomObject
Type: object
Title: CustomObject
Show Source
Nested Schema : fields
Type: array
Array consisting of custom object field properties.
Show Source
Nested Schema : CustomObjectField
Type: object
Title: CustomObjectField
Show Source

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

The following examples demonstrate how to create a new custom object using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Create a new custom object asset, along with a new custom object field:


POST /api/REST/1.0/assets/customObject
Content-Type: application/json 
			

Request body:


{
    "name":"Frisbee",
    "description":"Fun in the sun plaything.",
    "fields":[
        {
            "name":"Color",
            "defaultValue":"White",
            "displayType":"text",
            "dataType":"text"
        }
    ],
}
			

Response:


{
    "type":"CustomObject",
    "id":"11",
    "createdAt":"1436450071",
    "createdBy":"19",
    "depth":"complete",
    "description":"Fun in the sun plaything.",
    "folderId":"83",
    "name":"Frisbee",
    "updatedAt":"1436450071",
    "updatedBy":"19",
    "fields":[
        {
            "type":"CustomObjectField",
            "id":"101",
            "depth":"complete",
            "name":"Color",
            "dataType":"text",
            "defaultValue":"White",
            "displayType":"text",
            "internalName":"Color1"
        }
    ],
    "recordCount":0
}
			

cURL Example

Here is the same example in cURL given an instance with the name APITest, username API.User, and POD of 3.


curl --user "APITest\API.User" --header "Content-Type: application/json" --request POST --data '{"name":"Frisbee","description":"Fun in the sun plaything.","fields":[{"name":"Color","defaultValue":"White","displayType":"text","dataType":"text"}],}' https://secure.p03.eloqua.com/api/REST/1.0/assets/customObject
			
Back to Top