REST API for Oracle Eloqua Marketing Cloud Service

Create an event

post

/api/rest/2.0/assets/eventRegistration

Creates an event that matches the criteria specified by the request body.

Request

Supported Media Types

application/json

The request body defines the details of the event to be created.

Root Schema : EventRegistration

Type: object

Title: EventRegistration

Show Source

createdAt: string

Read Only: true

The date and time the event was created, expressed in Unix time. This is a read-only property.
createdBy: string

Read Only: true

The login id of the user who created the event. This is a read-only property.
createdByName: string

The name of the user who created the event.
currentStatus: string

This property is not used for events.
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 event.
emailAddressFieldId: string

The field id that contains the Email Address. Use the desired custom object field's negative id as the value for this parameter.
eventGroupByFieldId: string

The id of the field used to organize multiple sessions. Use the desired custom object field's negative id as the value for this parameter.
fields: array fields

Array consisting of event field properties.
folderId: string

Read Only: true

The folder id of the folder which contains the event.
id: string

Read Only: true

Id of the event. This is a read-only property.
name: string

The name of the event.
permissions: array permissions

This property is not used for events.
scheduledFor: string

Read Only: true

This property is not used for events.
sessionFields: array sessionFields

Array consisting of session fields within a session.
sessionFieldValues: array sessionFieldValues

Array consisting of session fields values for a session. You must create session fields and session before creating the session field values.
sessions: array sessions

Array consisting of event sessions.
sourceTemplateId: string

This property is not used for events.
type: string

The asset's type in Eloqua. This is a read-only property.
uniqueCodeFieldId: string

The field id that contains the unique identifier. Use the desired custom object field's negative id as the value for this parameter. See example. To use an Eloqua Identifier, leave this parameter out of the request.
updatedAt: string

Read Only: true

Unix timestamp for the date and time the event was last updated. This is a read-only property.
updatedBy: string

Read Only: true

The login id of the user that last updated the event. This is a read-only property.
updatedByName: string

The name of the user who last updated the event.

{
    "title":"EventRegistration",
    "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 event. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"This property is not used for events."
        },
        "name":{
            "type":"string",
            "description":"The name of the event."
        },
        "description":{
            "type":"string",
            "description":"The description of the event."
        },
        "permissions":{
            "type":"array",
            "description":"This property is not used for events.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"The folder id of the folder which contains the event."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"This property is not used for events."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the event. This is a read-only property."
        },
        "createdByName":{
            "type":"string",
            "description":"The name of the user who created the event."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the event was created, expressed in Unix time. This is a read-only property."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the event. This is a read-only property."
        },
        "updatedByName":{
            "type":"string",
            "description":"The name of the user who last updated the event."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the event was last updated. This is a read-only property."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for events."
        },
        "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>."
        },
        "fields":{
            "type":"array",
            "description":"Array consisting of event field properties.",
            "items":{
                "$ref":"#/definitions/CustomObjectFieldRest20"
            }
        },
        "sessions":{
            "type":"array",
            "description":"Array consisting of event sessions.",
            "items":{
                "$ref":"#/definitions/EventSessionRest20"
            }
        },
        "sessionFields":{
            "type":"array",
            "description":"Array consisting of session fields within a session.",
            "items":{
                "$ref":"#/definitions/EventSessionFieldRest20"
            }
        },
        "sessionFieldValues":{
            "type":"array",
            "description":"Array consisting of session fields values for a session. You must create session fields and session before creating the session field values.",
            "items":{
                "$ref":"#/definitions/EventSessionFieldValueRest20"
            }
        },
        "emailAddressFieldId":{
            "type":"string",
            "description":"The field id that contains the Email Address. Use the desired custom object field's negative id as the value for this parameter."
        },
        "uniqueCodeFieldId":{
            "type":"string",
            "description":"The field id that contains the unique identifier. Use the desired custom object field's negative id as the value for this parameter. See example. To use an Eloqua Identifier, leave this parameter out of the request."
        },
        "eventGroupByFieldId":{
            "type":"string",
            "description":"The id of the field used to organize multiple sessions. Use the desired custom object field's negative id as the value for this parameter."
        }
    }
}

Nested Schema : fields

Type: array

Array consisting of event field properties.

Show Source

Array of: object CustomObjectField

Title: CustomObjectField

{
    "type":"array",
    "description":"Array consisting of event field properties.",
    "items":{
        "$ref":"#/definitions/CustomObjectFieldRest20"
    }
}

Nested Schema : permissions

Type: array

This property is not used for events.

Show Source

Array of: string

{
    "type":"array",
    "description":"This property is not used for events.",
    "items":{
        "type":"string"
    }
}

Nested Schema : sessionFields

Type: array

Array consisting of session fields within a session.

Show Source

Array of: object EventSessionField

Title: EventSessionField

{
    "type":"array",
    "description":"Array consisting of session fields within a session.",
    "items":{
        "$ref":"#/definitions/EventSessionFieldRest20"
    }
}

Nested Schema : sessionFieldValues

Type: array

Array consisting of session fields values for a session. You must create session fields and session before creating the session field values.

Show Source

Array of: object EventSessionFieldValue

Title: EventSessionFieldValue

{
    "type":"array",
    "description":"Array consisting of session fields values for a session. You must create session fields and session before creating the session field values.",
    "items":{
        "$ref":"#/definitions/EventSessionFieldValueRest20"
    }
}

Nested Schema : sessions

Type: array

Array consisting of event sessions.

Show Source

Array of: object EventSession

Title: EventSession

{
    "type":"array",
    "description":"Array consisting of event sessions.",
    "items":{
        "$ref":"#/definitions/EventSessionRest20"
    }
}

Nested Schema : CustomObjectField

Type: object

Title: CustomObjectField

Show Source

checkedValue: string

The checked value of a checkbox custom object field.
createdAt: string

Read Only: true

This property is not used for custom object fields.
createdBy: string

Read Only: true

This property is not used for custom object fields.
createdByName: string

This property is not used for custom object fields.
currentStatus: string

This property is not used for custom object fields.
dataType: string

The custom object field's data type.
defaultValue: string

The custom object field's default value.
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

This property is not used for custom object fields.
displayType: string

The custom object field's display type.
folderId: string

Read Only: true

This property is not used for custom object fields.
id: string

Read Only: true

Id of the custom object field. This is a read-only property. Use negative ids in order to reference custom object fields for other properties (e.g. emailAddressFieldId or uniqueCodeFieldId). See example.
internalName: string

The custom object field's internal name. This is a read-only property.
name: string

The name of the custom object field.
optionListId: string

The option list id for a single select custom object field.
permissions: array permissions

This property is not used.
scheduledFor: string

Read Only: true

This property is not used for custom object fields.
sourceTemplateId: string

This property is not used for custom object fields.
type: string

The asset's type in Eloqua. This is a read-only property.
uncheckedValue: string

The unchecked value of a checkbox custom object field.
updatedAt: string

Read Only: true

This property is not used for custom object fields.
updatedBy: string

Read Only: true

This property is not used for custom object fields.
updatedByName: string

This property is not used for custom object fields.

{
    "title":"CustomObjectField",
    "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 custom object field. This is a read-only property. Use negative ids in order to reference custom object fields for other properties (e.g. emailAddressFieldId or uniqueCodeFieldId). See example."
        },
        "currentStatus":{
            "type":"string",
            "description":"This property is not used for custom object fields."
        },
        "description":{
            "type":"string",
            "description":"This property is not used for custom object fields."
        },
        "permissions":{
            "type":"array",
            "description":"This property is not used.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for custom object fields."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"This property is not used for custom object fields."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for custom object fields."
        },
        "createdByName":{
            "type":"string",
            "description":"This property is not used for custom object fields."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for custom object fields."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for custom object fields."
        },
        "updatedByName":{
            "type":"string",
            "description":"This property is not used for custom object fields."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for custom object fields."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for custom object fields."
        },
        "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>."
        },
        "name":{
            "type":"string",
            "description":"The name of the custom object field."
        },
        "displayType":{
            "type":"string",
            "description":"The custom object field's display type."
        },
        "dataType":{
            "type":"string",
            "description":"The custom object field's data type."
        },
        "defaultValue":{
            "type":"string",
            "description":"The custom object field's default value."
        },
        "internalName":{
            "type":"string",
            "description":"The custom object field's internal name. This is a read-only property."
        },
        "optionListId":{
            "type":"string",
            "description":"The option list id for a single select custom object field."
        },
        "checkedValue":{
            "type":"string",
            "description":"The checked value of a checkbox custom object field."
        },
        "uncheckedValue":{
            "type":"string",
            "description":"The unchecked value of a checkbox custom object field."
        }
    }
}

Nested Schema : permissions

Type: array

This property is not used.

Show Source

Array of: string

{
    "type":"array",
    "description":"This property is not used.",
    "items":{
        "type":"string"
    }
}

Nested Schema : EventSessionField

Type: object

Title: EventSessionField

Show Source

createdAt: string

Read Only: true

This property is not used for event session fields.
createdBy: string

Read Only: true

This property is not used for event session fields.
createdByName: string

This property is not used for event session fields.
currentStatus: string

This property is not used for event session fields.
dataType: string

The DataType of the session field.
depth: string

Read Only: true

This property is not used for event session fields.
description: string

This property is not used for event session fields.
folderId: string

Read Only: true

This property is not used for event session fields.
id: string

Read Only: true

Id of the event session field. This is a read-only property.
name: string

The name of the session field within an event.
outputFormat: object FieldOutputFormat

Title: FieldOutputFormat
permissions: array permissions

This property is not used.
scheduledFor: string

Read Only: true

This property is not used for event session fields.
sourceTemplateId: string

This property is not used for event session fields.
type: string

The asset's type in Eloqua. This is a read-only property.
updatedAt: string

Read Only: true

This property is not used for event session fields.
updatedBy: string

Read Only: true

This property is not used for event session fields.
updatedByName: string

This property is not used for event session fields.

{
    "title":"EventSessionField",
    "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 event session field. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"This property is not used for event session fields."
        },
        "name":{
            "type":"string",
            "description":"The name of the session field within an event."
        },
        "description":{
            "type":"string",
            "description":"This property is not used for event session fields."
        },
        "permissions":{
            "type":"array",
            "description":"This property is not used.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event session fields."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"This property is not used for event session fields."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event session fields."
        },
        "createdByName":{
            "type":"string",
            "description":"This property is not used for event session fields."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event session fields."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event session fields."
        },
        "updatedByName":{
            "type":"string",
            "description":"This property is not used for event session fields."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event session fields."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event session fields."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event session fields."
        },
        "dataType":{
            "type":"string",
            "description":"The DataType of the session field."
        },
        "outputFormat":{
            "$ref":"#/definitions/FieldOutputFormatRest20",
            "description":"The output format for number, date / time, and numeric custom object fields. Only the display format???s id is required. See list of default display formats <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=DisplayFormats'>here</a>. If using custom display formats, these should be set in Eloqua."
        }
    }
}

Nested Schema : FieldOutputFormat

Type: object

Title: FieldOutputFormat

Show Source

currentStatus: string
dataType: string
format: string
id: string
type: string

{
    "title":"FieldOutputFormat",
    "properties":{
        "type":{
            "type":"string"
        },
        "currentStatus":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "format":{
            "type":"string"
        },
        "dataType":{
            "type":"string"
        }
    }
}

Nested Schema : permissions

Type: array

This property is not used.

Show Source

Array of: string

{
    "type":"array",
    "description":"This property is not used.",
    "items":{
        "type":"string"
    }
}

Nested Schema : EventSessionFieldValue

Type: object

Title: EventSessionFieldValue

Show Source

createdAt: string

Read Only: true

This property is not used for event session field values.
createdBy: string

Read Only: true

This property is not used for event session field values.
createdByName: string

This property is not used for event session field values.
currentStatus: string

This property is not used for event session field values.
depth: string

Read Only: true

This property is not used for event session field values.
description: string

This property is not used for event session field values.
folderId: string

Read Only: true

This property is not used for event session field values.
id: string

Read Only: true

This property is not used for event session field values.
name: string

This property is not used for event session field values.
permissions: array permissions

This property is not used.
scheduledFor: string

Read Only: true

This property is not used for event session field values.
sessionFieldId: string

The SessionFieldId of the field. The session field must be created first before creating session field values.
sessionId: string

The SessionId of the session within an event for which field value is passed.
sourceTemplateId: string

This property is not used for event session field values.
type: string

The asset's type in Eloqua.
updatedAt: string

Read Only: true

This property is not used for event session field values.
updatedBy: string

Read Only: true

This property is not used for event session field values.
updatedByName: string

This property is not used for event session field values.
value: string

The value for the event session field.

{
    "title":"EventSessionFieldValue",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event session field values."
        },
        "currentStatus":{
            "type":"string",
            "description":"This property is not used for event session field values."
        },
        "name":{
            "type":"string",
            "description":"This property is not used for event session field values."
        },
        "description":{
            "type":"string",
            "description":"This property is not used for event session field values."
        },
        "permissions":{
            "type":"array",
            "description":"This property is not used.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event session field values."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"This property is not used for event session field values."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event session field values."
        },
        "createdByName":{
            "type":"string",
            "description":"This property is not used for event session field values."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event session field values."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event session field values."
        },
        "updatedByName":{
            "type":"string",
            "description":"This property is not used for event session field values."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event session field values."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event session field values."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event session field values."
        },
        "sessionId":{
            "type":"string",
            "description":"The SessionId of the session within an event for which field value is passed."
        },
        "sessionFieldId":{
            "type":"string",
            "description":"The SessionFieldId of the field. The session field must be created first before creating session field values."
        },
        "value":{
            "type":"string",
            "description":"The value for the event session field."
        }
    }
}

Nested Schema : permissions

Type: array

This property is not used.

Show Source

Array of: string

{
    "type":"array",
    "description":"This property is not used.",
    "items":{
        "type":"string"
    }
}

Nested Schema : EventSession

Type: object

Title: EventSession

Show Source

createdAt: string

Read Only: true

This property is not used for event sessions.
createdBy: string

Read Only: true

This property is not used for event sessions.
createdByName: string

This property is not used for event sessions.
currentStatus: string

This property is not used for event sessions.
depth: string

Read Only: true

This property is not used for event sessions.
description: string

This property is not used for event sessions.
folderId: string

Read Only: true

This property is not used for event sessions.
id: string

Read Only: true

Id of the event session. This is a read-only property.
name: string

The name of the session.
participantsLimit: integer

The maximum number of participants per session.
permissions: array permissions

This property is not used.
scheduledFor: string

Read Only: true

This property is not used for event sessions.
sourceTemplateId: string

This property is not used for event sessions.
type: string

The asset's type in Eloqua.
updatedAt: string

Read Only: true

This property is not used for event sessions.
updatedBy: string

Read Only: true

This property is not used for event sessions.
updatedByName: string

This property is not used for event sessions.

{
    "title":"EventSession",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the event session. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"This property is not used for event sessions."
        },
        "name":{
            "type":"string",
            "description":"The name of the session."
        },
        "description":{
            "type":"string",
            "description":"This property is not used for event sessions."
        },
        "permissions":{
            "type":"array",
            "description":"This property is not used.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event sessions."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"This property is not used for event sessions."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event sessions."
        },
        "createdByName":{
            "type":"string",
            "description":"This property is not used for event sessions."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event sessions."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event sessions."
        },
        "updatedByName":{
            "type":"string",
            "description":"This property is not used for event sessions."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event sessions."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event sessions."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event sessions."
        },
        "participantsLimit":{
            "type":"integer",
            "description":"The maximum number of participants per session."
        }
    }
}

Nested Schema : permissions

Type: array

This property is not used.

Show Source

Array of: string

{
    "type":"array",
    "description":"This property is not used.",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

application/json

201 Response

Success.

Root Schema : EventRegistration

Type: object

Title: EventRegistration

Show Source

createdAt: string

Read Only: true

The date and time the event was created, expressed in Unix time. This is a read-only property.
createdBy: string

Read Only: true

The login id of the user who created the event. This is a read-only property.
createdByName: string

The name of the user who created the event.
currentStatus: string

This property is not used for events.
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 event.
emailAddressFieldId: string

The field id that contains the Email Address. Use the desired custom object field's negative id as the value for this parameter.
eventGroupByFieldId: string

The id of the field used to organize multiple sessions. Use the desired custom object field's negative id as the value for this parameter.
fields: array fields

Array consisting of event field properties.
folderId: string

Read Only: true

The folder id of the folder which contains the event.
id: string

Read Only: true

Id of the event. This is a read-only property.
name: string

The name of the event.
permissions: array permissions

This property is not used for events.
scheduledFor: string

Read Only: true

This property is not used for events.
sessionFields: array sessionFields

Array consisting of session fields within a session.
sessionFieldValues: array sessionFieldValues

Array consisting of session fields values for a session. You must create session fields and session before creating the session field values.
sessions: array sessions

Array consisting of event sessions.
sourceTemplateId: string

This property is not used for events.
type: string

The asset's type in Eloqua. This is a read-only property.
uniqueCodeFieldId: string

The field id that contains the unique identifier. Use the desired custom object field's negative id as the value for this parameter. See example. To use an Eloqua Identifier, leave this parameter out of the request.
updatedAt: string

Read Only: true

Unix timestamp for the date and time the event was last updated. This is a read-only property.
updatedBy: string

Read Only: true

The login id of the user that last updated the event. This is a read-only property.
updatedByName: string

The name of the user who last updated the event.

{
    "title":"EventRegistration",
    "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 event. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"This property is not used for events."
        },
        "name":{
            "type":"string",
            "description":"The name of the event."
        },
        "description":{
            "type":"string",
            "description":"The description of the event."
        },
        "permissions":{
            "type":"array",
            "description":"This property is not used for events.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"The folder id of the folder which contains the event."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"This property is not used for events."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the event. This is a read-only property."
        },
        "createdByName":{
            "type":"string",
            "description":"The name of the user who created the event."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the event was created, expressed in Unix time. This is a read-only property."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the event. This is a read-only property."
        },
        "updatedByName":{
            "type":"string",
            "description":"The name of the user who last updated the event."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the event was last updated. This is a read-only property."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for events."
        },
        "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>."
        },
        "fields":{
            "type":"array",
            "description":"Array consisting of event field properties.",
            "items":{
                "$ref":"#/definitions/CustomObjectFieldRest20"
            }
        },
        "sessions":{
            "type":"array",
            "description":"Array consisting of event sessions.",
            "items":{
                "$ref":"#/definitions/EventSessionRest20"
            }
        },
        "sessionFields":{
            "type":"array",
            "description":"Array consisting of session fields within a session.",
            "items":{
                "$ref":"#/definitions/EventSessionFieldRest20"
            }
        },
        "sessionFieldValues":{
            "type":"array",
            "description":"Array consisting of session fields values for a session. You must create session fields and session before creating the session field values.",
            "items":{
                "$ref":"#/definitions/EventSessionFieldValueRest20"
            }
        },
        "emailAddressFieldId":{
            "type":"string",
            "description":"The field id that contains the Email Address. Use the desired custom object field's negative id as the value for this parameter."
        },
        "uniqueCodeFieldId":{
            "type":"string",
            "description":"The field id that contains the unique identifier. Use the desired custom object field's negative id as the value for this parameter. See example. To use an Eloqua Identifier, leave this parameter out of the request."
        },
        "eventGroupByFieldId":{
            "type":"string",
            "description":"The id of the field used to organize multiple sessions. Use the desired custom object field's negative id as the value for this parameter."
        }
    }
}

Nested Schema : fields

Type: array

Array consisting of event field properties.

Show Source

Array of: object CustomObjectField

Title: CustomObjectField

{
    "type":"array",
    "description":"Array consisting of event field properties.",
    "items":{
        "$ref":"#/definitions/CustomObjectFieldRest20"
    }
}

Nested Schema : permissions

Type: array

This property is not used for events.

Show Source

Array of: string

{
    "type":"array",
    "description":"This property is not used for events.",
    "items":{
        "type":"string"
    }
}

Nested Schema : sessionFields

Type: array

Array consisting of session fields within a session.

Show Source

Array of: object EventSessionField

Title: EventSessionField

{
    "type":"array",
    "description":"Array consisting of session fields within a session.",
    "items":{
        "$ref":"#/definitions/EventSessionFieldRest20"
    }
}

Nested Schema : sessionFieldValues

Type: array

Array consisting of session fields values for a session. You must create session fields and session before creating the session field values.

Show Source

Array of: object EventSessionFieldValue

Title: EventSessionFieldValue

{
    "type":"array",
    "description":"Array consisting of session fields values for a session. You must create session fields and session before creating the session field values.",
    "items":{
        "$ref":"#/definitions/EventSessionFieldValueRest20"
    }
}

Nested Schema : sessions

Type: array

Array consisting of event sessions.

Show Source

Array of: object EventSession

Title: EventSession

{
    "type":"array",
    "description":"Array consisting of event sessions.",
    "items":{
        "$ref":"#/definitions/EventSessionRest20"
    }
}

Nested Schema : CustomObjectField

Type: object

Title: CustomObjectField

Show Source

checkedValue: string

The checked value of a checkbox custom object field.
createdAt: string

Read Only: true

This property is not used for custom object fields.
createdBy: string

Read Only: true

This property is not used for custom object fields.
createdByName: string

This property is not used for custom object fields.
currentStatus: string

This property is not used for custom object fields.
dataType: string

The custom object field's data type.
defaultValue: string

The custom object field's default value.
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

This property is not used for custom object fields.
displayType: string

The custom object field's display type.
folderId: string

Read Only: true

This property is not used for custom object fields.
id: string

Read Only: true

Id of the custom object field. This is a read-only property. Use negative ids in order to reference custom object fields for other properties (e.g. emailAddressFieldId or uniqueCodeFieldId). See example.
internalName: string

The custom object field's internal name. This is a read-only property.
name: string

The name of the custom object field.
optionListId: string

The option list id for a single select custom object field.
permissions: array permissions

This property is not used.
scheduledFor: string

Read Only: true

This property is not used for custom object fields.
sourceTemplateId: string

This property is not used for custom object fields.
type: string

The asset's type in Eloqua. This is a read-only property.
uncheckedValue: string

The unchecked value of a checkbox custom object field.
updatedAt: string

Read Only: true

This property is not used for custom object fields.
updatedBy: string

Read Only: true

This property is not used for custom object fields.
updatedByName: string

This property is not used for custom object fields.

{
    "title":"CustomObjectField",
    "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 custom object field. This is a read-only property. Use negative ids in order to reference custom object fields for other properties (e.g. emailAddressFieldId or uniqueCodeFieldId). See example."
        },
        "currentStatus":{
            "type":"string",
            "description":"This property is not used for custom object fields."
        },
        "description":{
            "type":"string",
            "description":"This property is not used for custom object fields."
        },
        "permissions":{
            "type":"array",
            "description":"This property is not used.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for custom object fields."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"This property is not used for custom object fields."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for custom object fields."
        },
        "createdByName":{
            "type":"string",
            "description":"This property is not used for custom object fields."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for custom object fields."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for custom object fields."
        },
        "updatedByName":{
            "type":"string",
            "description":"This property is not used for custom object fields."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for custom object fields."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for custom object fields."
        },
        "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>."
        },
        "name":{
            "type":"string",
            "description":"The name of the custom object field."
        },
        "displayType":{
            "type":"string",
            "description":"The custom object field's display type."
        },
        "dataType":{
            "type":"string",
            "description":"The custom object field's data type."
        },
        "defaultValue":{
            "type":"string",
            "description":"The custom object field's default value."
        },
        "internalName":{
            "type":"string",
            "description":"The custom object field's internal name. This is a read-only property."
        },
        "optionListId":{
            "type":"string",
            "description":"The option list id for a single select custom object field."
        },
        "checkedValue":{
            "type":"string",
            "description":"The checked value of a checkbox custom object field."
        },
        "uncheckedValue":{
            "type":"string",
            "description":"The unchecked value of a checkbox custom object field."
        }
    }
}

Nested Schema : permissions

Type: array

This property is not used.

Show Source

Array of: string

{
    "type":"array",
    "description":"This property is not used.",
    "items":{
        "type":"string"
    }
}

Nested Schema : EventSessionField

Type: object

Title: EventSessionField

Show Source

createdAt: string

Read Only: true

This property is not used for event session fields.
createdBy: string

Read Only: true

This property is not used for event session fields.
createdByName: string

This property is not used for event session fields.
currentStatus: string

This property is not used for event session fields.
dataType: string

The DataType of the session field.
depth: string

Read Only: true

This property is not used for event session fields.
description: string

This property is not used for event session fields.
folderId: string

Read Only: true

This property is not used for event session fields.
id: string

Read Only: true

Id of the event session field. This is a read-only property.
name: string

The name of the session field within an event.
outputFormat: object FieldOutputFormat

Title: FieldOutputFormat
permissions: array permissions

This property is not used.
scheduledFor: string

Read Only: true

This property is not used for event session fields.
sourceTemplateId: string

This property is not used for event session fields.
type: string

The asset's type in Eloqua. This is a read-only property.
updatedAt: string

Read Only: true

This property is not used for event session fields.
updatedBy: string

Read Only: true

This property is not used for event session fields.
updatedByName: string

This property is not used for event session fields.

{
    "title":"EventSessionField",
    "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 event session field. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"This property is not used for event session fields."
        },
        "name":{
            "type":"string",
            "description":"The name of the session field within an event."
        },
        "description":{
            "type":"string",
            "description":"This property is not used for event session fields."
        },
        "permissions":{
            "type":"array",
            "description":"This property is not used.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event session fields."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"This property is not used for event session fields."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event session fields."
        },
        "createdByName":{
            "type":"string",
            "description":"This property is not used for event session fields."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event session fields."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event session fields."
        },
        "updatedByName":{
            "type":"string",
            "description":"This property is not used for event session fields."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event session fields."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event session fields."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event session fields."
        },
        "dataType":{
            "type":"string",
            "description":"The DataType of the session field."
        },
        "outputFormat":{
            "$ref":"#/definitions/FieldOutputFormatRest20",
            "description":"The output format for number, date / time, and numeric custom object fields. Only the display format???s id is required. See list of default display formats <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=DisplayFormats'>here</a>. If using custom display formats, these should be set in Eloqua."
        }
    }
}

Nested Schema : FieldOutputFormat

Type: object

Title: FieldOutputFormat

Show Source

currentStatus: string
dataType: string
format: string
id: string
type: string

{
    "title":"FieldOutputFormat",
    "properties":{
        "type":{
            "type":"string"
        },
        "currentStatus":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "format":{
            "type":"string"
        },
        "dataType":{
            "type":"string"
        }
    }
}

Nested Schema : permissions

Type: array

This property is not used.

Show Source

Array of: string

{
    "type":"array",
    "description":"This property is not used.",
    "items":{
        "type":"string"
    }
}

Nested Schema : EventSessionFieldValue

Type: object

Title: EventSessionFieldValue

Show Source

createdAt: string

Read Only: true

This property is not used for event session field values.
createdBy: string

Read Only: true

This property is not used for event session field values.
createdByName: string

This property is not used for event session field values.
currentStatus: string

This property is not used for event session field values.
depth: string

Read Only: true

This property is not used for event session field values.
description: string

This property is not used for event session field values.
folderId: string

Read Only: true

This property is not used for event session field values.
id: string

Read Only: true

This property is not used for event session field values.
name: string

This property is not used for event session field values.
permissions: array permissions

This property is not used.
scheduledFor: string

Read Only: true

This property is not used for event session field values.
sessionFieldId: string

The SessionFieldId of the field. The session field must be created first before creating session field values.
sessionId: string

The SessionId of the session within an event for which field value is passed.
sourceTemplateId: string

This property is not used for event session field values.
type: string

The asset's type in Eloqua.
updatedAt: string

Read Only: true

This property is not used for event session field values.
updatedBy: string

Read Only: true

This property is not used for event session field values.
updatedByName: string

This property is not used for event session field values.
value: string

The value for the event session field.

{
    "title":"EventSessionFieldValue",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event session field values."
        },
        "currentStatus":{
            "type":"string",
            "description":"This property is not used for event session field values."
        },
        "name":{
            "type":"string",
            "description":"This property is not used for event session field values."
        },
        "description":{
            "type":"string",
            "description":"This property is not used for event session field values."
        },
        "permissions":{
            "type":"array",
            "description":"This property is not used.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event session field values."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"This property is not used for event session field values."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event session field values."
        },
        "createdByName":{
            "type":"string",
            "description":"This property is not used for event session field values."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event session field values."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event session field values."
        },
        "updatedByName":{
            "type":"string",
            "description":"This property is not used for event session field values."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event session field values."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event session field values."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event session field values."
        },
        "sessionId":{
            "type":"string",
            "description":"The SessionId of the session within an event for which field value is passed."
        },
        "sessionFieldId":{
            "type":"string",
            "description":"The SessionFieldId of the field. The session field must be created first before creating session field values."
        },
        "value":{
            "type":"string",
            "description":"The value for the event session field."
        }
    }
}

Nested Schema : permissions

Type: array

This property is not used.

Show Source

Array of: string

{
    "type":"array",
    "description":"This property is not used.",
    "items":{
        "type":"string"
    }
}

Nested Schema : EventSession

Type: object

Title: EventSession

Show Source

createdAt: string

Read Only: true

This property is not used for event sessions.
createdBy: string

Read Only: true

This property is not used for event sessions.
createdByName: string

This property is not used for event sessions.
currentStatus: string

This property is not used for event sessions.
depth: string

Read Only: true

This property is not used for event sessions.
description: string

This property is not used for event sessions.
folderId: string

Read Only: true

This property is not used for event sessions.
id: string

Read Only: true

Id of the event session. This is a read-only property.
name: string

The name of the session.
participantsLimit: integer

The maximum number of participants per session.
permissions: array permissions

This property is not used.
scheduledFor: string

Read Only: true

This property is not used for event sessions.
sourceTemplateId: string

This property is not used for event sessions.
type: string

The asset's type in Eloqua.
updatedAt: string

Read Only: true

This property is not used for event sessions.
updatedBy: string

Read Only: true

This property is not used for event sessions.
updatedByName: string

This property is not used for event sessions.

{
    "title":"EventSession",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the event session. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"This property is not used for event sessions."
        },
        "name":{
            "type":"string",
            "description":"The name of the session."
        },
        "description":{
            "type":"string",
            "description":"This property is not used for event sessions."
        },
        "permissions":{
            "type":"array",
            "description":"This property is not used.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event sessions."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"This property is not used for event sessions."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event sessions."
        },
        "createdByName":{
            "type":"string",
            "description":"This property is not used for event sessions."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event sessions."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event sessions."
        },
        "updatedByName":{
            "type":"string",
            "description":"This property is not used for event sessions."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event sessions."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event sessions."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event sessions."
        },
        "participantsLimit":{
            "type":"integer",
            "description":"The maximum number of participants per session."
        }
    }
}

Nested Schema : permissions

Type: array

This property is not used.

Show Source

Array of: string

{
    "type":"array",
    "description":"This property is not used.",
    "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.

Examples

Note the following:

When using negative numbers, -1 cannot be used.
You must create session fields and session before creating the session field values. See Update a form for example.
When setting FieldOutputFormat, only the display format's id is required. See a list of default display formats here. If using custom display formats, these should be set in Eloqua.

Create an event:


POST /api/REST/2.0/assets/eventRegistration
Content-Type: application/json

Request body:


{
  "name": "Modern Marketing Experience",
  "description": "Modern Marketing Experience brings together Modern Marketers from around the globe",
  "emailAddressFieldId": "-2",
  "fields": [
    {
      "type": "CustomObjectField",
      "id": "-2",
      "name": "Email",
      "dataType": "text",
      "displayType": "text"
    },
    {
      "type": "CustomObjectField",
      "name": "First Name",
      "dataType": "text",
      "displayType": "text"
    },
    {
      "type": "CustomObjectField",
      "name": "Industry",
      "dataType": "text",
      "displayType": "singleSelect",
      "optionListId": "9"
    },
    {
      "type": "CustomObjectField",
      "name": "Markie Submitted",
      "checkedValue": "Yes",
      "dataType": "text",
      "defaultValue": "No",
      "displayType": "checkbox",
      "uncheckedValue": "No"
    },
    {
      "type": "CustomObjectField",
      "name": "Birthday",
      "dataType": "date",
      "displayType": "text"
    },
    {
      "type": "CustomObjectField",
      "name": "Years Using Eloqua",
      "dataType": "number",
      "displayType": "text"
    },
    {
      "type": "CustomObjectField",
      "name": "MME Location",
      "dataType": "text",
      "defaultValue": "North America",
      "displayType": "singleSelect",
      "optionListId": "108"
    }
  ],
  "sessionFields": [
    {
      "type": "EventSessionField",
      "name": "Date",
      "dataType": "date",
      "outputFormat": {
        "type": "FieldOutputFormat",
        "id": "19"
      }
    },
    {
      "type": "EventSessionField",
      "name": "Location",
      "dataType": "text"
    }
  ],
  "sessions": [
    {
      "type": "EventSession",
      "name": "North America"
    },
    {
      "type": "EventSession",
      "name": "Europe"
    }
  ],
  "uniqueCodeFieldId": "-2"
}

Response:


{
  "type": "EventRegistration",
  "id": "1260",
  "createdAt": "1493156690",
  "createdBy": "71",
  "depth": "complete",
  "description": "Modern Marketing Experience brings together Modern Marketers from around the globe",
  "folderId": "81",
  "name": "Modern Marketing Experience",
  "updatedAt": "1493156690",
  "updatedBy": "71",
  "emailAddressFieldId": "3958",
  "fields": [
    {
      "type": "CustomObjectField",
      "id": "3958",
      "initialId": "-2",
      "depth": "complete",
      "name": "Email",
      "dataType": "text",
      "displayType": "text",
      "internalName": "Email1"
    },
    {
      "type": "CustomObjectField",
      "id": "3959",
      "depth": "complete",
      "name": "First Name",
      "dataType": "text",
      "displayType": "text",
      "internalName": "First_Name1"
    },
    {
      "type": "CustomObjectField",
      "id": "3960",
      "depth": "complete",
      "name": "Industry",
      "dataType": "text",
      "displayType": "singleSelect",
      "internalName": "Industry1",
      "optionListId": "9"
    },
    {
      "type": "CustomObjectField",
      "id": "3961",
      "depth": "complete",
      "name": "Markie Submitted",
      "checkedValue": "Yes",
      "dataType": "text",
      "defaultValue": "No",
      "displayType": "checkbox",
      "internalName": "Markie_Submitted1",
      "uncheckedValue": "No"
    },
    {
      "type": "CustomObjectField",
      "id": "3962",
      "depth": "complete",
      "name": "Birthday",
      "dataType": "date",
      "displayType": "text",
      "internalName": "Birthday1"
    },
    {
      "type": "CustomObjectField",
      "id": "3963",
      "depth": "complete",
      "name": "Years Using Eloqua",
      "dataType": "number",
      "displayType": "text",
      "internalName": "Years_Using_Eloqua1"
    },
    {
      "type": "CustomObjectField",
      "id": "3964",
      "depth": "complete",
      "name": "MME Location",
      "dataType": "text",
      "defaultValue": "North America",
      "displayType": "singleSelect",
      "internalName": "MME_Location1",
      "optionListId": "108"
    }
  ],
  "sessionFields": [
    {
      "type": "EventSessionField",
      "id": "535",
      "name": "Date",
      "dataType": "date",
      "outputFormat": {
        "type": "FieldOutputFormat",
        "id": "19",
        "dataType": "date",
        "format": "dddd MMMM d, yyyy"
      }
    },
    {
      "type": "EventSessionField",
      "id": "536",
      "name": "Location",
      "dataType": "text"
    }
  ],
  "sessions": [
    {
      "type": "EventSession",
      "id": "51",
      "name": "North America"
    },
    {
      "type": "EventSession",
      "id": "52",
      "name": "Europe"
    }
  ],
  "uniqueCodeFieldId": "3958"
}