Update an event registrant

put

/api/REST/2.0/data/eventRegistration/{parentId}/instance/{id}

Updates an event registrant that matches the criteria specified by the request body for the event specified by the parentId parameter. The response will only include field values that have been updated in the request. The response will also only include contactId if it has been updated in the request.

Request

Supported Media Types
Path Parameters
Body ()
The request body defines the details of the event registrant to be updated. Note: Only fieldValues and contactId can be updated. fieldValues is required, even if not updating any fields. To update contactId, include fieldValues with an empty array.
Root Schema : EventRegistrationData
Type: object
Title: EventRegistrationData
Show Source
Nested Schema : fieldValues
Type: array
Array containing type, id, and value for all of the fields associated with a given event registrant.
Show Source
Nested Schema : permissions
Type: array
This property is not used for event registrants.
Show Source
Nested Schema : FieldValue
Type: object
Title: FieldValue
Show Source
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : EventRegistrationData
Type: object
Title: EventRegistrationData
Show Source
Nested Schema : fieldValues
Type: array
Array containing type, id, and value for all of the fields associated with a given event registrant.
Show Source
Nested Schema : permissions
Type: array
This property is not used for event registrants.
Show Source
Nested Schema : FieldValue
Type: object
Title: FieldValue
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

Update an event registrant whose Id = 332383 for the event with Id #1260:


PUT /api/REST/2.0/data/eventRegistration/1260/instance/332383
Content-Type: application/json
			

Request body:


{
  "fieldValues": [
  	{
      "id": "3964",
      "value": "Europe"
    }
  ]
}
			

Response:


{
  "type": "EventRegistrationData",
  "id": "332375",
  "createdAt": "1493161593",
  "name": "john.doe@oracle.com",
  "updatedAt": "1493245509",
  "customObjectRecordStatus": "OnHold",
  "fieldValues": [
    {
      "type": "FieldValue",
      "id": "3964",
      "value": "Europe"
    }
  ],
  "isMapped": "Yes",
  "uniqueCode": "john.doe@oracle.com"
}
			

Update the mapped contact for an event registrant whose Id = 332383 for the event with Id #1260:


PUT /data/eventRegistration/1260/instance/332383
Content-Type: application/json
			

Request body:


{
  "contactId": "3",
  "fieldValues": []
}
			

Response:


{
  "type": "EventRegistrationData",
  "id": "332375",
  "createdAt": "1493161593",
  "name": "john.doe@oracle.com",
  "updatedAt": "1493246010",
  "contactId": "3",
  "customObjectRecordStatus": "OnHold",
  "fieldValues": [],
  "isMapped": "Yes",
  "uniqueCode": "john.doe@oracle.com"
}
			
Back to Top