Update a custom object

put

/api/REST/1.0/assets/customObject/{id}

Updates the custom object specified by the id parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.

Request

Supported Media Types
Path Parameters
Body ()
The request body defines the details of the custom object to be updated.
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

200 Response

OK.
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 update a custom object using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Update the description of the custom object with id #9:


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

Request body:


{
    "id":"11",
    "name":"Frisbee",
    "description":"Re-purposed pie plates."
}
			

Response:


{
    "type":"CustomObject",
    "id":"11",
    "initialId":"11",
    "createdAt":"1436450071",
    "createdBy":"19",
    "depth":"complete",
    "description":"Re-purposed pie plates.",
    "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 PUT --data '{"id":"11","name":"Frisbee","description":"Re-purposed pie plates."}' https://secure.p03.eloqua.com/api/REST/1.0/assets/customObject/11
			
Back to Top