Create a custom team template

PUT /api/2.0/settings/customschemas

Request

Creates a custom team template with the parameters specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Content-Typeenum of string

Can be one of: application/json, application/*+json, text/json.

Body

Team template parameters

idstring

Team template ID

namestring

Team template name

userCaptionstring

User caption

usersCaptionstring

Users caption

groupCaptionstring

Group caption

groupsCaptionstring

Groups caption

userPostCaptionstring

User status caption

regDateCaptionstring

Registration date caption

groupHeadCaptionstring

Group lead caption

guestCaptionstring

Guest caption

guestsCaptionstring

Guests caption

Examples

PUT /api/2.0/settings/customschemas HTTP/1.1
Accept: application/json
Content-Length: 332
Content-Type: application/json
Host: example.com

{
  "id": "1801",
  "name": "Ike Kessler",
  "userCaption": "some text",
  "usersCaption": "some text",
  "groupCaption": "some text",
  "groupsCaption": "some text",
  "userPostCaption": "some text",
  "regDateCaption": "some text",
  "groupHeadCaption": "some text",
  "guestCaption": "some text",
  "guestsCaption": "some text"
}
curl --request PUT \
  --url https://example.com/api/2.0/settings/customschemas \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "1801",
  "name": "Ike Kessler",
  "userCaption": "some text",
  "usersCaption": "some text",
  "groupCaption": "some text",
  "groupsCaption": "some text",
  "userPostCaption": "some text",
  "regDateCaption": "some text",
  "groupHeadCaption": "some text",
  "guestCaption": "some text",
  "guestsCaption": "some text"
}'

Responses

200

Custom team template with the following parameters

Team template parameters

idstring

Team template ID

namestring

Team template name

userCaptionstring

User caption

usersCaptionstring

Users caption

groupCaptionstring

Group caption

groupsCaptionstring

Groups caption

userPostCaptionstring

User status caption

regDateCaptionstring

Registration date caption

groupHeadCaptionstring

Group lead caption

guestCaptionstring

Guest caption

guestsCaptionstring

Guests caption

401

Unauthorized

403

Forbidden

Get Help

  • If you have any questions about ONLYOFFICE DocSpace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).