HUhubspot
Basic

Update memberships

Changed on

Update the memberships of a list by adding and removing members in a single operation. This endpoint allows you to efficiently manage list memberships by specifying which members to add and which to remove in one request.

put/crm/lists/2026-09/{listId}/memberships/add-and-remove

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/crm/lists/2026-09/{listId}/memberships/add-and-remove
  • Auth
    • OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.lists.write, crm.segments.read
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: cms.membership.access_groups.write, crm.lists.read
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.segments.read, crm.segments.write
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.lists.read, crm.segments.write
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.lists.read, crm.lists.write
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: cms.membership.access_groups.write, crm.segments.read

Path parameters

listIdstring required

The unique identifier of the list whose memberships are to be updated.

Request body

recordIdsToAddstring[] required

An array of strings representing the unique identifiers of records to be added to the list.

recordIdsToRemovestring[] required

An array of strings representing the unique identifiers of records to be removed from the list.

Response

successful operation

recordIdsMissingstring[] required

An array of strings representing the IDs of records that were not found or could not be processed during the update.

recordIdsRemovedstring[] required

An array of strings representing the IDs of records that were successfully removed from the list.

recordsIdsAddedstring[] required

An array of strings representing the IDs of records that were successfully added to the list.

Changes

  • 2026-09e1dd745172d1Revision changes
    • info

      the security scope crm.lists.write was added to the endpoint's security scheme oauth2

    • info

      the security scope cms.membership.access_groups.write was removed from the endpoint's security scheme oauth2

  • 2026-096d0e6dc36ca0Revision changes
    • info

      the security scope crm.lists.write was added to the endpoint's security scheme oauth2

    • info

      the security scope cms.membership.access_groups.write was removed from the endpoint's security scheme oauth2