Documentation / @blizzard-api/wow / characterProfileStatus
Function: characterProfileStatus()
characterProfileStatus(
realmSlug,characterName):object
Defined in: wow/src/character-profile/index.ts:20
Returns the status and a unique ID for a character. A client should delete information about a character from their application if any of the following conditions occur:
- an HTTP 404 Not Found error is returned
- the is_valid value is false
- the returned character ID doesn't match the previously recorded value for the character
The following example illustrates how to use this endpoint:
- A client requests and stores information about a character, including its unique character ID and the timestamp of the request.
- After 30 days, the client makes a request to the status endpoint to verify if the character information is still valid.
- If character cannot be found, is not valid, or the characters IDs do not match, the client removes the information from their application.
- If the character is valid and the character IDs match, the client retains the data for another 30 days.
Parameters
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
Returns
the status of the character profile for a character.
_responseType?
optional_responseType?:CharacterProfileStatusResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.