Usage
Use UpdateGuestInfo to update the information of one or more guests in one event.
Basic Steps
- Determine the ID of the event for which you want to update guests’ information.
- Construct a Guest array and populate it with the IDs of each guest whose information you want to update.
- Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes.
- Call UpdateGuestInfo, passing in the EventId and Guest array.
- Process the results in the UpdateGuestInfoResult array object to verify whether the guests’ information have been successfully updated.
General Syntax
UpdateGuestInfoResultArray = cventapi.UpdateGuestInfo(ID EventId, GuestArray Guests)Input
| Name | Type | Description |
|---|---|---|
| EventId | ID | ID of the event that is having its guests updated. |
| Guests | Guest Array | Array of Guests whose information should be updated. |
Output
| Name | Type | Description |
|---|---|---|
| Id | ID | ID of the guest for whom you attempted to update information. |
| ReferenceId | ID | The MessageId value in the input Guest. |
| Success | Boolean | Indicates whether the UpdateGuestInfo call succeeded (True) or not (False) for this Guest. |
| Errors | Error Array | If an error occurred during the call, an array of one or more Error objects providing the error code and description. |
Last updated on