deleteUnitSpace mutation
This mutation is offered as part of the product management capability, which is available to pilot partners only. If you are interested in adopting this capability, contact your Technical Account Manager.
Deletes a space from a unit. The space ID is required. Refer to updateUnit to delete unit data, such as its size or an amenity.
Implementation details:
- You cannot delete all spaces. A minimum of one bedroom must exist for a unit.
- If a bedroom or living room is deleted, it may take a several seconds for the unit's bedroom or living room count to update.
- If only one type of space remains after issuing this mutation, the space's order will be set to 1 (no matter what order it was assigned previously).
Syntax
1mutation {2 deleteUnitSpace(5}
Example
- Request
- Response
1mutation {2 deleteUnitSpace(3 input: {4 spaceId: "3920jf236",5 unitId: "00je08374",6 propertyId: "d407e1545",7 clientMutationId: "7125dea-94543-ef6"8 }9 ) {10 clientMutationId11 }12}
Arguments
| Name | Description |
|---|---|
| Required. Type: DeleteUnitSpaceInput |
Types
Name | Type | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
DeleteUnitSpaceInput | InputObject | |||||||||||
IDs for the space to be deleted.
| ||||||||||||
DeleteUnitSpacePayload | Object | |||||||||||
Payload after deleting a unit space.
| ||||||||||||
ID | ID | |||||||||||
The | ||||||||||||
String | String | |||||||||||
The | ||||||||||||