POST
/
conversations
/
groups
curl --request POST \
  --url https://schoolmaker.co/api/v1/conversations/groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "<string>",
  "message": "<string>",
  "sender_id": "school_owner_id",
  "member_participants": [
    "jsmith@example.com"
  ],
  "user_participants": [
    "jsmith@example.com"
  ]
}'
{
  "group_id": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
message
string
required
member_participants
string[]
required

Array of member email addresses

Array of member email addresses

title
string

The title is optional, by default it will just be the names of the participants

sender_id
string
default:school_owner_id

The ID of the admin or moderator sender. Default is the school owner.

user_participants
string[]

Array of user email addresses

Array of user email addresses

Response

201 - application/json
Group created
group_id
string

The ID of the created conversation group