Create user groups

POST {{baseUrl}}/api/v1/groups

This API creates a user group in your help center.

OAuth Scope

  • Desk.contacts.CREATE
  • Desk.settings.CREATE

Attributes

Attribute NameData TypeDescription
name (required)<string>
max chars : 100
Name of the group
description<string>
max chars : 3000
A brief description of the group
logoId<long>
ID of the logo to associate with the group
helpCenterId (required)<long>
ID of the help center in which the group must be created

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{&quot;modifiedTime&quot;:&quot;2017-09-19T04:58:50.000Z&quot;,&quot;creator&quot;:{&quot;photoURL&quot;:&quot;https://desk.zoho.com/portal/api/user/6000000015895/photo?orgId=143315&quot;,&quot;name&quot;:&quot;SupportAdmin&quot;,&quot;id&quot;:&quot;310975130121&quot;},&quot;modifier&quot;:{&quot;photoURL&quot;:&quot;https://desk.zoho.com/portal/api/user/6000000015895/photo?orgId=143315&quot;,&quot;name&quot;:&quot;SupportAdmin&quot;,&quot;id&quot;:&quot;310975130121&quot;},&quot;name&quot;:&quot;Prime Customer&quot;,&quot;count&quot;:&quot;0&quot;,&quot;description&quot;:&quot;Prime customer will have special access to Knowledge base module and Community categories&quot;,&quot;createdTime&quot;:&quot;2017-09-19T04:58:50.000Z&quot;,&quot;id&quot;:&quot;310975134902&quot;,&quot;helpCenterId&quot;:&quot;31097519102&quot;,&quot;logoUrl&quot;:&quot;https://desk.zoho.com/portal/api/publicImages/310975130121?portalId=5c9470fcc808cc98932703e28221d6c302e105dc4da8b23fafb6719abeecaa48&quot;,&quot;status&quot;:&quot;ACTIVE&quot;}