Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB
Communities::Membership

Create Membership

Add a contact as a member of a community

post/communities/{community_id}/memberships

Path parameters

community_idinteger required

Request body

Example request

{
  "communities_membership": {
    "communities_membership": {
      "contact_id": "GhIjKl",
      "moderator": false,
      "space_ids": [
        "SpAcEa",
        "SpAcEb"
      ]
    }
  }
}

Response

Created

idinteger

Membership ID

public_idstring nullable

Membership public ID

community_idinteger

ID of the Community this membership belongs to

moderatorboolean nullable

Whether this member has moderator privileges in the community

created_atstring date-time

Created at

updated_atstring date-time

Updated at

Example response

{
  "id": 101,
  "public_id": "AbCdEf",
  "community_id": 1,
  "moderator": false,
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z",
  "contact": {
    "id": 55,
    "public_id": "GhIjKl",
    "email_address": "member@example.com",
    "first_name": "Jane",
    "last_name": "Doe",
    "phone_number": null
  }
}