> ## Documentation Index > Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt > Use this file to discover all available pages before exploring further. # 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 | ## OpenAPI ````yaml post /Client/WriteCharacterEvent openapi: 3.0.0 info: version: '260922' title: PlayFab Client API description: >- APIs which provide the full range of PlayFab features available to the client - authentication, account and data management, inventory, friends, matchmaking, reporting, and platform-specific functionality termsOfService: https://playfab.com/terms/ contact: url: https://community.playfab.com/index.html license: name: Apache 2.0 url: https://github.com/PlayFab/API_Specs/blob/master/LICENSE servers: - url: https://{titleId}.playfabapi.com description: PlayFab title endpoint variables: titleId: default: your_title_id description: Your PlayFab title ID (hex). security: [] tags: - name: Account Management description: Account Management APIs - name: Advertising description: Advertising APIs - name: Analytics description: Analytics APIs - name: Authentication description: Authentication APIs - name: Character Data description: Character Data APIs - name: Characters description: Characters APIs - name: Content description: Content Service APIs - name: Friend List Management description: Friend List Management APIs - name: Matchmaking description: Matchmaking APIs - name: Platform Specific Methods description: Platform Specific Methods APIs - name: Player Data Management description: Player Data Management APIs - name: Player Item Management description: Player Item Management APIs - name: PlayStream description: PlayStream Management APIs - name: Server-Side Cloud Script description: Server-Side Cloud Script APIs - name: Shared Group Data description: Shared Group Data APIs - name: Title-Wide Data Management description: Title-Wide Data Management APIs - name: Trading description: Trading Management APIs paths: /Client/WriteCharacterEvent: post: tags: - Analytics summary: Write Character Event description: | 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 | operationId: WriteCharacterEvent requestBody: content: application/json: schema: $ref: '#/components/schemas/WriteClientCharacterEventRequest' description: >- 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. responses: '200': $ref: '#/components/responses/WriteEventResponse' '400': $ref: '#/components/responses/ApiErrorWrapper' security: - SessionTicket: [] components: schemas: WriteClientCharacterEventRequest: description: >- 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. type: object properties: Body: description: >- Custom event properties. Each property consists of a name (string) and a value (JSON object). type: object CharacterId: description: Unique PlayFab assigned ID for a specific character owned by a user type: string CustomTags: description: >- The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). type: object EventName: description: >- 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). type: string Timestamp: description: >- The time (in UTC) associated with this event. The value defaults to the current time. type: string required: - CharacterId - EventName example: CharacterId: E161CB4B7F6C34B EventName: character_defeated_enemy Timestamp: '2016-03-07T00:00:00' Body: Enemy: guardian Damage: 5 Coordinates: X: 123.4 'Y': 543.2 WriteEventResponse: type: object properties: EventId: description: >- The unique identifier of the event. The values of this identifier consist of ASCII characters and are not constrained to any particular format. type: string example: EventId: 0f8fad5bd9cb469fa16570867728950e ApiErrorWrapper: description: The basic wrapper around every failed API response type: object properties: code: description: Numerical HTTP code type: integer status: description: String HTTP code type: string error: description: Playfab error code type: string errorCode: description: Numerical PlayFab error code type: integer errorMessage: description: Description for the PlayFab errorCode type: string errorDetails: description: Detailed description of individual issues with the request object type: object required: - code - errorCode responses: WriteEventResponse: description: '' content: application/json: schema: type: object properties: code: type: integer description: >- The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code. status: type: string description: The Http status code as a string. data: $ref: '#/components/schemas/WriteEventResponse' example: code: 200 status: OK data: EventId: 0f8fad5bd9cb469fa16570867728950e ApiErrorWrapper: description: This is the outer wrapper for all responses with errors content: application/json: schema: $ref: '#/components/schemas/ApiErrorWrapper' securitySchemes: SessionTicket: type: apiKey in: header name: X-Authorization description: >- This API requires a client session ticket, available from any Client Login function. ```` ## Related topics - [Write Character Event](/services/playfab/api-references/rest/server/analytics/write-character-event.md) - [PlayStream events](/services/playfab/data-analytics/ingest-data/playstream-events.md) - [XblEventsWriteInGameEvent](/reference/live/xsapi-c/events_c/functions/xbleventswriteingameevent.md) - [XGameEventWrite](/reference/system/xgameevent/functions/xgameeventwrite.md) - [Write Title Event](/services/playfab/api-references/rest/server/analytics/write-title-event.md)