Account Management - Add Or Update Contact Email

Adds or updates a contact email to the player's profile.

POST https://titleId.playfabapi.com/Client/AddOrUpdateContactEmail

Request Header

Name Required Type Description
X-Authorization True

string

This API requires a client session ticket, available from any Client Login function.

Request Body

Name Required Type Description
EmailAddress True

string

The new contact email to associate with the player.

CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name Type Description
200 OK

AddOrUpdateContactEmailResult

400 Bad Request

ApiErrorWrapper

This is the outer wrapper for all responses with errors

Security

X-Authorization

This API requires a client session ticket, available from any Client Login function.

Type: apiKey
In: header

Definitions

Name Description
AddOrUpdateContactEmailRequest

This API adds a contact email to the player's profile. If the player's profile already contains a contact email, it will update the contact email to the email address specified.

AddOrUpdateContactEmailResult
ApiErrorWrapper

The basic wrapper around every failed API response

AddOrUpdateContactEmailRequest

This API adds a contact email to the player's profile. If the player's profile already contains a contact email, it will update the contact email to the email address specified.

Name Type Description
CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

EmailAddress

string

The new contact email to associate with the player.

AddOrUpdateContactEmailResult

ApiErrorWrapper

The basic wrapper around every failed API response

Name Type Description
code

integer

Numerical HTTP code

error

string

Playfab error code

errorCode

integer

Numerical PlayFab error code

errorDetails

object

Detailed description of individual issues with the request object

errorMessage

string

Description for the PlayFab errorCode

status

string

String HTTP code