FRfrigadehq
groups

Adds a new property or events for a given user group

post/v1/public/userGroups

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Request body

userIdstring

The ID of the user as defined in your own application

groupIdstring required

The ID of the group as defined in your own application

propertiesobject

Optional properties to add to the group

Example request

{
  "userId": "d34daa11-3745-4ac0-880e-d4b4d51fe13f",
  "groupId": "x34daa11-3745-4ac0-880e-d4b4d51fe13f",
  "properties": {
    "name": "Acme Inc.",
    "companyUrl": "https://example.com",
    "logoUrl": "https://example.com/logo.jpg"
  },
  "events": [
    {
      "event": "SignedUp",
      "properties": {
        "source": "landing-page",
        "campaign": "summer-sale"
      }
    }
  ]
}

Response

The property has been successfully created or updated.

Changes

No recorded changes to this operation across all 1 revision of this API.