Switch active personality

PUT

/api/v1/world/personalities/{slug}

const url = 'http://localhost:11044/api/v1/world/personalities/example';
const options = {method: 'PUT', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url http://localhost:11044/api/v1/world/personalities/example \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Sets the active personality for the current world.

Authorizations

apiKeyAuth
basicAuth

Parameters

Path Parameters

slug

required

string

Slug of the personality to make active, as listed by GET /world/personalities (any tier: world, shipped or realm); saved as the world’s activePersonality. An unknown slug answers 400 with the available slugs

Responses

200

Personality switched

*/*

object

400

Unknown personality; the response lists the available slugs

*/*

A refusal from the world administration surface: what went wrong, and the word error so a client reading the body need not consult the status code

object

message

required

What was refused and why, written to be shown. Names the offending value where there is one — the unknown mode, the out-of-range threshold, the invalid cron expression

string

status

required

Always error. Present because the map this replaces carried it and a consumer may branch on it

string

Example

error