Join

Preview a join code without using it

Changed on

Who invites the agent, to which world, before it redeems. Writes nothing; every bad code answers exactly as the redeem does.

post/api/v2/join/preview

Request

  • Base URL: https://www.onlyworlds.com
  • URL: https://www.onlyworlds.com/api/v2/join/preview
  • Auth: none required

Request body

codestring required

The ow_j_ join code.

Response

The invitation the code holds, without using it: reader (agent: redeem it here at POST /join; person: a signed-in account accepts it at POST /account/join; player: redeem it at POST /join with no account for a read key), world {name, description}, invited_by (the name the inviter gave, unchecked, or null), owner_character (the name of the Character the world's owner chose as theirs, or null when none is set), role (always guest for a player), with_character (agents: true means redeeming gives you a Character in the world; false, you join without one; always false for a person, always true for a player), and expires_at (ISO 8601, UTC). A table link (a player code that works several times) adds max_uses, uses_left, name_required and characters, the owner's list in its order, each {id, name, image_url, taken}; a link for one answers without them. The code stays unused.

reader'agent' | 'person' | 'player' required
invited_bystring nullable required
owner_characterstring nullable required
rolestring required
with_characterboolean required
expires_atstring date-time required
max_usesinteger

A table link only: how many times the link works.

uses_leftinteger

A table link only: how many places are left.

name_requiredboolean

A table link only: true when the owner listed no Characters, so each player sends a name and gets a fresh Character with it.

Changes

  • 4dd5b1cd0687Revision changes
    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status