Create a contact group

posthttps://api.expiryedge.com/v1/createContactGroup
editor or admin60/minIdempotency-KeyJede Methode
Anfrage
curl -X POST 'https://api.expiryedge.com/v1/createContactGroup' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "Vendors",
  "color": "#2e7d32"
}'
Antwort
{
  "message": "Group created",
  "group": {
    "id": "grp_7Qw2",
    "organization_id": "org_northwind",
    "name": "Vendors",
    "color": "#2e7d32",
    "sortOrder": 3,
    "createdAt": "2026-09-27T14:05:00.000Z",
    "updatedAt": "2026-09-27T14:05:00.000Z"
  }
}

Names are unique per organization (case-insensitive, 409 GROUP_EXISTS). color defaults to a color derived from the name; sortOrder defaults to the end of the list.

Header

  • Idempotency-Keystring
    Optional client-generated key (1-255 characters of letters, digits, - _ : .).
    pattern: ^[A-Za-z0-9_\-:.]{1,255}$

Body-Parameter

application/json
  • namestring
    Required on create. Unique per organization (case-insensitive).
  • colorstring
    Hex color; empty derives one from the name.
  • sortOrdernumber

Rückgabe

201
Group created.
  • messagestringerforderlich
  • groupobjecterforderlich
    An organization-wide contact group.

Fehler

400
The request is missing required fields or contains invalid values.
401
Missing, expired or invalid bearer token.
403
Authenticated, but your role or organization does not allow this action.
404
The record does not exist or is not in your organization.
409
A group with that name already exists.; or a request with the same Idempotency-Key is still being processed (code IDEMPOTENCY_IN_PROGRESS).
422
The Idempotency-Key was already used with a different request body.
429
Too many requests for this endpoint from your IP. Wait Retry-After seconds.