v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Org Groups

Bulk update org group memberships

Move a batch of organizations from one org group to another. This is an atomic operation. Maximum 100 orgs per request.

patch/api/v2/org_group_memberships/bulk

Request body

Example request

{
  "data": {
    "attributes": {
      "orgs": [
        {
          "org_site": "us1",
          "org_uuid": "c3d4e5f6-a7b8-9012-cdef-012345678901"
        }
      ]
    },
    "relationships": {
      "source_org_group": {
        "data": {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
          "type": "org_groups"
        }
      },
      "target_org_group": {
        "data": {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
          "type": "org_groups"
        }
      }
    },
    "type": "org_group_membership_bulk_updates"
  }
}

Response

Example response

{
  "data": [
    {
      "attributes": {
        "created_at": "2024-01-15T10:30:00Z",
        "modified_at": "2024-01-15T10:30:00Z",
        "org_name": "Acme Corp",
        "org_site": "us1",
        "org_uuid": "c3d4e5f6-a7b8-9012-cdef-012345678901"
      },
      "id": "f1e2d3c4-b5a6-7890-1234-567890abcdef",
      "relationships": {
        "org_group": {
          "data": {
            "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
            "type": "org_groups"
          }
        }
      },
      "type": "org_group_memberships"
    }
  ],
  "meta": {
    "page": {
      "type": "number_size"
    }
  }
}