Sign in
Syndicates

Update syndicate settings

Changed on

Update syndicate configuration. Currently supports name, description, and tagline. Requires write:syndicates scope and at least operator permission.

patch/syndicates/{syndicate_id}

Request

  • Base URL: https://api.wefunder.com
  • URL: https://api.wefunder.com/syndicates/{syndicate_id}
  • 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

Example request

{
  "syndicate": {
    "name": "Acme Syndicate"
  }
}

Response

Syndicate updated

Example response

{
  "data": {
    "id": "syn_aB3xQ9k2vF8mNp1zT5wY7Qc4",
    "type": "syndicate",
    "attributes": {
      "name": "Acme Syndicate",
      "slug": "acme-syndicate",
      "tagline": "Investing in the future of AI",
      "description": "Example text",
      "avatar_url": "https://uploads.wefunder.com/uploads/club/icon/42/large_avatar.png",
      "published": true,
      "launched": true,
      "membership_open": true,
      "member_count": 47,
      "deal_count": 3,
      "primary_fund_company_id": 4242,
      "primary_fund_company": "co_8Kd0aB3xQ9k2vF8mNp1zT5wY",
      "created_by_user_id": 123,
      "created_by": "usr_8Kd0aB3xQ9k2vF8mNp1zT5wY",
      "created_at": "2025-03-01T12:00:00Z",
      "updated_at": "2025-03-01T12:00:00Z"
    }
  }
}

Changes

  • f7ce1e834ec5Revision changes
    • breaking

      the response's property type changed from no type to object for 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

      removed from the response property allOf list for the response status

  • b13c74d0be35Revision 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

      response property data/allOf[Syndicate]/attributes/created_by_user_id deprecated