SMAO API Documentation
Public APIGroups

Update a group

PATCH
/groups/{group_id}

Authorization

bearerAuth
AuthorizationBearer <token>

API key in the Authorization: Bearer <key> header. Keys are created in the SMAO dashboard (Settings → API Keys).

In: header

Path Parameters

group_id*string
Match^[a-f0-9]{24}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Properties1 <= properties

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/groups/65f8fa6f1a9d8e0012ab34cd" \  -H "Content-Type: application/json" \  -d '{    "name": "Enterprise Customers"  }'
{  "data": {    "id": "string",    "type": "contacts",    "name": "string",    "description": "string",    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  }}

Get a group GET

Get a group

Delete a group DELETE

Permanently deletes the group and all contacts, knowledge items, forwardings, glossary entries, or pronunciation rules it contains. Knowledge chunks are also removed. This operation is not reversible.