Create an event registrant
post
/api/rest/2.0/data/eventRegistration/{parentId}/instance
Creates an event registrant that matches the criteria specified by the request body for the event specified by the
parentId
parameter.Request
Supported Media Types
- application/json
Path Parameters
-
parentId(required): integer
Id of the parent event.
The request body defines the details of the event registrant to be created.
Root Schema : EventRegistrationData
Type:
object
Title:
Show Source
EventRegistrationData
-
accountId:
string
The account record Id associated to this event registrant. This is a read-only property.
-
contactId:
string
The contact record Id associated to this event registrant. Use the desired contact's id as the value for this parameter.
-
createdAt:
string
Read Only:
true
The date and time the event registrant was created, expressed in Unix time. This is a read-only property. -
createdBy:
string
Read Only:
true
This property is not used for event registrants. -
createdByName:
string
This property is not used for event registrants.
-
currentStatus:
string
This property is not used for event registrants.
-
customObjectRecordStatus:
string
The status of the event registrant. Only returned when creating or updating an event registrant. This is a read-only property.
-
depth:
string
Read Only:
true
This property is not used for event registrants. -
description:
string
This property is not used for event registrants.
-
fieldValues:
array fieldValues
Array containing
type
,id
, andvalue
for all of the fields associated with a given event registrant. -
folderId:
string
Read Only:
true
This property is not used for event registrants. -
id:
string
Read Only:
true
Id of the event registrant. This is a read-only property. -
isMapped:
string
Whether or not the event registrant is mapped to a contact or account. This is a read-only property.
-
name:
string
The name of the event registrant. This is a read-only property.
-
permissions:
array permissions
This property is not used for event registrants.
-
scheduledFor:
string
Read Only:
true
This property is not used for event registrants. -
sourceTemplateId:
string
This property is not used for event registrants.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
uniqueCode:
string
The unique value associated to the event registrant. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the event registrant was last updated. This is a read-only property. -
updatedBy:
string
Read Only:
true
This property is not used for event registrants. -
updatedByName:
string
This property is not used for event registrants.
Nested Schema : fieldValues
Type:
array
Array containing
Show Source
type
, id
, and value
for all of the fields associated with a given event registrant.-
Array of:
object FieldValue
Title:
FieldValue
Nested Schema : permissions
Type:
array
This property is not used for event registrants.
Show Source
Nested Schema : FieldValue
Type:
object
Title:
Show Source
FieldValue
-
id:
string
Read Only:
true
The id of the field to be set to the corresponding value. -
name:
string
Name of the field value.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
value:
string
The value to set the corresponding field id to. Date values must be submitted as a unix timestamp.
Response
Supported Media Types
- application/json
201 Response
Success.
Root Schema : EventRegistrationData
Type:
object
Title:
Show Source
EventRegistrationData
-
accountId:
string
The account record Id associated to this event registrant. This is a read-only property.
-
contactId:
string
The contact record Id associated to this event registrant. Use the desired contact's id as the value for this parameter.
-
createdAt:
string
Read Only:
true
The date and time the event registrant was created, expressed in Unix time. This is a read-only property. -
createdBy:
string
Read Only:
true
This property is not used for event registrants. -
createdByName:
string
This property is not used for event registrants.
-
currentStatus:
string
This property is not used for event registrants.
-
customObjectRecordStatus:
string
The status of the event registrant. Only returned when creating or updating an event registrant. This is a read-only property.
-
depth:
string
Read Only:
true
This property is not used for event registrants. -
description:
string
This property is not used for event registrants.
-
fieldValues:
array fieldValues
Array containing
type
,id
, andvalue
for all of the fields associated with a given event registrant. -
folderId:
string
Read Only:
true
This property is not used for event registrants. -
id:
string
Read Only:
true
Id of the event registrant. This is a read-only property. -
isMapped:
string
Whether or not the event registrant is mapped to a contact or account. This is a read-only property.
-
name:
string
The name of the event registrant. This is a read-only property.
-
permissions:
array permissions
This property is not used for event registrants.
-
scheduledFor:
string
Read Only:
true
This property is not used for event registrants. -
sourceTemplateId:
string
This property is not used for event registrants.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
uniqueCode:
string
The unique value associated to the event registrant. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the event registrant was last updated. This is a read-only property. -
updatedBy:
string
Read Only:
true
This property is not used for event registrants. -
updatedByName:
string
This property is not used for event registrants.
Nested Schema : fieldValues
Type:
array
Array containing
Show Source
type
, id
, and value
for all of the fields associated with a given event registrant.-
Array of:
object FieldValue
Title:
FieldValue
Nested Schema : permissions
Type:
array
This property is not used for event registrants.
Show Source
Nested Schema : FieldValue
Type:
object
Title:
Show Source
FieldValue
-
id:
string
Read Only:
true
The id of the field to be set to the corresponding value. -
name:
string
Name of the field value.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
value:
string
The value to set the corresponding field id to. Date values must be submitted as a unix timestamp.
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
Create a new event registrant and map to contact for the event with Id #1260:
POST /api/REST/2.0/data/eventRegistration/1260/instance
Content-Type: application/json
Request body:
{
"contactId": "1653175",
"fieldValues": [
{
"id": "3958",
"value": "sally@oracle.com"
},
{
"id": "3959",
"value": "Sally"
},
{
"id": "3960",
"value": "Technology"
},
{
"id": "3962",
"value": "41547123"
},
{
"id": "3964",
"value": "North America"
},
{
"id": "3963",
"value": "2"
},
{
"id": "3961",
"value": "Yes"
}
]
}
Response:
{
"type": "EventRegistrationData",
"id": "332379",
"createdAt": "1493240064",
"name": "sally@oracle.com",
"updatedAt": "1493240064",
"contactId": "1653175",
"customObjectRecordStatus": "Registered",
"fieldValues": [
{
"type": "FieldValue",
"id": "3958",
"value": "sally@oracle.com"
},
{
"type": "FieldValue",
"id": "3959",
"value": "Sally"
},
{
"type": "FieldValue",
"id": "3960",
"value": "Technology"
},
{
"type": "FieldValue",
"id": "3962",
"value": "41547123"
},
{
"type": "FieldValue",
"id": "3964",
"value": "North America"
},
{
"type": "FieldValue",
"id": "3963",
"value": "2"
},
{
"type": "FieldValue",
"id": "3961",
"value": "Yes"
}
],
"isMapped": "Yes",
"uniqueCode": "sally@oracle.com"
}