Contact Groups

Update a contact group

Updates an existing contact group's fields and returns the updated group.

patch/v1/contact-groups/{id}

Request

  • Base URL: https://api.samva.dev
  • URL: https://api.samva.dev/v1/contact-groups/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring required

Request body

namestring nullable
descriptionstring nullable
type'static' | 'dynamic' | 'smart' nullable
criteriaobject nullable
color'clay' | 'sand' | 'moss' | 'sky' | 'plum' | 'rose' nullable
iconstring nullable
parentGroupIdstring
isActiveboolean nullable

Response

Success

idstring required
organizationIdstring required
namestring required
descriptionstring nullable required
type'static' | 'dynamic' | 'smart' required
criteriaobject nullable required
color'clay' | 'sand' | 'moss' | 'sky' | 'plum' | 'rose' nullable required

The list's label color, one of six families, or null for the neutral chip. Customer-chosen and purely presentational; it carries no meaning the API enforces.

iconstring nullable required
parentGroupIdstring required
contactCountinteger required
lastCalculatedAtstring nullable required
isActiveboolean required
createdAtstring required
updatedAtstring required

Changes

No recorded changes to this operation across all 1 revision of this API.