pub struct RoleCreate {
pub group_type_id: i64,
pub grow_path_id: Option<i64>,
pub is_default: bool,
pub is_hidden: bool,
pub is_leader: Option<bool>,
pub name: String,
pub shorty: String,
pub sort_key: i64,
pub type: String,
pub extra: Map<String, Value>,
}Fields§
§group_type_id: i64ID of the group type this role belongs to. Discover group types with GET /group/grouptypes.
grow_path_id: Option<i64>ID of the growth path associated with this role, or null for no association. Growth paths track steps in a person’s development in ChurchTools.
is_default: boolWhether this is the default role for its group type. Setting this to true clears the default flag on the other roles of that type.
Whether this role is marked as hidden for displays that exclude hidden roles, such as leader listings. Hidden roles are still returned by this endpoint; this flag is not an access permission.
is_leader: Option<bool>Use type instead; this field is not used to create or update a role.
Legacy response field indicating whether type is leader. Use type instead; this field is not used to create or update a role.
name: StringStored name of the role. Use nameTranslated from the response for a localized display name.
shorty: StringAbbreviated label for the role, used in compact displays.
sort_key: i64Display order among roles. Lower values come first.
type: StringFunctional classification of the role. Multiple roles with different names can share the same classification.
Allowed values: leader, participant.
extra: Map<String, Value>Fields not described by the spec, e.g. instance-specific DB fields.