SP.Web.description property (sp.js)

Gets or sets the description for the site.

Applies to: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Server 2013

var value = SP.Web.get_description ()
var value = SP.Web.set_description ()

Return value

Type: String

A string that contains the description of the site.

REST resource endpoint

See Web resource for more information.

Endpoint URI structure


HTTP requests

This resource supports the following HTTP commands:

  • POST

POST syntax

POST http://<sitecollection>/<site>/_api/web/description

GET syntax

GET http://<sitecollection>/<site>/_api/web/description