Group

Edit a group

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The identifier of the group

Body Params
string

Name of the group

string

Details of the group

int32

Priority of the group 1-10

string

Category name assigned to the group

keywords
array of strings

List of Keywords

keywords
extra_fields
object

Each extra field will use its default name even if you have customized it

date

Start date Example: 2025-06-19T13:52:36Z

date

End date. Example: 2025-06-30T13:52:18Z

appointments
array of objects

List of Appointments Example: /v1/appointments/1001

appointments
contacts
array of objects

List of Contacts Example: /v1/contacts/1001

contacts
companies
array of objects

List of Companies Example: /v1/companies/1001

companies
opportunities
array of objects

List of Opportunities Example: /v1/opportunities/1001

opportunities
projects
array of objects

List of Projects Example: /v1/projects/1001

projects
forms
array of objects

List of Forms Example: /v1/forms/1001

forms
notes
array of objects

List of Notes Example: /v1/notes/1001

notes
tasks
array of objects

List of Tasks Example: /v1/tasks/1001

tasks
string

Owner reference. Example: /v1/users/1000

boolean

You can use this to untrash an object by setting it to false. true will do nothing, use delete for that.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json