v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Org Groups

Update an org group membership

Move an organization to a different org group by updating its membership.

patch/api/v2/org_group_memberships/{org_group_membership_id}

Path parameters

org_group_membership_idstring uuid required

Example:f1e2d3c4-b5a6-7890-1234-567890abcdef

The ID of the org group membership.

Request body

Example request

{
  "data": {
    "id": "f1e2d3c4-b5a6-7890-1234-567890abcdef",
    "relationships": {
      "org_group": {
        "data": {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
          "type": "org_groups"
        }
      }
    },
    "type": "org_group_memberships"
  }
}

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"
  }
}