Nodes

Create a new node

Changed on

Create a new node.

post/nodes/

Request

  • Base URL
    https://example.com/api
  • Auth
    • OAuth 2
      Authorization codehttps://example.com/oauth2/authorize
      Token URLhttps://example.com/api/oauth2/token
      Scopesnode:write
    • or API key in header XF-Api-Key
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Request body application/x-www-form-urlencoded

node[title]string required
node[node_name]string
node[description]string
node[parent_node_id]integer required
node[display_order]integer
node[display_in_list]boolean
node_type_idstring required

Response

OK

Changes

    • breaking

      request body became required

    • breaking

      removed the media type application/json from the request body

    • info

      api operation id post_nodes_ removed and replaced with postNodes

    • info

      the endpoint scheme security XF-Api-Key was added to the API

    • info

      the endpoint scheme security XF-OAuth2 was added to the API

    • info

      added the new optional header request parameter XF-Api-User to all path's operations

    • info

      added the new optional query request parameter api_bypass_permissions to all path's operations

    • warning

      the optional response header XF-Latest-Api-Version removed for the status 200

    • warning

      the optional response header XF-Request-User removed for the status 200

    • warning

      the optional response header XF-Request-User-Extras removed for the status 200

    • warning

      the optional response header XF-Used-Api-Version removed for the status 200

    • info

      api operation id postNodes removed and replaced with post_nodes_

    • info

      the endpoint scheme security XF-Api-Key was removed from the API

    • info

      the endpoint scheme security XF-OAuth2 was removed from the API

    • info

      request body became optional

    • info

      added the media type application/json to the request body