WRwriter
KG API

Update graph

Changed on

Update the name, description, web connector URLs, or team assignment of a Knowledge Graph.

Including a team_ids array replaces the whole team assignment: an empty array makes the Knowledge Graph org-wide, one or more team IDs scope it to exactly those teams. Omitting team_ids leaves the current team assignment unchanged. Team-scoped API keys cannot change the team assignment of a Knowledge Graph.

put/v1/graphs/{graph_id}

Request

  • Base URL
    https://api.writer.com
  • URL
    https://api.writer.com/v1/graphs/{graph_id}
  • Auth
    HTTP bearer

Path parameters

graph_idstring uuid required

The unique identifier of the Knowledge Graph.

Request body

namestring

The name of the Knowledge Graph (max 255 characters). Omitting this field leaves the name unchanged.

descriptionstring

A description of the Knowledge Graph (max 255 characters). Omitting this field leaves the description unchanged.

team_idsinteger[]

Optional list of team IDs the Knowledge Graph is deployed to. Omitting this field leaves the current team assignment unchanged. Passing an array replaces the whole team assignment: an empty array makes the graph org-wide, one or more team IDs scope it to exactly those teams. Not accepted from team-scoped API keys.

Response

idstring uuid required

A unique identifier of the Knowledge Graph.

created_atstring date-time required

The timestamp when the Knowledge Graph was created.

namestring required

The name of the Knowledge Graph (max 255 characters).

descriptionstring

A description of the Knowledge Graph (max 255 characters).

team_idsinteger[]

The team IDs the Knowledge Graph is deployed to. An empty array indicates an org-wide Knowledge Graph accessible to every team in the organization.

Changes

  • 55e7d6385506Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

  • 0bbaae2a6920Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status