Samva
DashboardAPI
ChannelsPlatformMailboxesDevelopersEmail templatesIntegrationsAPI Reference
ContactGroups

Create a contact group

Creates a new contact group and returns it with a 201 status. Use this endpoint to create a contact group through the Samva email API.

POST
/v1/contact-groups

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

Authorization

apiKey
headerx-api-key<token>

Request Body

application/json
  1. body
name*string
Lengthlength <= 120
description?string|null|null
type?|null
criteria?|null|null
color?||null
icon?string|null|null
parentGroupId?|null|null
isActive?boolean|null

Response Body

Success

application/json
  1. response
id*ContactGroupId
Match^cgrp_[0-9a-hjkmnp-tv-z]{16,24}$
organizationId*OrganizationId
Match^org_[0-9a-hjkmnp-tv-z]{16,24}$
name*string
description*string|null
type*string
Value in"static""dynamic""smart"
criteria*|null
color*|

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.

icon*string|null
parentGroupId*|null
contactCount*integer
Range0 <= value <= 9007199254740991
lastCalculatedAt*string|null
isActive*boolean
createdAt*string
updatedAt*string
Example Request
import { createClient } from "samva";const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });const result = await samva.contactGroups.create({  "name": "example"});
Example Response
{  "id": "string",  "organizationId": "string",  "name": "string",  "description": "string",  "type": "static",  "criteria": {    "property1": "string",    "property2": "string"  },  "color": "clay",  "icon": "string",  "parentGroupId": "string",  "contactCount": 0,  "lastCalculatedAt": "string",  "isActive": true,  "createdAt": "string",  "updatedAt": "string"}

Related documentation

Add members to a contact group

Adds one or more contacts to a contact group, returning counts of added and skipped members. One request carries at most 1000 ids.

Evaluate a dynamic contact group

Recomputes a dynamic contact group's membership from its criteria, returning counts of added, removed, and total members.