1. REST API for Oracle Eloqua Marketing Cloud Service
  2. Tasks
  3. Application
  4. 1.0
  5. Custom objects

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
  • Read Only: true
    The date and time the custom object was created, expressed in Unix time.
  • Read Only: true
    The login id of the user who created the custom object.
  • This property is not used for custom object fields.
  • Whether or not custom object records are deleted when linked contact records are deleted. Does not apply to records that are unmapped or account deletion. Deleting records is irreversible and data cannot be recovered. The default value is false. This feature is released under our Controlled Availability program. You can request access to this feature by submitting a request to My Oracle Support.
  • 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.
  • The description of the custom object.
  • For your custom object record to have a meaningful name field, you must create a custom object field which will act as a name. You can then use the desired custom object field's id as the value for this parameter.
  • fields
    Array consisting of custom object field properties.
  • Read Only: true
    Id of the custom object.
  • The name of the custom object.
  • The permissions for the custom object granted to your current instance. This is a read-only property.
  • The asset's type in Eloqua. This is a read-only property.
  • For your custom object record to have a unique identifier, you must create a custom object field which will act as a GUID. You can then use the desired custom object field's id as the value for this parameter.
  • Read Only: true
    Unix timestamp for the date and time the custom object was last updated.
  • Read Only: true
    The login id of the user that last updated the custom object.
Nested Schema : fields
Type: array
Array consisting of custom object field properties.
Show Source
Nested Schema : CustomObjectField
Type: object
Title: CustomObjectField
Show Source
  • Read Only: true
    This property is not used for custom object fields.
  • Read Only: true
    This property is not used for custom object fields.
  • This property is not used for custom objects.
  • The custom object field's data type.
  • The custom object field's default value.
  • 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.
  • This property is not used for custom object fields.
  • The custom object field's display type.
  • Read Only: true
    Id of the custom object field. This is a read-only property. Use negative ids to reference custom object fields for other properties (e.g. emailAddressFieldId or uniqueCodeFieldId). See example.
  • The name of the custom object field.
  • This property is not used.
  • The asset's type in Eloqua. This is a read-only property.
  • Read Only: true
    This property is not used for custom object fields.
  • Read Only: true
    This property is not used for custom object fields.
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : CustomObject
Type: object
Title: CustomObject
Show Source
  • Read Only: true
    The date and time the custom object was created, expressed in Unix time.
  • Read Only: true
    The login id of the user who created the custom object.
  • This property is not used for custom object fields.
  • Whether or not custom object records are deleted when linked contact records are deleted. Does not apply to records that are unmapped or account deletion. Deleting records is irreversible and data cannot be recovered. The default value is false. This feature is released under our Controlled Availability program. You can request access to this feature by submitting a request to My Oracle Support.
  • 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.
  • The description of the custom object.
  • For your custom object record to have a meaningful name field, you must create a custom object field which will act as a name. You can then use the desired custom object field's id as the value for this parameter.
  • fields
    Array consisting of custom object field properties.
  • Read Only: true
    Id of the custom object.
  • The name of the custom object.
  • The permissions for the custom object granted to your current instance. This is a read-only property.
  • The asset's type in Eloqua. This is a read-only property.
  • For your custom object record to have a unique identifier, you must create a custom object field which will act as a GUID. You can then use the desired custom object field's id as the value for this parameter.
  • Read Only: true
    Unix timestamp for the date and time the custom object was last updated.
  • Read Only: true
    The login id of the user that last updated the custom object.
Nested Schema : fields
Type: array
Array consisting of custom object field properties.
Show Source
Nested Schema : CustomObjectField
Type: object
Title: CustomObjectField
Show Source
  • Read Only: true
    This property is not used for custom object fields.
  • Read Only: true
    This property is not used for custom object fields.
  • This property is not used for custom objects.
  • The custom object field's data type.
  • The custom object field's default value.
  • 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.
  • This property is not used for custom object fields.
  • The custom object field's display type.
  • Read Only: true
    Id of the custom object field. This is a read-only property. Use negative ids to reference custom object fields for other properties (e.g. emailAddressFieldId or uniqueCodeFieldId). See example.
  • The name of the custom object field.
  • This property is not used.
  • The asset's type in Eloqua. This is a read-only property.
  • Read Only: true
    This property is not used for custom object fields.
  • Read Only: true
    This property is not used for custom object fields.

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