Universes Management

Update Universe

Update the universe metadata

PATCH

https://api.textreveal.com/v3/universes/{universe_id}

The response will not be in JSON format.
Response will contain the Content-Type: header.

Parameters

universe_id*uuid
Unique identifier of the universe.

Request Body

namestring
Name of the universe.
Example: "Tech Asian companies"
typestring (enum)
Universe visibility and access level.
- PRIVATE: visible and manageable by the owner only.
- SHARED: visible to the owner and company members, manageable by the owner.
- SESAMM: visible to company members, not manageable.
Values: "PRIVATE", "SHARED", "SESAMM"
descriptionstring | null
Description of the universe
Example: "The Asian companies that are in the Tech sector"
owneruuid
Identifier of the user who will own the universe.
companyuuid
Identifier of the company the universe is shared with. Warning: Overwrites all the links to other companies.

Request

{
  "name": "Tech Asian companies",
  "type": "PRIVATE",
  "description": "The Asian companies that are in the Tech sector",
  "owner": "00000000-0000-0000-0000-000000000000",
  "company": "00000000-0000-0000-0000-000000000000"
}

{
  "name": "Tech Asian companies",
  "type": "PRIVATE",
  "description": "The Asian companies that are in the Tech sector",
  "owner": "00000000-0000-0000-0000-000000000000",
  "company": "00000000-0000-0000-0000-000000000000"
}

Error - 400

Bad request

message*string
Error message.
Example: "Check the errors field for more details"
code*number (enum)
Error code.
Values: 400
reason*string (enum)
Error reason.
Values: "invalid"
errorsobject[]
Possible error causes.

Response

{
  "message": "Check the errors field for more details",
  "code": 400,
  "reason": "invalid",
  "errors": [
    {
      "message": "string",
      "field": "name",
      "reason": "invalid_type"
    }
  ]
}

{
  "message": "Check the errors field for more details",
  "code": 400,
  "reason": "invalid",
  "errors": [
    {
      "message": "string",
      "field": "name",
      "reason": "invalid_type"
    }
  ]
}

Error - 403

Forbidden

message*string
Error message.
Example: "You are not allowed to update this universe"
code*number (enum)
Error code.
Values: 403
reason*string (enum)
Error reason.
Values: "forbidden"

Response

{
  "message": "You are not allowed to update this universe",
  "code": 403,
  "reason": "forbidden"
}

{
  "message": "You are not allowed to update this universe",
  "code": 403,
  "reason": "forbidden"
}

Error - 404

Not found

message*string
Error message.
Example: "The requested universe does not exist or is not visible to your company."
code*number (enum)
Error code.
Values: 404
reason*string (enum)
Error reason.
Values: "not_found"

Response

{
  "message": "The requested universe does not exist or is not visible to your company.",
  "code": 404,
  "reason": "not_found"
}

{
  "message": "The requested universe does not exist or is not visible to your company.",
  "code": 404,
  "reason": "not_found"
}

Error - 409

Conflict

message*string
Error message.
Example: "Universe with this name already exists"
code*number (enum)
Error code.
Values: 409
reason*string (enum)
Error reason.
Values: "invalid"

Response

{
  "message": "Universe with this name already exists",
  "code": 409,
  "reason": "invalid"
}

{
  "message": "Universe with this name already exists",
  "code": 409,
  "reason": "invalid"
}

Generic errors are not shown, see Errors for more details.