Write Character Event
Writes a character-based event into PlayStream.
Error codes
This operation may return the following PlayFab errors:
| Error | Code |
|---|---|
| CharacterNotFound | 1135 |
| InvalidEventField | 1216 |
| NoWritePermissionsForEvent | 1207 |
| ProductDisabledForTitle | 1609 |
Authorizations
This API requires a client session ticket, available from any Client Login function.
Body
This API is designed to write a multitude of different client-defined events into PlayStream. It supports a flexible JSON schema, which allowsfor arbitrary key-value pairs to describe any character-based event. The created event will be locked to the authenticated title and player.
This API is designed to write a multitude of different client-defined events into PlayStream. It supports a flexible JSON schema, which allowsfor arbitrary key-value pairs to describe any character-based event. The created event will be locked to the authenticated title and player.
Unique PlayFab assigned ID for a specific character owned by a user
The name of the event, within the namespace scoped to the title. The naming convention is up to the caller, but it commonly follows the subject_verb_object pattern (e.g. player_logged_in).
Custom event properties. Each property consists of a name (string) and a value (JSON object).
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
The time (in UTC) associated with this event. The value defaults to the current time.
