Contact Groups

Create a contact group

Creates a new contact group and returns it with a 201 status.

post/v1/contact-groups

Request

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

Request body

namestring required
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.