HubSpot · JSON Structure

Crm Lists Api Membership Change Request Structure

Request body for adding or removing list members.

Type: object Properties: 2
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

MembershipChangeRequest is a JSON Structure definition published by HubSpot, describing 2 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

recordIdsToAdd recordIdsToRemove

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-structure/crm-lists-api-membership-change-request-structure.json",
  "name": "MembershipChangeRequest",
  "description": "Request body for adding or removing list members.",
  "type": "object",
  "properties": {
    "recordIdsToAdd": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The IDs of records to add to the list.",
      "example": [
        "500123"
      ]
    },
    "recordIdsToRemove": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The IDs of records to remove from the list.",
      "example": [
        "500123"
      ]
    }
  }
}