643 matches
49 actions
ExaVault
49 actions
Storage/ExaVault
Add or remove emails from an email list that can be used to send and share files with groups.
Notes
This call will replace your current email list in its entirety. If you want to keep any existing emails on the list, be sure to submit the call with any current emails you want to keep on the list.
{
"type": "object",
"properties": {
"emails": {
"type": "array",
"description": "Email addresses that replace existing list.",
"items": {
"type": "string"
}
},
"ev-access-token": {
"type": "string"
},
"ev-api-key": {
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string",
"description": "Name of the email list."
}
},
"required": [
"ev-access-token",
"ev-api-key",
"id"
],
"additionalProperties": false
}{
"type": "object",
"description": "Response object for a single email list.",
"properties": {
"data": {
"type": "object",
"description": "A single email group list",
"properties": {
"attributes": {
"type": "object",
"description": "Information for the email list, including its short title and recipient emails",
"properties": {
"created": {
"type": "string",
"format": "date-time",
"description": "Created datetime"
},
"emails": {
"type": "array",
"description": "Recipient emails in the email list",
"items": {
"type": "string"
}
},
"modified": {
"type": "string",
"format": "date-time",
"description": "Modified datetime"
},
"name": {
"type": "string",
"description": "Short title for email list"
}
}
},
"id": {
"type": "integer",
"description": "ID of the email list"
},
"relationships": {
"type": "object",
"description": "Related record summary info",
"properties": {
"ownerUser": {
"type": "object",
"description": "Information for user who owns the email list",
"properties": {
"data": {
"type": "object",
"description": "Identifying info for related record",
"properties": {
"id": {
"type": "integer",
"description": "ID number of related record"
},
"type": {
"type": "string",
"description": "Kind of record"
}
}
}
}
}
}
},
"type": {
"type": "string",
"description": "Type of record. \"emailList\""
}
}
},
"included": {
"type": "array",
"items": {
"type": "object",
"description": "Object contains user properties.",
"properties": {
"attributes": {
"type": "object",
"description": "Attributes of the user including expiration, home directory, and permissions. ",
"required": [
"status",
"created",
"modified",
"accountName",
"username",
"nickname",
"homeResource",
"permissions",
"role",
"timeZone",
"onboarding"
],
"properties": {
"accessTimestamp": {
"type": "string",
"description": "Timestamp of most recent successful user login."
},
"accountName": {
"type": "string",
"description": "Name of the account this user belongs to."
},
"created": {
"type": "string",
"format": "date-time",
"description": "Timestamp of user creation."
},
"email": {
"type": "string",
"description": "Email address of the user."
},
"expiration": {
"type": "string",
"description": "Timestamp of user expiration."
},
"firstLogin": {
"type": "boolean",
"description": "`true` if the user has logged into the system."
},
"homePath": {
"type": "string",
"description": "Path to the user's home folder."
},
"locked": {
"type": "boolean",
"description": "`true` if the user is locked and cannot log in."
},
"modified": {
"type": "string",
"format": "date-time",
"description": "Timestamp of user modification."
},
"nickname": {
"type": "string",
"description": "Nickname of the user."
},
"onboarding": {
"type": "boolean",
"description": "Whether the onboarding help system is enabled for this user. `true` means that additional help popups are displayed in the web application for this user."
},
"permissions": {
"type": "object",
"required": [
"download",
"upload",
"modify",
"delete",
"list",
"changePassword",
"share",
"notification",
"viewFormData",
"deleteFormData"
],
"properties": {
"changePassword": {
"type": "boolean",
"description": "Change (own) password permission flag"
},
"delete": {
"type": "boolean",
"description": "Delete permission flag"
},
"deleteFormData": {
"type": "boolean",
"description": "Delete form data permission flag. If true, user can remove data that was submitted for a receive folder. This applies only to data submitted in the receive folder form, not the actual files uploaded."
},
"download": {
"type": "boolean",
"description": "Download permission flag"
},
"list": {
"type": "boolean",
"description": "View folder contents permission flag"
},
"modify": {
"type": "boolean",
"description": "Modify permission flag"
},
"notification": {
"type": "boolean",
"description": "Notifications permission flag"
},
"share": {
"type": "boolean",
"description": "Sharing permission flag"
},
"upload": {
"type": "boolean",
"description": "Upload permission flag"
},
"viewFormData": {
"type": "boolean",
"description": "Access Form Data permission flag. If true, user can view submissions that have been stored for a receive folder. This includes any data submitted in the receive folder form."
}
}
},
"role": {
"type": "string",
"description": "User's access level",
"enum": [
"user",
"admin",
"master"
]
},
"status": {
"type": "integer",
"format": "int32",
"description": "Indicates user activity status. `0` means the user is locked and cannot log in. `1` means the user is active and can log in.",
"enum": [
0,
1
]
},
"timeZone": {
"type": "string",
"description": "User's timezone. See <a href='https://php.net/manual/en/timezones.php' target='blank'>this page</a> for allowed values."
},
"username": {
"type": "string",
"description": "Username of the user."
}
}
},
"id": {
"type": "integer",
"format": "int32",
"description": "ID of the user."
},
"relationships": {
"type": "object",
"description": "Home resource and owner account relationship data for the user. ",
"required": [
"ownerAccount"
],
"properties": {
"homeResource": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "ID of home directory resource."
},
"type": {
"type": "string",
"description": "Type is resource.",
"enum": [
"resource"
]
}
}
}
}
},
"ownerAccount": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "ID of the account."
},
"type": {
"type": "string",
"description": "Type is account.",
"enum": [
"account"
]
}
}
}
}
}
}
},
"type": {
"type": "string",
"description": "Type of object being returned. Always \"user\""
}
}
}
},
"responseStatus": {
"type": "integer",
"format": "int32",
"description": "Http Status code"
}
}
}