Group

patch

https://api.marketcircle.net/v1/groups/{id}

Edit a group

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

See Group for the attributes. Attributes you leave out are not changed. Lists such as keywords and contacts accept {"add": [...], "remove": [...]} to change only some entries; for subgroups, see Subgroups.

A group in the trash can't be edited (404 with {"error":"trashed_object"}) until you restore it with {"trashed": false}. A successful update returns 204 No Content.

Path Params

int32

required

The group ID

Body Params

name

string

Name (max 512 characters).

details

string

Details (max 2048 characters).

priority

integer

0 to 10

Priority from 0 (none) to 10.

category

string

Category name. Created if it does not exist. Send null or "" to clear.

keywords

List of keyword names (max 64). Keywords that do not exist are created. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

extra_fields

object

Extra (custom) field values of the group, keyed by the field's default identifier even if it has been renamed. Each value is an object with a value key. Fields you leave out are not changed; send null or {} to clear all of them.

start

date-time

Start date, e.g. 2025-04-01T00:00:00Z. Required if end is set.

end

date-time

End date. Must be after start.

subgroups

object

References of groups to make subgroups of this group, e.g. {"add": ["/v1/groups/2001"]} (max 32 subgroups, nested at most 5 levels deep). To detach a subgroup, set that group's parent_group to null.

parent_group

string

Reference of the parent group, e.g. /v1/groups/1001. Send null to make this a top-level group.

appointments

Appointments linked to the group. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

contacts

Contacts linked to the group. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

companies

Companies linked to the group. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

opportunities

Opportunities linked to the group. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

projects

Projects linked to the group. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

tasks

Tasks linked to the group. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

notes

Notes linked to the group. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

forms

Forms linked to the group. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

email_messages

Emails to link to the group. Write-only: use GET /v1/groups/{id}/emails to list them. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

owner

string

Reference to the user responsible for the group, e.g. /v1/users/1000. Defaults to the user making the request.

trashed

boolean

Set to false to restore the group from the trash. Use DELETE to move it to the trash.

Responses

204

204 No Content

400400 Bad Request

404404 Not Found