chatrail-dev Groups API
Creating and running WhatsApp groups from a connected number.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/chatrail-dev:chatrail-dev-groups-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: ChatRail Groups API
version: 1.0.0
description: 'Send, schedule and receive WhatsApp messages through a linked-device session.
**Two things the API is careful about, which shape every endpoint below.**
*Accepted is not delivered.* A 202 means the message is durably stored and queued. Only the `status` field ever claims WhatsApp delivered anything, and `queued`, `submitted`, `sent`, `delivered` and `read` are deliberately distinct.
*A retry must not send twice.* Send `Idempotency-Key` on every send. A replay returns the original response; a concurrent duplicate is told to retry rather than allowed to race.'
contact:
name: ChatRail
url: https://www.chatrail.dev
servers:
- url: https://www.chatrail.dev
security:
- apiKey: []
tags:
- name: Groups
description: Creating and running WhatsApp groups from a connected number.
paths:
/v1/connections/{connection}/groups:
post:
summary: Create a group
description: 'Creates a WhatsApp group with this number as its owner. Everyone added counts against the member-add guardrail: at most 20 people per connection per hour, because adding people who did not ask to be added is how numbers get reported. Paid plans.'
tags:
- Groups
operationId: post_v1_connections__connection__groups
parameters:
- name: connection
in: path
required: true
schema:
type: string
description: Connection slug.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
minLength: 1
maxLength: 100
participants:
minItems: 1
maxItems: 50
type: array
items:
type: string
minLength: 5
maxLength: 40
required:
- name
- participants
additionalProperties: false
example:
name: Riverside viewings
participants:
- '+447700900123'
- '+447700900456'
responses:
'201':
description: The new group, with its members.
'402':
description: Not on this plan.
'429':
description: Over the member-add guardrail for this hour.
security:
- apiKey:
- connections:write
x-scopes:
- connections:write
/v1/connections/{connection}/groups/{group}:
get:
summary: Get a group
description: Name, description, settings and members with their roles.
tags:
- Groups
operationId: get_v1_connections__connection__groups__group_
parameters:
- name: connection
in: path
required: true
schema:
type: string
description: Connection slug.
- name: group
in: path
required: true
schema:
type: string
description: Group id.
responses:
'200':
description: The group.
'404':
description: No such group for this number.
security:
- apiKey:
- connections:read
x-scopes:
- connections:read
patch:
summary: Update a group
description: Change the name or description, or who may send messages and edit group info. This number must be an admin of the group. Paid plans.
tags:
- Groups
operationId: patch_v1_connections__connection__groups__group_
parameters:
- name: connection
in: path
required: true
schema:
type: string
description: Connection slug.
- name: group
in: path
required: true
schema:
type: string
description: Group id.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
minLength: 1
maxLength: 100
description:
type: string
maxLength: 2048
messages_admins_only:
type: boolean
info_admins_only:
type: boolean
additionalProperties: false
example:
messages_admins_only: true
responses:
'200':
description: The updated group.
'409':
description: WhatsApp refused; not an admin?
security:
- apiKey:
- connections:write
x-scopes:
- connections:write
/v1/connections/{connection}/groups/{group}/participants:
post:
summary: Change group members
description: '`add`, `remove`, `promote` to admin or `demote`. Adding counts against the member-add guardrail (20 per connection per hour). Paid plans.'
tags:
- Groups
operationId: post_v1_connections__connection__groups__group__participants
parameters:
- name: connection
in: path
required: true
schema:
type: string
description: Connection slug.
- name: group
in: path
required: true
schema:
type: string
description: Group id.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
action:
type: string
enum:
- add
- remove
- promote
- demote
participants:
minItems: 1
maxItems: 50
type: array
items:
type: string
minLength: 5
maxLength: 40
required:
- action
- participants
additionalProperties: false
example:
action: add
participants:
- '+447700900789'
responses:
'200':
description: The group after the change.
'429':
description: Over the member-add guardrail for this hour.
security:
- apiKey:
- connections:write
x-scopes:
- connections:write
/v1/connections/{connection}/groups/{group}/invite:
get:
summary: Get a group invite link
description: The chat.whatsapp.com link for joining the group.
tags:
- Groups
operationId: get_v1_connections__connection__groups__group__invite
parameters:
- name: connection
in: path
required: true
schema:
type: string
description: Connection slug.
- name: group
in: path
required: true
schema:
type: string
description: Group id.
responses:
'200':
description: The link.
security:
- apiKey:
- connections:read
x-scopes:
- connections:read
/v1/connections/{connection}/groups/{group}/invite/revoke:
post:
summary: Revoke a group invite link
description: Invalidates the current link and returns a new one.
tags:
- Groups
operationId: post_v1_connections__connection__groups__group__invite_revoke
parameters:
- name: connection
in: path
required: true
schema:
type: string
description: Connection slug.
- name: group
in: path
required: true
schema:
type: string
description: Group id.
responses:
'200':
description: The new link.
security:
- apiKey:
- connections:write
x-scopes:
- connections:write
/v1/connections/{connection}/groups/{group}/leave:
post:
summary: Leave a group
description: This number leaves the group.
tags:
- Groups
operationId: post_v1_connections__connection__groups__group__leave
parameters:
- name: connection
in: path
required: true
schema:
type: string
description: Connection slug.
- name: group
in: path
required: true
schema:
type: string
description: Group id.
responses:
'204':
description: Left.
security:
- apiKey:
- connections:write
x-scopes:
- connections:write
components:
securitySchemes:
apiKey:
type: http
scheme: bearer
description: 'A workspace API key, `cr_live_…`. Server-side only: it carries workspace authority and must never reach a browser.'
session:
type: apiKey
in: cookie
name: chatrail_session
description: Dashboard session cookie. Set by `/v1/auth/verify`.