Last updated
Was this helpful?
Last updated
Was this helpful?
phoneRepresents an app user's mobile phone.
created_atFormat: Datetime
Date and time at which the phone was created.
custom_metadataFormat: Record
Optional for the phone.
device_idFormat: UUID
ID of the phone.
device_typeFormat: Enum
Type of phone.
Possible enum values:
ios_phone
android_phone
display_nameFormat: String
Display name of the phone. Defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones.
errorsFormat: List
Item format: Object
Errors associated with the phone.
nicknameFormat: String
Optional nickname to describe the phone, settable through Seam.
propertiesFormat: Object
Properties of the phone.
warningsFormat: List
Item format: Object
Warnings associated with the phone.
workspace_idFormat: UUID
Returns a single phone entry matching the provided device_id.
Returns a list of all phones. To filter the list of returned phones by a specific owner user identity or credential, include the owner_user_identity_id or acs_credential_id, respectively, in the request body.
phone.deactivatedA phone device was deactivated.
ID of the that contains the phone.
Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see .
ID of the .
ID of the .