Syndicate Members

Invite member

Changed on

Send an invitation to join the syndicate by email.

post/syndicates/{syndicate_id}/members/invite

Request

  • Base URL: https://api.wefunder.com
  • URL: https://api.wefunder.com/syndicates/{syndicate_id}/members/invite
  • Auth: OAuth 2 (authorization code, authorization URL https://wefunder.com/oauth/authorize, token URL https://api.wefunder.com/oauth/token; client credentials, token URL https://api.wefunder.com/oauth/token, scopes: write:syndicates)

Path parameters

syndicate_idstring required

The syndicate's id (syn_...).

Request body

emailstring email required
namestring

Display name for the invitee

syndicate_permission'full_access' | 'operator'

Permission level. Only the syndicate creator can assign full_access (admin).

Example request

{
  "email": "jane@example.com"
}

Response

Invitation sent

Example response

{
  "data": {
    "id": "mem_3StSZhDjMHzn8NzEkX0kgEuN",
    "type": "syndicate_member",
    "attributes": {
      "user_id": 123,
      "user": "usr_8Kd0aB3xQ9k2vF8mNp1zT5wY",
      "user_name": "Jane Smith",
      "user_email": "user@example.com",
      "role": "member",
      "invite_role": "admin",
      "title": "Example title",
      "sort_order": 5,
      "carry_percentage_override": 20,
      "public_on_syndicate_profile": true,
      "avatar_url": "https://uploads.wefunder.com/uploads/user/avatar/456/large_photo.jpg",
      "bio": "Example text",
      "city": "San Francisco",
      "country": "US",
      "last_activity_at": "2025-03-01T12:00:00Z",
      "profile_url": "/janedoe",
      "tags": [
        "Fundraising",
        "Product Strategy"
      ],
      "joined_at": "2025-03-01T12:00:00Z",
      "investment_total": "5000",
      "deal_count": 2,
      "accredited": true,
      "legal_name": "Example Name",
      "starred": true,
      "private_tags": [
        "VIP",
        "Follow up"
      ],
      "created_at": "2025-03-01T12:00:00Z",
      "updated_at": "2025-03-01T12:00:00Z"
    }
  }
}

Changes

  • f7ce1e834ec5Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • b13c74d0be35Revision changes
    • breaking

      the // response's property type changed from string to integer for status

    • breaking

      the / response's property type changed from integer to string for status

    • info

      added the optional property // to the response with the status

    • info

      response property data/attributes/user_id deprecated