API ReferenceOrganization Role
organizationRole.assignSiteRole
Type: Mutation · Auth: Workspace-aware
Input
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| siteId | string | Yes | — | ID of the associated site |
| organizationId | string | Yes | — | ID of the associated organization |
| role | enum(owner, occupant, property_manager, service_customer, default_bill_to) | Yes | — | Role |
| roleDetail | string | No | — | Role detail |
| isPrimary | boolean | Yes | false | Is primary |
| effectiveStart | string.date-time | No | — | Effective start |
| notes | string | No | — | Notes |
Example
{
"siteId": "550e8400-e29b-41d4-a716-446655440000",
"organizationId": "550e8400-e29b-41d4-a716-446655440000",
"role": "owner",
"roleDetail": "example",
"isPrimary": false,
"effectiveStart": "2024-01-15T09:00:00.000Z"
}