Groups
All operations require authentication.
33 operationsv1/email/exchange
List groupsProduction
GET
/1.0/
List groups. Returns the email addresses of the groups (distribution lists) of the service. Filter them by mailingListAddress or company.
Path parameters
exchange
required
string
The internal name of your exchange service
organization
required
string
The internal name of your exchange organization
Query parameters
company
string
Filter the value of company property (like)
mailing
string
Filter the value of mailingListAddress property (like)
Response
200string
Example uses exchangeService = string, organizationName = string
$ curl https:/[ "string"]
Get a groupProduction
GET
/1.0/
Get a group. Returns the address, display name, join and depart restrictions, size limits, sender authentication and state of the group.
Path parameters
exchange
required
string
The internal name of your exchange service
mailing
required
string
The mailing list address
organization
required
string
The internal name of your exchange organization
Response
200mailing
company
string
Company name
creation
read-only
stringdate-time
Creation date
depart
Mailing
Depart restriction policy
Values
closedopendisplay
string
Name displayed in Global Access List
hidden
boolean
If true mailing list is hiddend in Global Address List
id
read-only
integer
Mailing list id
join
Mailing
Join restriction policy
Values
approvalRequiredclosedopenlast
read-only
stringdate-time
Update date
mailing
string
The mailing list address
max
integer
Maximum receive email size in MB
max
integer
Maximum send email size in MB
sender
boolean
If true sender has to authenticate
spam
read-only
boolean
Account was sending spam
spam
read-only
integer
Ticket number of spam detection
state
read-only
Object
Mailing list state
Values
creatingdeletinginternalMigrationokreopeningsuspendedsuspendingtask
read-only
integer
Task pending id
Example uses exchangeService = string, mailingListAddress = string, organizationName = string
$ curl https:/{ "company": "string", "creationDate": "2024-01-01T12:00:00Z", "departRestriction": "closed", "displayName": "string", "hiddenFromGAL": true, "id": 0, "joinRestriction": "approvalRequired", "lastUpdateDate": "2024-01-01T12:00:00Z", "mailingListAddress": "string", "maxReceiveSize": 0, "maxSendSize": 0, "senderAuthentification": true, "spamDetected": true, "spamTicketNumber": 0, "state": "creating", "taskPendingId": 0}
Create a groupProduction
POST
/1.0/
Create a group. Creates a group from its mailingListAddress and its join and depart restrictions, and returns the task.
Path parameters
exchange
required
string
The internal name of your exchange service
organization
required
string
The internal name of your exchange organization
Request body (required)
company
string
Company name
depart
required
Mailing
Depart restriction policy
Values
closedopendisplay
string
Name displayed in Global Access List
hidden
boolean
If true mailing list is hiddend in Global Address List
join
required
Mailing
Join restriction policy
Values
approvalRequiredclosedopenmailing
required
string
The mailing list address
max
integer
Maximum receive email size in MB
max
integer
Maximum send email size in MB
sender
boolean
If true sender has to authenticate
Response
200Tasksuccessful operation
finish
read-only
stringdate-time
Completion date
function
read-only
Task
Function name
Values
activateSharepointaddAccountaddAccountArchiveaddAccountImpersonationaddActiveSyncMailNotificationaddAliasaddDistributionGroupaddDistributionGroupManageraddDistributionGroupMemberaddDistributionGroupSendAsaddDistributionGroupSendOnBehalfToaddDomainaddDomainDisclaimeraddExchangeCustomIsolationaddExchangeDomainDKIMaddExchangeRemoteMailboxaddExchangeServiceAuthorizedIpaddExportPstRequestaddExternalContactaddFullAccessaddOutlookLicenseaddPublicFolderaddPublicFolderPermissionaddResourceAccountaddResourceDelegateaddSendAsaddSendConnectoraddSendOnBehalfToaddSharedAccountaddSharedAccountFullAccessaddSharedAccountSendAsaddSharedAccountSendOnBehalfTochangeHostnamechangePasswordclearDataOnDevicecloneTemplateExchangePrivateconfigureExchangeCustomerconfigureExchangeOwaMfacopyMailboxcreateExternalAntiSpamReceiveConnectordeleteAccountdeleteAccountArchivedeleteAccountImpersonationdeleteActiveSyncMailNotificationdeleteAliasdeleteDistributionGroupdeleteDistributionGroupManagerdeleteDistributionGroupMemberdeleteDistributionGroupSendAsdeleteDistributionGroupSendOnBehalfTodeleteDomaindeleteDomainDisclaimerdeleteExchangeCustomIsolationdeleteExchangeDomainDKIMdeleteExchangeRemoteMailboxdeleteExchangeServicedeleteExchangeServiceAuthorizedIpdeleteExportPstRequestdeleteExternalAntiSpamReceiveConnectordeleteExternalContactdeleteFullAccessdeleteOutlookLicensedeletePublicFolderdeletePublicFolderPermissiondeleteResourceAccountdeleteResourceDelegatedeleteSendAsdeleteSendConnectordeleteSendOnBehalfTodeleteSharedAccountdeleteSharedAccountFullAccessdeleteSharedAccountSendAsdeleteSharedAccountSendOnBehalfTodestroyPrivateVmdiagnoseAccountdisableExchangeDKIMenableExchangeDKIMexpandDrivegenerateOutlookUrlgeneratePstUrlinstallExchangeinstallSSLmaintenancemigrationAccountmigrationDisclaimermigrationExternalContactmigrationHistorymigrationMailingListmigrationResourceAccountmigrationServicereOpenHostedAccountreOpenOutlookLicensereOpenPrivateAccountreOpenPrivateVmsetAccountsetAccountArchivesetAliassetDistributionGroupsetDnssetDomainsetDomainDisclaimersetExchangeAccountProtocolsetExchangeRemoteMailboxsetExchangeServiceDevicesetExternalAntiSpamReceiveConnectorsetExternalContactsetPublicFoldersetPublicFolderPermissionsetResourceAccountsetSendConnectorsetServicesetSharedAccountsuspendAccountsuspendExchangeServicesuspendHostedAccountsuspendOutlookLicensesuspendPrivateAccountsuspendPrivateVmunsuspendAccountunsuspendExchangeServiceunsuspendHostedAccountupdateExchangeServiceDeviceupgrade2016id
read-only
integer
Task id
status
read-only
Task
Task status
Values
cancelleddoingdoneerrortodotodo
read-only
stringdate-time
Creation date
Example uses exchangeService = string, organizationName = string
$ curl https:/{ "finishDate": "2024-01-01T12:00:00Z", "function": "activateSharepoint", "id": 0, "status": "cancelled", "todoDate": "2024-01-01T12:00:00Z"}
Delete a groupProduction
DELETE
/1.0/
Delete a group. Deletes the group with its aliases and permissions, and returns the task. Its members keep their own accounts.
Path parameters
exchange
required
string
The internal name of your exchange service
mailing
required
string
The mailing list address
organization
required
string
The internal name of your exchange organization
Response
200Tasksuccessful operation
finish
read-only
stringdate-time
Completion date
function
read-only
Task
Function name
Values
activateSharepointaddAccountaddAccountArchiveaddAccountImpersonationaddActiveSyncMailNotificationaddAliasaddDistributionGroupaddDistributionGroupManageraddDistributionGroupMemberaddDistributionGroupSendAsaddDistributionGroupSendOnBehalfToaddDomainaddDomainDisclaimeraddExchangeCustomIsolationaddExchangeDomainDKIMaddExchangeRemoteMailboxaddExchangeServiceAuthorizedIpaddExportPstRequestaddExternalContactaddFullAccessaddOutlookLicenseaddPublicFolderaddPublicFolderPermissionaddResourceAccountaddResourceDelegateaddSendAsaddSendConnectoraddSendOnBehalfToaddSharedAccountaddSharedAccountFullAccessaddSharedAccountSendAsaddSharedAccountSendOnBehalfTochangeHostnamechangePasswordclearDataOnDevicecloneTemplateExchangePrivateconfigureExchangeCustomerconfigureExchangeOwaMfacopyMailboxcreateExternalAntiSpamReceiveConnectordeleteAccountdeleteAccountArchivedeleteAccountImpersonationdeleteActiveSyncMailNotificationdeleteAliasdeleteDistributionGroupdeleteDistributionGroupManagerdeleteDistributionGroupMemberdeleteDistributionGroupSendAsdeleteDistributionGroupSendOnBehalfTodeleteDomaindeleteDomainDisclaimerdeleteExchangeCustomIsolationdeleteExchangeDomainDKIMdeleteExchangeRemoteMailboxdeleteExchangeServicedeleteExchangeServiceAuthorizedIpdeleteExportPstRequestdeleteExternalAntiSpamReceiveConnectordeleteExternalContactdeleteFullAccessdeleteOutlookLicensedeletePublicFolderdeletePublicFolderPermissiondeleteResourceAccountdeleteResourceDelegatedeleteSendAsdeleteSendConnectordeleteSendOnBehalfTodeleteSharedAccountdeleteSharedAccountFullAccessdeleteSharedAccountSendAsdeleteSharedAccountSendOnBehalfTodestroyPrivateVmdiagnoseAccountdisableExchangeDKIMenableExchangeDKIMexpandDrivegenerateOutlookUrlgeneratePstUrlinstallExchangeinstallSSLmaintenancemigrationAccountmigrationDisclaimermigrationExternalContactmigrationHistorymigrationMailingListmigrationResourceAccountmigrationServicereOpenHostedAccountreOpenOutlookLicensereOpenPrivateAccountreOpenPrivateVmsetAccountsetAccountArchivesetAliassetDistributionGroupsetDnssetDomainsetDomainDisclaimersetExchangeAccountProtocolsetExchangeRemoteMailboxsetExchangeServiceDevicesetExternalAntiSpamReceiveConnectorsetExternalContactsetPublicFoldersetPublicFolderPermissionsetResourceAccountsetSendConnectorsetServicesetSharedAccountsuspendAccountsuspendExchangeServicesuspendHostedAccountsuspendOutlookLicensesuspendPrivateAccountsuspendPrivateVmunsuspendAccountunsuspendExchangeServiceunsuspendHostedAccountupdateExchangeServiceDeviceupgrade2016id
read-only
integer
Task id
status
read-only
Task
Task status
Values
cancelleddoingdoneerrortodotodo
read-only
stringdate-time
Creation date
Example uses exchangeService = string, mailingListAddress = string, organizationName = string
$ curl https:/{ "finishDate": "2024-01-01T12:00:00Z", "function": "activateSharepoint", "id": 0, "status": "cancelled", "todoDate": "2024-01-01T12:00:00Z"}
Update a groupProduction
PUT
/1.0/
Update a group. Updates the address, display name, join and depart restrictions, size limits, sender authentication and Global Address List visibility of the group.
Path parameters
exchange
required
string
The internal name of your exchange service
mailing
required
string
The mailing list address
organization
required
string
The internal name of your exchange organization
Request body (required)
company
string
Company name
creation
read-only
stringdate-time
Creation date
depart
Mailing
Depart restriction policy
Values
closedopendisplay
string
Name displayed in Global Access List
hidden
boolean
If true mailing list is hiddend in Global Address List
id
read-only
integer
Mailing list id
join
Mailing
Join restriction policy
Values
approvalRequiredclosedopenlast
read-only
stringdate-time
Update date
mailing
string
The mailing list address
max
integer
Maximum receive email size in MB
max
integer
Maximum send email size in MB
sender
boolean
If true sender has to authenticate
spam
read-only
boolean
Account was sending spam
spam
read-only
integer
Ticket number of spam detection
state
read-only
Object
Mailing list state
Values
creatingdeletinginternalMigrationokreopeningsuspendedsuspendingtask
read-only
integer
Task pending id
Response
200—successful operation
Example uses exchangeService = string, mailingListAddress = string, organizationName = string
$ curl https:/List group aliasesProduction
GET
/1.0/
List group aliases. Returns the aliases of the group: extra addresses that deliver to the members of the group.
Path parameters
exchange
required
string
The internal name of your exchange service
mailing
required
string
The mailing list address
organization
required
string
The internal name of your exchange organization
Response
200string
Example uses exchangeService = string, mailingListAddress = string, organizationName = string
$ curl https:/[ "string"]
Get a group aliasProduction
GET
/1.0/
Get a group alias. Returns the alias address, its creation date and the ID of its pending task, if any (taskPendingId).
Path parameters
alias
required
string
Alias
exchange
required
string
The internal name of your exchange service
mailing
required
string
The mailing list address
organization
required
string
The internal name of your exchange organization
Response
200exchange
alias
read-only
string
Alias
creation
read-only
stringdate-time
Creation date
task
read-only
integer
Pending task id
Example uses alias = string, exchangeService = string, mailingListAddress = string, organizationName = string
$ curl https:/{ "alias": "string", "creationDate": "2024-01-01T12:00:00Z", "taskPendingId": 0}
Create a group aliasProduction
POST
/1.0/
Create a group alias. Adds the alias address to the group, so that the emails sent to it reach the members, and returns the task.
Path parameters
exchange
required
string
The internal name of your exchange service
mailing
required
string
The mailing list address
organization
required
string
The internal name of your exchange organization
Request body (required)
alias
required
string
Alias
Response
200Tasksuccessful operation
finish
read-only
stringdate-time
Completion date
function
read-only
Task
Function name
Values
activateSharepointaddAccountaddAccountArchiveaddAccountImpersonationaddActiveSyncMailNotificationaddAliasaddDistributionGroupaddDistributionGroupManageraddDistributionGroupMemberaddDistributionGroupSendAsaddDistributionGroupSendOnBehalfToaddDomainaddDomainDisclaimeraddExchangeCustomIsolationaddExchangeDomainDKIMaddExchangeRemoteMailboxaddExchangeServiceAuthorizedIpaddExportPstRequestaddExternalContactaddFullAccessaddOutlookLicenseaddPublicFolderaddPublicFolderPermissionaddResourceAccountaddResourceDelegateaddSendAsaddSendConnectoraddSendOnBehalfToaddSharedAccountaddSharedAccountFullAccessaddSharedAccountSendAsaddSharedAccountSendOnBehalfTochangeHostnamechangePasswordclearDataOnDevicecloneTemplateExchangePrivateconfigureExchangeCustomerconfigureExchangeOwaMfacopyMailboxcreateExternalAntiSpamReceiveConnectordeleteAccountdeleteAccountArchivedeleteAccountImpersonationdeleteActiveSyncMailNotificationdeleteAliasdeleteDistributionGroupdeleteDistributionGroupManagerdeleteDistributionGroupMemberdeleteDistributionGroupSendAsdeleteDistributionGroupSendOnBehalfTodeleteDomaindeleteDomainDisclaimerdeleteExchangeCustomIsolationdeleteExchangeDomainDKIMdeleteExchangeRemoteMailboxdeleteExchangeServicedeleteExchangeServiceAuthorizedIpdeleteExportPstRequestdeleteExternalAntiSpamReceiveConnectordeleteExternalContactdeleteFullAccessdeleteOutlookLicensedeletePublicFolderdeletePublicFolderPermissiondeleteResourceAccountdeleteResourceDelegatedeleteSendAsdeleteSendConnectordeleteSendOnBehalfTodeleteSharedAccountdeleteSharedAccountFullAccessdeleteSharedAccountSendAsdeleteSharedAccountSendOnBehalfTodestroyPrivateVmdiagnoseAccountdisableExchangeDKIMenableExchangeDKIMexpandDrivegenerateOutlookUrlgeneratePstUrlinstallExchangeinstallSSLmaintenancemigrationAccountmigrationDisclaimermigrationExternalContactmigrationHistorymigrationMailingListmigrationResourceAccountmigrationServicereOpenHostedAccountreOpenOutlookLicensereOpenPrivateAccountreOpenPrivateVmsetAccountsetAccountArchivesetAliassetDistributionGroupsetDnssetDomainsetDomainDisclaimersetExchangeAccountProtocolsetExchangeRemoteMailboxsetExchangeServiceDevicesetExternalAntiSpamReceiveConnectorsetExternalContactsetPublicFoldersetPublicFolderPermissionsetResourceAccountsetSendConnectorsetServicesetSharedAccountsuspendAccountsuspendExchangeServicesuspendHostedAccountsuspendOutlookLicensesuspendPrivateAccountsuspendPrivateVmunsuspendAccountunsuspendExchangeServiceunsuspendHostedAccountupdateExchangeServiceDeviceupgrade2016id
read-only
integer
Task id
status
read-only
Task
Task status
Values
cancelleddoingdoneerrortodotodo
read-only
stringdate-time
Creation date
Example uses exchangeService = string, mailingListAddress = string, organizationName = string
$ curl https:/{ "finishDate": "2024-01-01T12:00:00Z", "function": "activateSharepoint", "id": 0, "status": "cancelled", "todoDate": "2024-01-01T12:00:00Z"}
Delete a group aliasProduction
DELETE
/1.0/
Delete a group alias. Removes the alias address from the group, whose members no longer receive its emails, and returns the task.
Path parameters
alias
required
string
Alias
exchange
required
string
The internal name of your exchange service
mailing
required
string
The mailing list address
organization
required
string
The internal name of your exchange organization
Response
200Tasksuccessful operation
finish
read-only
stringdate-time
Completion date
function
read-only
Task
Function name
Values
activateSharepointaddAccountaddAccountArchiveaddAccountImpersonationaddActiveSyncMailNotificationaddAliasaddDistributionGroupaddDistributionGroupManageraddDistributionGroupMemberaddDistributionGroupSendAsaddDistributionGroupSendOnBehalfToaddDomainaddDomainDisclaimeraddExchangeCustomIsolationaddExchangeDomainDKIMaddExchangeRemoteMailboxaddExchangeServiceAuthorizedIpaddExportPstRequestaddExternalContactaddFullAccessaddOutlookLicenseaddPublicFolderaddPublicFolderPermissionaddResourceAccountaddResourceDelegateaddSendAsaddSendConnectoraddSendOnBehalfToaddSharedAccountaddSharedAccountFullAccessaddSharedAccountSendAsaddSharedAccountSendOnBehalfTochangeHostnamechangePasswordclearDataOnDevicecloneTemplateExchangePrivateconfigureExchangeCustomerconfigureExchangeOwaMfacopyMailboxcreateExternalAntiSpamReceiveConnectordeleteAccountdeleteAccountArchivedeleteAccountImpersonationdeleteActiveSyncMailNotificationdeleteAliasdeleteDistributionGroupdeleteDistributionGroupManagerdeleteDistributionGroupMemberdeleteDistributionGroupSendAsdeleteDistributionGroupSendOnBehalfTodeleteDomaindeleteDomainDisclaimerdeleteExchangeCustomIsolationdeleteExchangeDomainDKIMdeleteExchangeRemoteMailboxdeleteExchangeServicedeleteExchangeServiceAuthorizedIpdeleteExportPstRequestdeleteExternalAntiSpamReceiveConnectordeleteExternalContactdeleteFullAccessdeleteOutlookLicensedeletePublicFolderdeletePublicFolderPermissiondeleteResourceAccountdeleteResourceDelegatedeleteSendAsdeleteSendConnectordeleteSendOnBehalfTodeleteSharedAccountdeleteSharedAccountFullAccessdeleteSharedAccountSendAsdeleteSharedAccountSendOnBehalfTodestroyPrivateVmdiagnoseAccountdisableExchangeDKIMenableExchangeDKIMexpandDrivegenerateOutlookUrlgeneratePstUrlinstallExchangeinstallSSLmaintenancemigrationAccountmigrationDisclaimermigrationExternalContactmigrationHistorymigrationMailingListmigrationResourceAccountmigrationServicereOpenHostedAccountreOpenOutlookLicensereOpenPrivateAccountreOpenPrivateVmsetAccountsetAccountArchivesetAliassetDistributionGroupsetDnssetDomainsetDomainDisclaimersetExchangeAccountProtocolsetExchangeRemoteMailboxsetExchangeServiceDevicesetExternalAntiSpamReceiveConnectorsetExternalContactsetPublicFoldersetPublicFolderPermissionsetResourceAccountsetSendConnectorsetServicesetSharedAccountsuspendAccountsuspendExchangeServicesuspendHostedAccountsuspendOutlookLicensesuspendPrivateAccountsuspendPrivateVmunsuspendAccountunsuspendExchangeServiceunsuspendHostedAccountupdateExchangeServiceDeviceupgrade2016id
read-only
integer
Task id
status
read-only
Task
Task status
Values
cancelleddoingdoneerrortodotodo
read-only
stringdate-time
Creation date
Example uses alias = string, exchangeService = string, mailingListAddress = string, organizationName = string
$ curl https:/{ "finishDate": "2024-01-01T12:00:00Z", "function": "activateSharepoint", "id": 0, "status": "cancelled", "todoDate": "2024-01-01T12:00:00Z"}
List group managersProduction
GET
/1.0/
List group managers. Returns the IDs of the email accounts that manage the group: they can change its members and settings.
Path parameters
exchange
required
string
The internal name of your exchange service
mailing
required
string
The mailing list address
organization
required
string
The internal name of your exchange organization
Response
200integer
Example uses exchangeService = string, mailingListAddress = string, organizationName = string
$ curl https:/[ 0]
Get a group managerProduction
GET
/1.0/
Get a group manager. Returns the ID and the email address of the account that manages the group, and the date it was added.
Path parameters
exchange
required
string
The internal name of your exchange service
mailing
required
string
The mailing list address
manager
required
integer
Manager account id
organization
required
string
The internal name of your exchange organization
Response
200exchange
creation
read-only
stringdate-time
Creation date
manager
read-only
integer
Manager account id
manager
read-only
string
Member account primaryEmailAddress
task
read-only
integer
Pending task id
Example uses exchangeService = string, mailingListAddress = string, managerAccountId = 0, organizationName = string
$ curl https:/{ "creationDate": "2024-01-01T12:00:00Z", "managerAccountId": 0, "managerEmailAddress": "string", "taskPendingId": 0}
Add a group managerProduction
POST
/1.0/
Add a group manager. Makes the email account given by managerAccountId a manager of the group, and returns the task.
Path parameters
exchange
required
string
The internal name of your exchange service
mailing
required
string
The mailing list address
organization
required
string
The internal name of your exchange organization
Request body (required)
manager
required
integer
Manager account id
Response
200Tasksuccessful operation
finish
read-only
stringdate-time
Completion date
function
read-only
Task
Function name
Values
activateSharepointaddAccountaddAccountArchiveaddAccountImpersonationaddActiveSyncMailNotificationaddAliasaddDistributionGroupaddDistributionGroupManageraddDistributionGroupMemberaddDistributionGroupSendAsaddDistributionGroupSendOnBehalfToaddDomainaddDomainDisclaimeraddExchangeCustomIsolationaddExchangeDomainDKIMaddExchangeRemoteMailboxaddExchangeServiceAuthorizedIpaddExportPstRequestaddExternalContactaddFullAccessaddOutlookLicenseaddPublicFolderaddPublicFolderPermissionaddResourceAccountaddResourceDelegateaddSendAsaddSendConnectoraddSendOnBehalfToaddSharedAccountaddSharedAccountFullAccessaddSharedAccountSendAsaddSharedAccountSendOnBehalfTochangeHostnamechangePasswordclearDataOnDevicecloneTemplateExchangePrivateconfigureExchangeCustomerconfigureExchangeOwaMfacopyMailboxcreateExternalAntiSpamReceiveConnectordeleteAccountdeleteAccountArchivedeleteAccountImpersonationdeleteActiveSyncMailNotificationdeleteAliasdeleteDistributionGroupdeleteDistributionGroupManagerdeleteDistributionGroupMemberdeleteDistributionGroupSendAsdeleteDistributionGroupSendOnBehalfTodeleteDomaindeleteDomainDisclaimerdeleteExchangeCustomIsolationdeleteExchangeDomainDKIMdeleteExchangeRemoteMailboxdeleteExchangeServicedeleteExchangeServiceAuthorizedIpdeleteExportPstRequestdeleteExternalAntiSpamReceiveConnectordeleteExternalContactdeleteFullAccessdeleteOutlookLicensedeletePublicFolderdeletePublicFolderPermissiondeleteResourceAccountdeleteResourceDelegatedeleteSendAsdeleteSendConnectordeleteSendOnBehalfTodeleteSharedAccountdeleteSharedAccountFullAccessdeleteSharedAccountSendAsdeleteSharedAccountSendOnBehalfTodestroyPrivateVmdiagnoseAccountdisableExchangeDKIMenableExchangeDKIMexpandDrivegenerateOutlookUrlgeneratePstUrlinstallExchangeinstallSSLmaintenancemigrationAccountmigrationDisclaimermigrationExternalContactmigrationHistorymigrationMailingListmigrationResourceAccountmigrationServicereOpenHostedAccountreOpenOutlookLicensereOpenPrivateAccountreOpenPrivateVmsetAccountsetAccountArchivesetAliassetDistributionGroupsetDnssetDomainsetDomainDisclaimersetExchangeAccountProtocolsetExchangeRemoteMailboxsetExchangeServiceDevicesetExternalAntiSpamReceiveConnectorsetExternalContactsetPublicFoldersetPublicFolderPermissionsetResourceAccountsetSendConnectorsetServicesetSharedAccountsuspendAccountsuspendExchangeServicesuspendHostedAccountsuspendOutlookLicensesuspendPrivateAccountsuspendPrivateVmunsuspendAccountunsuspendExchangeServiceunsuspendHostedAccountupdateExchangeServiceDeviceupgrade2016id
read-only
integer
Task id
status
read-only
Task
Task status
Values
cancelleddoingdoneerrortodotodo
read-only
stringdate-time
Creation date
Example uses exchangeService = string, mailingListAddress = string, organizationName = string
$ curl https:/{ "finishDate": "2024-01-01T12:00:00Z", "function": "activateSharepoint", "id": 0, "status": "cancelled", "todoDate": "2024-01-01T12:00:00Z"}
Remove a group managerProduction
DELETE
/1.0/
Remove a group manager. Withdraws from the email account the management of the group, and returns the task.
Path parameters
exchange
required
string
The internal name of your exchange service
mailing
required
string
The mailing list address
manager
required
integer
Manager account id
organization
required
string
The internal name of your exchange organization
Response
200Tasksuccessful operation
finish
read-only
stringdate-time
Completion date
function
read-only
Task
Function name
Values
activateSharepointaddAccountaddAccountArchiveaddAccountImpersonationaddActiveSyncMailNotificationaddAliasaddDistributionGroupaddDistributionGroupManageraddDistributionGroupMemberaddDistributionGroupSendAsaddDistributionGroupSendOnBehalfToaddDomainaddDomainDisclaimeraddExchangeCustomIsolationaddExchangeDomainDKIMaddExchangeRemoteMailboxaddExchangeServiceAuthorizedIpaddExportPstRequestaddExternalContactaddFullAccessaddOutlookLicenseaddPublicFolderaddPublicFolderPermissionaddResourceAccountaddResourceDelegateaddSendAsaddSendConnectoraddSendOnBehalfToaddSharedAccountaddSharedAccountFullAccessaddSharedAccountSendAsaddSharedAccountSendOnBehalfTochangeHostnamechangePasswordclearDataOnDevicecloneTemplateExchangePrivateconfigureExchangeCustomerconfigureExchangeOwaMfacopyMailboxcreateExternalAntiSpamReceiveConnectordeleteAccountdeleteAccountArchivedeleteAccountImpersonationdeleteActiveSyncMailNotificationdeleteAliasdeleteDistributionGroupdeleteDistributionGroupManagerdeleteDistributionGroupMemberdeleteDistributionGroupSendAsdeleteDistributionGroupSendOnBehalfTodeleteDomaindeleteDomainDisclaimerdeleteExchangeCustomIsolationdeleteExchangeDomainDKIMdeleteExchangeRemoteMailboxdeleteExchangeServicedeleteExchangeServiceAuthorizedIpdeleteExportPstRequestdeleteExternalAntiSpamReceiveConnectordeleteExternalContactdeleteFullAccessdeleteOutlookLicensedeletePublicFolderdeletePublicFolderPermissiondeleteResourceAccountdeleteResourceDelegatedeleteSendAsdeleteSendConnectordeleteSendOnBehalfTodeleteSharedAccountdeleteSharedAccountFullAccessdeleteSharedAccountSendAsdeleteSharedAccountSendOnBehalfTodestroyPrivateVmdiagnoseAccountdisableExchangeDKIMenableExchangeDKIMexpandDrivegenerateOutlookUrlgeneratePstUrlinstallExchangeinstallSSLmaintenancemigrationAccountmigrationDisclaimermigrationExternalContactmigrationHistorymigrationMailingListmigrationResourceAccountmigrationServicereOpenHostedAccountreOpenOutlookLicensereOpenPrivateAccountreOpenPrivateVmsetAccountsetAccountArchivesetAliassetDistributionGroupsetDnssetDomainsetDomainDisclaimersetExchangeAccountProtocolsetExchangeRemoteMailboxsetExchangeServiceDevicesetExternalAntiSpamReceiveConnectorsetExternalContactsetPublicFoldersetPublicFolderPermissionsetResourceAccountsetSendConnectorsetServicesetSharedAccountsuspendAccountsuspendExchangeServicesuspendHostedAccountsuspendOutlookLicensesuspendPrivateAccountsuspendPrivateVmunsuspendAccountunsuspendExchangeServiceunsuspendHostedAccountupdateExchangeServiceDeviceupgrade2016id
read-only
integer
Task id
status
read-only
Task
Task status
Values
cancelleddoingdoneerrortodotodo
read-only
stringdate-time
Creation date
Example uses exchangeService = string, mailingListAddress = string, managerAccountId = 0, organizationName = string
$ curl https:/{ "finishDate": "2024-01-01T12:00:00Z", "function": "activateSharepoint", "id": 0, "status": "cancelled", "todoDate": "2024-01-01T12:00:00Z"}
List account membersProduction
GET
/1.0/
List account members. Returns the IDs of the email accounts that are members of the group. External contacts are listed under member/contact.
Path parameters
exchange
required
string
The internal name of your exchange service
mailing
required
string
The mailing list address
organization
required
string
The internal name of your exchange organization
Response
200integer
Example uses exchangeService = string, mailingListAddress = string, organizationName = string
$ curl https:/[ 0]
Get a group memberProduction
GET
/1.0/
Get a group member. Returns the email address and the ID of the member (account, contact or group), and the date it was added.
Path parameters
exchange
required
string
The internal name of your exchange service
mailing
required
string
The mailing list address
member
required
integer
Member account id
organization
required
string
The internal name of your exchange organization
Response
200exchange
creation
read-only
stringdate-time
Creation date
member
read-only
integer
Member account id
member
read-only
integer
Member account id
member
read-only
string
Member account primaryEmailAddress
member
read-only
integer
Member mailing list id
task
read-only
integer
Pending task id
Example uses exchangeService = string, mailingListAddress = string, memberAccountId = 0, organizationName = string
$ curl https:/{ "creationDate": "2024-01-01T12:00:00Z", "memberAccountId": 0, "memberContactId": 0, "memberEmailAddress": "string", "memberMailingListId": 0, "taskPendingId": 0}
Add a group memberProduction
POST
/1.0/
Add a group member. Adds a member to the group and returns the task: an email account (memberAccountId) through member/account, an external contact (memberContactId) through member/contact, or a group (memberMailingListId) through member/mailingList.
Path parameters
exchange
required
string
The internal name of your exchange service
mailing
required
string
The mailing list address
organization
required
string
The internal name of your exchange organization
Request body (required)
member
integer
Member account id
member
integer
Member contact id
member
integer
Member mailing list id
Response
200Tasksuccessful operation
finish
read-only
stringdate-time
Completion date
function
read-only
Task
Function name
Values
activateSharepointaddAccountaddAccountArchiveaddAccountImpersonationaddActiveSyncMailNotificationaddAliasaddDistributionGroupaddDistributionGroupManageraddDistributionGroupMemberaddDistributionGroupSendAsaddDistributionGroupSendOnBehalfToaddDomainaddDomainDisclaimeraddExchangeCustomIsolationaddExchangeDomainDKIMaddExchangeRemoteMailboxaddExchangeServiceAuthorizedIpaddExportPstRequestaddExternalContactaddFullAccessaddOutlookLicenseaddPublicFolderaddPublicFolderPermissionaddResourceAccountaddResourceDelegateaddSendAsaddSendConnectoraddSendOnBehalfToaddSharedAccountaddSharedAccountFullAccessaddSharedAccountSendAsaddSharedAccountSendOnBehalfTochangeHostnamechangePasswordclearDataOnDevicecloneTemplateExchangePrivateconfigureExchangeCustomerconfigureExchangeOwaMfacopyMailboxcreateExternalAntiSpamReceiveConnectordeleteAccountdeleteAccountArchivedeleteAccountImpersonationdeleteActiveSyncMailNotificationdeleteAliasdeleteDistributionGroupdeleteDistributionGroupManagerdeleteDistributionGroupMemberdeleteDistributionGroupSendAsdeleteDistributionGroupSendOnBehalfTodeleteDomaindeleteDomainDisclaimerdeleteExchangeCustomIsolationdeleteExchangeDomainDKIMdeleteExchangeRemoteMailboxdeleteExchangeServicedeleteExchangeServiceAuthorizedIpdeleteExportPstRequestdeleteExternalAntiSpamReceiveConnectordeleteExternalContactdeleteFullAccessdeleteOutlookLicensedeletePublicFolderdeletePublicFolderPermissiondeleteResourceAccountdeleteResourceDelegatedeleteSendAsdeleteSendConnectordeleteSendOnBehalfTodeleteSharedAccountdeleteSharedAccountFullAccessdeleteSharedAccountSendAsdeleteSharedAccountSendOnBehalfTodestroyPrivateVmdiagnoseAccountdisableExchangeDKIMenableExchangeDKIMexpandDrivegenerateOutlookUrlgeneratePstUrlinstallExchangeinstallSSLmaintenancemigrationAccountmigrationDisclaimermigrationExternalContactmigrationHistorymigrationMailingListmigrationResourceAccountmigrationServicereOpenHostedAccountreOpenOutlookLicensereOpenPrivateAccountreOpenPrivateVmsetAccountsetAccountArchivesetAliassetDistributionGroupsetDnssetDomainsetDomainDisclaimersetExchangeAccountProtocolsetExchangeRemoteMailboxsetExchangeServiceDevicesetExternalAntiSpamReceiveConnectorsetExternalContactsetPublicFoldersetPublicFolderPermissionsetResourceAccountsetSendConnectorsetServicesetSharedAccountsuspendAccountsuspendExchangeServicesuspendHostedAccountsuspendOutlookLicensesuspendPrivateAccountsuspendPrivateVmunsuspendAccountunsuspendExchangeServiceunsuspendHostedAccountupdateExchangeServiceDeviceupgrade2016id
read-only
integer
Task id
status
read-only
Task
Task status
Values
cancelleddoingdoneerrortodotodo
read-only
stringdate-time
Creation date
Example uses exchangeService = string, mailingListAddress = string, organizationName = string
$ curl https:/{ "finishDate": "2024-01-01T12:00:00Z", "function": "activateSharepoint", "id": 0, "status": "cancelled", "todoDate": "2024-01-01T12:00:00Z"}
Remove a group memberProduction
DELETE
/1.0/
Remove a group member. Removes the account, contact or group from the members of the group, and returns the task.
Path parameters
exchange
required
string
The internal name of your exchange service
mailing
required
string
The mailing list address
member
required
integer
Member account id
organization
required
string
The internal name of your exchange organization
Response
200Tasksuccessful operation
finish
read-only
stringdate-time
Completion date
function
read-only
Task
Function name
Values
activateSharepointaddAccountaddAccountArchiveaddAccountImpersonationaddActiveSyncMailNotificationaddAliasaddDistributionGroupaddDistributionGroupManageraddDistributionGroupMemberaddDistributionGroupSendAsaddDistributionGroupSendOnBehalfToaddDomainaddDomainDisclaimeraddExchangeCustomIsolationaddExchangeDomainDKIMaddExchangeRemoteMailboxaddExchangeServiceAuthorizedIpaddExportPstRequestaddExternalContactaddFullAccessaddOutlookLicenseaddPublicFolderaddPublicFolderPermissionaddResourceAccountaddResourceDelegateaddSendAsaddSendConnectoraddSendOnBehalfToaddSharedAccountaddSharedAccountFullAccessaddSharedAccountSendAsaddSharedAccountSendOnBehalfTochangeHostnamechangePasswordclearDataOnDevicecloneTemplateExchangePrivateconfigureExchangeCustomerconfigureExchangeOwaMfacopyMailboxcreateExternalAntiSpamReceiveConnectordeleteAccountdeleteAccountArchivedeleteAccountImpersonationdeleteActiveSyncMailNotificationdeleteAliasdeleteDistributionGroupdeleteDistributionGroupManagerdeleteDistributionGroupMemberdeleteDistributionGroupSendAsdeleteDistributionGroupSendOnBehalfTodeleteDomaindeleteDomainDisclaimerdeleteExchangeCustomIsolationdeleteExchangeDomainDKIMdeleteExchangeRemoteMailboxdeleteExchangeServicedeleteExchangeServiceAuthorizedIpdeleteExportPstRequestdeleteExternalAntiSpamReceiveConnectordeleteExternalContactdeleteFullAccessdeleteOutlookLicensedeletePublicFolderdeletePublicFolderPermissiondeleteResourceAccountdeleteResourceDelegatedeleteSendAsdeleteSendConnectordeleteSendOnBehalfTodeleteSharedAccountdeleteSharedAccountFullAccessdeleteSharedAccountSendAsdeleteSharedAccountSendOnBehalfTodestroyPrivateVmdiagnoseAccountdisableExchangeDKIMenableExchangeDKIMexpandDrivegenerateOutlookUrlgeneratePstUrlinstallExchangeinstallSSLmaintenancemigrationAccountmigrationDisclaimermigrationExternalContactmigrationHistorymigrationMailingListmigrationResourceAccountmigrationServicereOpenHostedAccountreOpenOutlookLicensereOpenPrivateAccountreOpenPrivateVmsetAccountsetAccountArchivesetAliassetDistributionGroupsetDnssetDomainsetDomainDisclaimersetExchangeAccountProtocolsetExchangeRemoteMailboxsetExchangeServiceDevicesetExternalAntiSpamReceiveConnectorsetExternalContactsetPublicFoldersetPublicFolderPermissionsetResourceAccountsetSendConnectorsetServicesetSharedAccountsuspendAccountsuspendExchangeServicesuspendHostedAccountsuspendOutlookLicensesuspendPrivateAccountsuspendPrivateVmunsuspendAccountunsuspendExchangeServiceunsuspendHostedAccountupdateExchangeServiceDeviceupgrade2016id
read-only
integer
Task id
status
read-only
Task
Task status
Values
cancelleddoingdoneerrortodotodo
read-only
stringdate-time
Creation date
Example uses exchangeService = string, mailingListAddress = string, memberAccountId = 0, organizationName = string
$ curl https:/{ "finishDate": "2024-01-01T12:00:00Z", "function": "activateSharepoint", "id": 0, "status": "cancelled", "todoDate": "2024-01-01T12:00:00Z"}
List contact membersProduction
GET
/1.0/
List contact members. Returns the IDs of the external contacts that are members of the group. Email accounts are listed under member/account.
Path parameters
exchange
required
string
The internal name of your exchange service
mailing
required
string
The mailing list address
organization
required
string
The internal name of your exchange organization
Response
200integer
Example uses exchangeService = string, mailingListAddress = string, organizationName = string
$ curl https:/[ 0]
Get a group memberProduction
GET
/1.0/
Get a group member. Returns the email address and the ID of the member (account, contact or group), and the date it was added.
Path parameters
exchange
required
string
The internal name of your exchange service
mailing
required
string
The mailing list address
member
required
integer
Member account id
organization
required
string
The internal name of your exchange organization
Response
200exchange
creation
read-only
stringdate-time
Creation date
member
read-only
integer
Member account id
member
read-only
integer
Member account id
member
read-only
string
Member account primaryEmailAddress
member
read-only
integer
Member mailing list id
task
read-only
integer
Pending task id
Example uses exchangeService = string, mailingListAddress = string, memberContactId = 0, organizationName = string
$ curl https:/{ "creationDate": "2024-01-01T12:00:00Z", "memberAccountId": 0, "memberContactId": 0, "memberEmailAddress": "string", "memberMailingListId": 0, "taskPendingId": 0}
Add a group memberProduction
POST
/1.0/
Add a group member. Adds a member to the group and returns the task: an email account (memberAccountId) through member/account, an external contact (memberContactId) through member/contact, or a group (memberMailingListId) through member/mailingList.
Path parameters
exchange
required
string
The internal name of your exchange service
mailing
required
string
The mailing list address
organization
required
string
The internal name of your exchange organization
Request body (required)
member
integer
Member account id
member
integer
Member contact id
member
integer
Member mailing list id
Response
200Tasksuccessful operation
finish
read-only
stringdate-time
Completion date
function
read-only
Task
Function name
Values
activateSharepointaddAccountaddAccountArchiveaddAccountImpersonationaddActiveSyncMailNotificationaddAliasaddDistributionGroupaddDistributionGroupManageraddDistributionGroupMemberaddDistributionGroupSendAsaddDistributionGroupSendOnBehalfToaddDomainaddDomainDisclaimeraddExchangeCustomIsolationaddExchangeDomainDKIMaddExchangeRemoteMailboxaddExchangeServiceAuthorizedIpaddExportPstRequestaddExternalContactaddFullAccessaddOutlookLicenseaddPublicFolderaddPublicFolderPermissionaddResourceAccountaddResourceDelegateaddSendAsaddSendConnectoraddSendOnBehalfToaddSharedAccountaddSharedAccountFullAccessaddSharedAccountSendAsaddSharedAccountSendOnBehalfTochangeHostnamechangePasswordclearDataOnDevicecloneTemplateExchangePrivateconfigureExchangeCustomerconfigureExchangeOwaMfacopyMailboxcreateExternalAntiSpamReceiveConnectordeleteAccountdeleteAccountArchivedeleteAccountImpersonationdeleteActiveSyncMailNotificationdeleteAliasdeleteDistributionGroupdeleteDistributionGroupManagerdeleteDistributionGroupMemberdeleteDistributionGroupSendAsdeleteDistributionGroupSendOnBehalfTodeleteDomaindeleteDomainDisclaimerdeleteExchangeCustomIsolationdeleteExchangeDomainDKIMdeleteExchangeRemoteMailboxdeleteExchangeServicedeleteExchangeServiceAuthorizedIpdeleteExportPstRequestdeleteExternalAntiSpamReceiveConnectordeleteExternalContactdeleteFullAccessdeleteOutlookLicensedeletePublicFolderdeletePublicFolderPermissiondeleteResourceAccountdeleteResourceDelegatedeleteSendAsdeleteSendConnectordeleteSendOnBehalfTodeleteSharedAccountdeleteSharedAccountFullAccessdeleteSharedAccountSendAsdeleteSharedAccountSendOnBehalfTodestroyPrivateVmdiagnoseAccountdisableExchangeDKIMenableExchangeDKIMexpandDrivegenerateOutlookUrlgeneratePstUrlinstallExchangeinstallSSLmaintenancemigrationAccountmigrationDisclaimermigrationExternalContactmigrationHistorymigrationMailingListmigrationResourceAccountmigrationServicereOpenHostedAccountreOpenOutlookLicensereOpenPrivateAccountreOpenPrivateVmsetAccountsetAccountArchivesetAliassetDistributionGroupsetDnssetDomainsetDomainDisclaimersetExchangeAccountProtocolsetExchangeRemoteMailboxsetExchangeServiceDevicesetExternalAntiSpamReceiveConnectorsetExternalContactsetPublicFoldersetPublicFolderPermissionsetResourceAccountsetSendConnectorsetServicesetSharedAccountsuspendAccountsuspendExchangeServicesuspendHostedAccountsuspendOutlookLicensesuspendPrivateAccountsuspendPrivateVmunsuspendAccountunsuspendExchangeServiceunsuspendHostedAccountupdateExchangeServiceDeviceupgrade2016id
read-only
integer
Task id
status
read-only
Task
Task status
Values
cancelleddoingdoneerrortodotodo
read-only
stringdate-time
Creation date
Example uses exchangeService = string, mailingListAddress = string, organizationName = string
$ curl https:/{ "finishDate": "2024-01-01T12:00:00Z", "function": "activateSharepoint", "id": 0, "status": "cancelled", "todoDate": "2024-01-01T12:00:00Z"}
Remove a group memberProduction
DELETE
/1.0/
Remove a group member. Removes the account, contact or group from the members of the group, and returns the task.
Path parameters
exchange
required
string
The internal name of your exchange service
mailing
required
string
The mailing list address
member
required
integer
Member account id
organization
required
string
The internal name of your exchange organization
Response
200Tasksuccessful operation
finish
read-only
stringdate-time
Completion date
function
read-only
Task
Function name
Values
activateSharepointaddAccountaddAccountArchiveaddAccountImpersonationaddActiveSyncMailNotificationaddAliasaddDistributionGroupaddDistributionGroupManageraddDistributionGroupMemberaddDistributionGroupSendAsaddDistributionGroupSendOnBehalfToaddDomainaddDomainDisclaimeraddExchangeCustomIsolationaddExchangeDomainDKIMaddExchangeRemoteMailboxaddExchangeServiceAuthorizedIpaddExportPstRequestaddExternalContactaddFullAccessaddOutlookLicenseaddPublicFolderaddPublicFolderPermissionaddResourceAccountaddResourceDelegateaddSendAsaddSendConnectoraddSendOnBehalfToaddSharedAccountaddSharedAccountFullAccessaddSharedAccountSendAsaddSharedAccountSendOnBehalfTochangeHostnamechangePasswordclearDataOnDevicecloneTemplateExchangePrivateconfigureExchangeCustomerconfigureExchangeOwaMfacopyMailboxcreateExternalAntiSpamReceiveConnectordeleteAccountdeleteAccountArchivedeleteAccountImpersonationdeleteActiveSyncMailNotificationdeleteAliasdeleteDistributionGroupdeleteDistributionGroupManagerdeleteDistributionGroupMemberdeleteDistributionGroupSendAsdeleteDistributionGroupSendOnBehalfTodeleteDomaindeleteDomainDisclaimerdeleteExchangeCustomIsolationdeleteExchangeDomainDKIMdeleteExchangeRemoteMailboxdeleteExchangeServicedeleteExchangeServiceAuthorizedIpdeleteExportPstRequestdeleteExternalAntiSpamReceiveConnectordeleteExternalContactdeleteFullAccessdeleteOutlookLicensedeletePublicFolderdeletePublicFolderPermissiondeleteResourceAccountdeleteResourceDelegatedeleteSendAsdeleteSendConnectordeleteSendOnBehalfTodeleteSharedAccountdeleteSharedAccountFullAccessdeleteSharedAccountSendAsdeleteSharedAccountSendOnBehalfTodestroyPrivateVmdiagnoseAccountdisableExchangeDKIMenableExchangeDKIMexpandDrivegenerateOutlookUrlgeneratePstUrlinstallExchangeinstallSSLmaintenancemigrationAccountmigrationDisclaimermigrationExternalContactmigrationHistorymigrationMailingListmigrationResourceAccountmigrationServicereOpenHostedAccountreOpenOutlookLicensereOpenPrivateAccountreOpenPrivateVmsetAccountsetAccountArchivesetAliassetDistributionGroupsetDnssetDomainsetDomainDisclaimersetExchangeAccountProtocolsetExchangeRemoteMailboxsetExchangeServiceDevicesetExternalAntiSpamReceiveConnectorsetExternalContactsetPublicFoldersetPublicFolderPermissionsetResourceAccountsetSendConnectorsetServicesetSharedAccountsuspendAccountsuspendExchangeServicesuspendHostedAccountsuspendOutlookLicensesuspendPrivateAccountsuspendPrivateVmunsuspendAccountunsuspendExchangeServiceunsuspendHostedAccountupdateExchangeServiceDeviceupgrade2016id
read-only
integer
Task id
status
read-only
Task
Task status
Values
cancelleddoingdoneerrortodotodo
read-only
stringdate-time
Creation date
Example uses exchangeService = string, mailingListAddress = string, memberContactId = 0, organizationName = string
$ curl https:/{ "finishDate": "2024-01-01T12:00:00Z", "function": "activateSharepoint", "id": 0, "status": "cancelled", "todoDate": "2024-01-01T12:00:00Z"}
List group membersProduction
GET
/1.0/
List group members. Returns the IDs of the groups that are members of the group. Email accounts and external contacts are listed under member/account and member/contact.
Path parameters
exchange
required
string
The internal name of your exchange service
mailing
required
string
The mailing list address
organization
required
string
The internal name of your exchange organization
Response
200integer
Example uses exchangeService = string, mailingListAddress = string, organizationName = string
$ curl https:/[ 0]
Get a group memberProduction
GET
/1.0/
Get a group member. Returns the email address and the ID of the member (account, contact or group), and the date it was added.
Path parameters
exchange
required
string
The internal name of your exchange service
mailing
required
string
The mailing list address
member
required
integer
Member mailing list id
organization
required
string
The internal name of your exchange organization
Response
200exchange
creation
read-only
stringdate-time
Creation date
member
read-only
integer
Member account id
member
read-only
integer
Member account id
member
read-only
string
Member account primaryEmailAddress
member
read-only
integer
Member mailing list id
task
read-only
integer
Pending task id
Example uses exchangeService = string, mailingListAddress = string, memberMailingListId = 0, organizationName = string
$ curl https:/{ "creationDate": "2024-01-01T12:00:00Z", "memberAccountId": 0, "memberContactId": 0, "memberEmailAddress": "string", "memberMailingListId": 0, "taskPendingId": 0}
Add a group memberProduction
POST
/1.0/
Add a group member. Adds a member to the group and returns the task: an email account (memberAccountId) through member/account, an external contact (memberContactId) through member/contact, or a group (memberMailingListId) through member/mailingList.
Path parameters
exchange
required
string
The internal name of your exchange service
mailing
required
string
The mailing list address
organization
required
string
The internal name of your exchange organization
Request body (required)
member
integer
Member account id
member
integer
Member contact id
member
integer
Member mailing list id
Response
200Tasksuccessful operation
finish
read-only
stringdate-time
Completion date
function
read-only
Task
Function name
Values
activateSharepointaddAccountaddAccountArchiveaddAccountImpersonationaddActiveSyncMailNotificationaddAliasaddDistributionGroupaddDistributionGroupManageraddDistributionGroupMemberaddDistributionGroupSendAsaddDistributionGroupSendOnBehalfToaddDomainaddDomainDisclaimeraddExchangeCustomIsolationaddExchangeDomainDKIMaddExchangeRemoteMailboxaddExchangeServiceAuthorizedIpaddExportPstRequestaddExternalContactaddFullAccessaddOutlookLicenseaddPublicFolderaddPublicFolderPermissionaddResourceAccountaddResourceDelegateaddSendAsaddSendConnectoraddSendOnBehalfToaddSharedAccountaddSharedAccountFullAccessaddSharedAccountSendAsaddSharedAccountSendOnBehalfTochangeHostnamechangePasswordclearDataOnDevicecloneTemplateExchangePrivateconfigureExchangeCustomerconfigureExchangeOwaMfacopyMailboxcreateExternalAntiSpamReceiveConnectordeleteAccountdeleteAccountArchivedeleteAccountImpersonationdeleteActiveSyncMailNotificationdeleteAliasdeleteDistributionGroupdeleteDistributionGroupManagerdeleteDistributionGroupMemberdeleteDistributionGroupSendAsdeleteDistributionGroupSendOnBehalfTodeleteDomaindeleteDomainDisclaimerdeleteExchangeCustomIsolationdeleteExchangeDomainDKIMdeleteExchangeRemoteMailboxdeleteExchangeServicedeleteExchangeServiceAuthorizedIpdeleteExportPstRequestdeleteExternalAntiSpamReceiveConnectordeleteExternalContactdeleteFullAccessdeleteOutlookLicensedeletePublicFolderdeletePublicFolderPermissiondeleteResourceAccountdeleteResourceDelegatedeleteSendAsdeleteSendConnectordeleteSendOnBehalfTodeleteSharedAccountdeleteSharedAccountFullAccessdeleteSharedAccountSendAsdeleteSharedAccountSendOnBehalfTodestroyPrivateVmdiagnoseAccountdisableExchangeDKIMenableExchangeDKIMexpandDrivegenerateOutlookUrlgeneratePstUrlinstallExchangeinstallSSLmaintenancemigrationAccountmigrationDisclaimermigrationExternalContactmigrationHistorymigrationMailingListmigrationResourceAccountmigrationServicereOpenHostedAccountreOpenOutlookLicensereOpenPrivateAccountreOpenPrivateVmsetAccountsetAccountArchivesetAliassetDistributionGroupsetDnssetDomainsetDomainDisclaimersetExchangeAccountProtocolsetExchangeRemoteMailboxsetExchangeServiceDevicesetExternalAntiSpamReceiveConnectorsetExternalContactsetPublicFoldersetPublicFolderPermissionsetResourceAccountsetSendConnectorsetServicesetSharedAccountsuspendAccountsuspendExchangeServicesuspendHostedAccountsuspendOutlookLicensesuspendPrivateAccountsuspendPrivateVmunsuspendAccountunsuspendExchangeServiceunsuspendHostedAccountupdateExchangeServiceDeviceupgrade2016id
read-only
integer
Task id
status
read-only
Task
Task status
Values
cancelleddoingdoneerrortodotodo
read-only
stringdate-time
Creation date
Example uses exchangeService = string, mailingListAddress = string, organizationName = string
$ curl https:/{ "finishDate": "2024-01-01T12:00:00Z", "function": "activateSharepoint", "id": 0, "status": "cancelled", "todoDate": "2024-01-01T12:00:00Z"}
Remove a group memberProduction
DELETE
/1.0/
Remove a group member. Removes the account, contact or group from the members of the group, and returns the task.
Path parameters
exchange
required
string
The internal name of your exchange service
mailing
required
string
The mailing list address
member
required
integer
Member mailing list id
organization
required
string
The internal name of your exchange organization
Response
200Tasksuccessful operation
finish
read-only
stringdate-time
Completion date
function
read-only
Task
Function name
Values
activateSharepointaddAccountaddAccountArchiveaddAccountImpersonationaddActiveSyncMailNotificationaddAliasaddDistributionGroupaddDistributionGroupManageraddDistributionGroupMemberaddDistributionGroupSendAsaddDistributionGroupSendOnBehalfToaddDomainaddDomainDisclaimeraddExchangeCustomIsolationaddExchangeDomainDKIMaddExchangeRemoteMailboxaddExchangeServiceAuthorizedIpaddExportPstRequestaddExternalContactaddFullAccessaddOutlookLicenseaddPublicFolderaddPublicFolderPermissionaddResourceAccountaddResourceDelegateaddSendAsaddSendConnectoraddSendOnBehalfToaddSharedAccountaddSharedAccountFullAccessaddSharedAccountSendAsaddSharedAccountSendOnBehalfTochangeHostnamechangePasswordclearDataOnDevicecloneTemplateExchangePrivateconfigureExchangeCustomerconfigureExchangeOwaMfacopyMailboxcreateExternalAntiSpamReceiveConnectordeleteAccountdeleteAccountArchivedeleteAccountImpersonationdeleteActiveSyncMailNotificationdeleteAliasdeleteDistributionGroupdeleteDistributionGroupManagerdeleteDistributionGroupMemberdeleteDistributionGroupSendAsdeleteDistributionGroupSendOnBehalfTodeleteDomaindeleteDomainDisclaimerdeleteExchangeCustomIsolationdeleteExchangeDomainDKIMdeleteExchangeRemoteMailboxdeleteExchangeServicedeleteExchangeServiceAuthorizedIpdeleteExportPstRequestdeleteExternalAntiSpamReceiveConnectordeleteExternalContactdeleteFullAccessdeleteOutlookLicensedeletePublicFolderdeletePublicFolderPermissiondeleteResourceAccountdeleteResourceDelegatedeleteSendAsdeleteSendConnectordeleteSendOnBehalfTodeleteSharedAccountdeleteSharedAccountFullAccessdeleteSharedAccountSendAsdeleteSharedAccountSendOnBehalfTodestroyPrivateVmdiagnoseAccountdisableExchangeDKIMenableExchangeDKIMexpandDrivegenerateOutlookUrlgeneratePstUrlinstallExchangeinstallSSLmaintenancemigrationAccountmigrationDisclaimermigrationExternalContactmigrationHistorymigrationMailingListmigrationResourceAccountmigrationServicereOpenHostedAccountreOpenOutlookLicensereOpenPrivateAccountreOpenPrivateVmsetAccountsetAccountArchivesetAliassetDistributionGroupsetDnssetDomainsetDomainDisclaimersetExchangeAccountProtocolsetExchangeRemoteMailboxsetExchangeServiceDevicesetExternalAntiSpamReceiveConnectorsetExternalContactsetPublicFoldersetPublicFolderPermissionsetResourceAccountsetSendConnectorsetServicesetSharedAccountsuspendAccountsuspendExchangeServicesuspendHostedAccountsuspendOutlookLicensesuspendPrivateAccountsuspendPrivateVmunsuspendAccountunsuspendExchangeServiceunsuspendHostedAccountupdateExchangeServiceDeviceupgrade2016id
read-only
integer
Task id
status
read-only
Task
Task status
Values
cancelleddoingdoneerrortodotodo
read-only
stringdate-time
Creation date
Example uses exchangeService = string, mailingListAddress = string, memberMailingListId = 0, organizationName = string
$ curl https:/{ "finishDate": "2024-01-01T12:00:00Z", "function": "activateSharepoint", "id": 0, "status": "cancelled", "todoDate": "2024-01-01T12:00:00Z"}
List send as permissionsProduction
GET
/1.0/
List send as permissions. Returns the IDs of the accounts allowed to send emails as the group, from the group address.
Path parameters
exchange
required
string
The internal name of your exchange service
mailing
required
string
The mailing list address
organization
required
string
The internal name of your exchange organization
Response
200integer
Example uses exchangeService = string, mailingListAddress = string, organizationName = string
$ curl https:/[ 0]
Get a send as permissionProduction
GET
/1.0/
Get a send as permission. Returns the ID of the account allowed to send emails as this group, and the creation date of the right.
Path parameters
allowed
required
integer
Account id to give send on behalf to
exchange
required
string
The internal name of your exchange service
mailing
required
string
The mailing list address
organization
required
string
The internal name of your exchange organization
Response
200exchange
allowed
read-only
integer
Account id to give send on behalf to
creation
read-only
stringdate-time
Creation date
task
read-only
integer
Pending task id
Example uses allowedAccountId = 0, exchangeService = string, mailingListAddress = string, organizationName = string
$ curl https:/{ "allowedAccountId": 0, "creationDate": "2024-01-01T12:00:00Z", "taskPendingId": 0}
Add a send as permissionProduction
POST
/1.0/
Add a send as permission. Allows the account given by allowAccountId to send emails as the group, and returns the task.
Path parameters
exchange
required
string
The internal name of your exchange service
mailing
required
string
The mailing list address
organization
required
string
The internal name of your exchange organization
Request body (required)
allow
required
integer
Account id to allow to send as mails from this mailing list
Response
200Tasksuccessful operation
finish
read-only
stringdate-time
Completion date
function
read-only
Task
Function name
Values
activateSharepointaddAccountaddAccountArchiveaddAccountImpersonationaddActiveSyncMailNotificationaddAliasaddDistributionGroupaddDistributionGroupManageraddDistributionGroupMemberaddDistributionGroupSendAsaddDistributionGroupSendOnBehalfToaddDomainaddDomainDisclaimeraddExchangeCustomIsolationaddExchangeDomainDKIMaddExchangeRemoteMailboxaddExchangeServiceAuthorizedIpaddExportPstRequestaddExternalContactaddFullAccessaddOutlookLicenseaddPublicFolderaddPublicFolderPermissionaddResourceAccountaddResourceDelegateaddSendAsaddSendConnectoraddSendOnBehalfToaddSharedAccountaddSharedAccountFullAccessaddSharedAccountSendAsaddSharedAccountSendOnBehalfTochangeHostnamechangePasswordclearDataOnDevicecloneTemplateExchangePrivateconfigureExchangeCustomerconfigureExchangeOwaMfacopyMailboxcreateExternalAntiSpamReceiveConnectordeleteAccountdeleteAccountArchivedeleteAccountImpersonationdeleteActiveSyncMailNotificationdeleteAliasdeleteDistributionGroupdeleteDistributionGroupManagerdeleteDistributionGroupMemberdeleteDistributionGroupSendAsdeleteDistributionGroupSendOnBehalfTodeleteDomaindeleteDomainDisclaimerdeleteExchangeCustomIsolationdeleteExchangeDomainDKIMdeleteExchangeRemoteMailboxdeleteExchangeServicedeleteExchangeServiceAuthorizedIpdeleteExportPstRequestdeleteExternalAntiSpamReceiveConnectordeleteExternalContactdeleteFullAccessdeleteOutlookLicensedeletePublicFolderdeletePublicFolderPermissiondeleteResourceAccountdeleteResourceDelegatedeleteSendAsdeleteSendConnectordeleteSendOnBehalfTodeleteSharedAccountdeleteSharedAccountFullAccessdeleteSharedAccountSendAsdeleteSharedAccountSendOnBehalfTodestroyPrivateVmdiagnoseAccountdisableExchangeDKIMenableExchangeDKIMexpandDrivegenerateOutlookUrlgeneratePstUrlinstallExchangeinstallSSLmaintenancemigrationAccountmigrationDisclaimermigrationExternalContactmigrationHistorymigrationMailingListmigrationResourceAccountmigrationServicereOpenHostedAccountreOpenOutlookLicensereOpenPrivateAccountreOpenPrivateVmsetAccountsetAccountArchivesetAliassetDistributionGroupsetDnssetDomainsetDomainDisclaimersetExchangeAccountProtocolsetExchangeRemoteMailboxsetExchangeServiceDevicesetExternalAntiSpamReceiveConnectorsetExternalContactsetPublicFoldersetPublicFolderPermissionsetResourceAccountsetSendConnectorsetServicesetSharedAccountsuspendAccountsuspendExchangeServicesuspendHostedAccountsuspendOutlookLicensesuspendPrivateAccountsuspendPrivateVmunsuspendAccountunsuspendExchangeServiceunsuspendHostedAccountupdateExchangeServiceDeviceupgrade2016id
read-only
integer
Task id
status
read-only
Task
Task status
Values
cancelleddoingdoneerrortodotodo
read-only
stringdate-time
Creation date
Example uses exchangeService = string, mailingListAddress = string, organizationName = string
$ curl https:/{ "finishDate": "2024-01-01T12:00:00Z", "function": "activateSharepoint", "id": 0, "status": "cancelled", "todoDate": "2024-01-01T12:00:00Z"}
Remove a send as permissionProduction
DELETE
/1.0/
Remove a send as permission. Withdraws the right of the allowed account to send emails as this group, and returns the task.
Path parameters
allowed
required
integer
Account id to give send on behalf to
exchange
required
string
The internal name of your exchange service
mailing
required
string
The mailing list address
organization
required
string
The internal name of your exchange organization
Response
200Tasksuccessful operation
finish
read-only
stringdate-time
Completion date
function
read-only
Task
Function name
Values
activateSharepointaddAccountaddAccountArchiveaddAccountImpersonationaddActiveSyncMailNotificationaddAliasaddDistributionGroupaddDistributionGroupManageraddDistributionGroupMemberaddDistributionGroupSendAsaddDistributionGroupSendOnBehalfToaddDomainaddDomainDisclaimeraddExchangeCustomIsolationaddExchangeDomainDKIMaddExchangeRemoteMailboxaddExchangeServiceAuthorizedIpaddExportPstRequestaddExternalContactaddFullAccessaddOutlookLicenseaddPublicFolderaddPublicFolderPermissionaddResourceAccountaddResourceDelegateaddSendAsaddSendConnectoraddSendOnBehalfToaddSharedAccountaddSharedAccountFullAccessaddSharedAccountSendAsaddSharedAccountSendOnBehalfTochangeHostnamechangePasswordclearDataOnDevicecloneTemplateExchangePrivateconfigureExchangeCustomerconfigureExchangeOwaMfacopyMailboxcreateExternalAntiSpamReceiveConnectordeleteAccountdeleteAccountArchivedeleteAccountImpersonationdeleteActiveSyncMailNotificationdeleteAliasdeleteDistributionGroupdeleteDistributionGroupManagerdeleteDistributionGroupMemberdeleteDistributionGroupSendAsdeleteDistributionGroupSendOnBehalfTodeleteDomaindeleteDomainDisclaimerdeleteExchangeCustomIsolationdeleteExchangeDomainDKIMdeleteExchangeRemoteMailboxdeleteExchangeServicedeleteExchangeServiceAuthorizedIpdeleteExportPstRequestdeleteExternalAntiSpamReceiveConnectordeleteExternalContactdeleteFullAccessdeleteOutlookLicensedeletePublicFolderdeletePublicFolderPermissiondeleteResourceAccountdeleteResourceDelegatedeleteSendAsdeleteSendConnectordeleteSendOnBehalfTodeleteSharedAccountdeleteSharedAccountFullAccessdeleteSharedAccountSendAsdeleteSharedAccountSendOnBehalfTodestroyPrivateVmdiagnoseAccountdisableExchangeDKIMenableExchangeDKIMexpandDrivegenerateOutlookUrlgeneratePstUrlinstallExchangeinstallSSLmaintenancemigrationAccountmigrationDisclaimermigrationExternalContactmigrationHistorymigrationMailingListmigrationResourceAccountmigrationServicereOpenHostedAccountreOpenOutlookLicensereOpenPrivateAccountreOpenPrivateVmsetAccountsetAccountArchivesetAliassetDistributionGroupsetDnssetDomainsetDomainDisclaimersetExchangeAccountProtocolsetExchangeRemoteMailboxsetExchangeServiceDevicesetExternalAntiSpamReceiveConnectorsetExternalContactsetPublicFoldersetPublicFolderPermissionsetResourceAccountsetSendConnectorsetServicesetSharedAccountsuspendAccountsuspendExchangeServicesuspendHostedAccountsuspendOutlookLicensesuspendPrivateAccountsuspendPrivateVmunsuspendAccountunsuspendExchangeServiceunsuspendHostedAccountupdateExchangeServiceDeviceupgrade2016id
read-only
integer
Task id
status
read-only
Task
Task status
Values
cancelleddoingdoneerrortodotodo
read-only
stringdate-time
Creation date
Example uses allowedAccountId = 0, exchangeService = string, mailingListAddress = string, organizationName = string
$ curl https:/{ "finishDate": "2024-01-01T12:00:00Z", "function": "activateSharepoint", "id": 0, "status": "cancelled", "todoDate": "2024-01-01T12:00:00Z"}
List send on behalf permissionsProduction
GET
/1.0/
List send on behalf permissions. Returns the IDs of the accounts allowed to send emails on behalf of the group.
Path parameters
exchange
required
string
The internal name of your exchange service
mailing
required
string
The mailing list address
organization
required
string
The internal name of your exchange organization
Response
200integer
Example uses exchangeService = string, mailingListAddress = string, organizationName = string
$ curl https:/[ 0]
Get a send on behalf permissionProduction
GET
/1.0/
Get a send on behalf permission. Returns the ID of the account allowed to send emails on behalf of this group, and the creation date of the right.
Path parameters
allowed
required
integer
Account id to give send on behalf to
exchange
required
string
The internal name of your exchange service
mailing
required
string
The mailing list address
organization
required
string
The internal name of your exchange organization
Response
200exchange
allowed
read-only
integer
Account id to give send on behalf to
creation
read-only
stringdate-time
Creation date
task
read-only
integer
Pending task id
Example uses allowedAccountId = 0, exchangeService = string, mailingListAddress = string, organizationName = string
$ curl https:/{ "allowedAccountId": 0, "creationDate": "2024-01-01T12:00:00Z", "taskPendingId": 0}
Add a send on behalf permissionProduction
POST
/1.0/
Add a send on behalf permission. Allows the account given by allowAccountId to send emails on behalf of the group, and returns the task.
Path parameters
exchange
required
string
The internal name of your exchange service
mailing
required
string
The mailing list address
organization
required
string
The internal name of your exchange organization
Request body (required)
allow
required
integer
Account id to allow to send as mails from this mailing list
Response
200Tasksuccessful operation
finish
read-only
stringdate-time
Completion date
function
read-only
Task
Function name
Values
activateSharepointaddAccountaddAccountArchiveaddAccountImpersonationaddActiveSyncMailNotificationaddAliasaddDistributionGroupaddDistributionGroupManageraddDistributionGroupMemberaddDistributionGroupSendAsaddDistributionGroupSendOnBehalfToaddDomainaddDomainDisclaimeraddExchangeCustomIsolationaddExchangeDomainDKIMaddExchangeRemoteMailboxaddExchangeServiceAuthorizedIpaddExportPstRequestaddExternalContactaddFullAccessaddOutlookLicenseaddPublicFolderaddPublicFolderPermissionaddResourceAccountaddResourceDelegateaddSendAsaddSendConnectoraddSendOnBehalfToaddSharedAccountaddSharedAccountFullAccessaddSharedAccountSendAsaddSharedAccountSendOnBehalfTochangeHostnamechangePasswordclearDataOnDevicecloneTemplateExchangePrivateconfigureExchangeCustomerconfigureExchangeOwaMfacopyMailboxcreateExternalAntiSpamReceiveConnectordeleteAccountdeleteAccountArchivedeleteAccountImpersonationdeleteActiveSyncMailNotificationdeleteAliasdeleteDistributionGroupdeleteDistributionGroupManagerdeleteDistributionGroupMemberdeleteDistributionGroupSendAsdeleteDistributionGroupSendOnBehalfTodeleteDomaindeleteDomainDisclaimerdeleteExchangeCustomIsolationdeleteExchangeDomainDKIMdeleteExchangeRemoteMailboxdeleteExchangeServicedeleteExchangeServiceAuthorizedIpdeleteExportPstRequestdeleteExternalAntiSpamReceiveConnectordeleteExternalContactdeleteFullAccessdeleteOutlookLicensedeletePublicFolderdeletePublicFolderPermissiondeleteResourceAccountdeleteResourceDelegatedeleteSendAsdeleteSendConnectordeleteSendOnBehalfTodeleteSharedAccountdeleteSharedAccountFullAccessdeleteSharedAccountSendAsdeleteSharedAccountSendOnBehalfTodestroyPrivateVmdiagnoseAccountdisableExchangeDKIMenableExchangeDKIMexpandDrivegenerateOutlookUrlgeneratePstUrlinstallExchangeinstallSSLmaintenancemigrationAccountmigrationDisclaimermigrationExternalContactmigrationHistorymigrationMailingListmigrationResourceAccountmigrationServicereOpenHostedAccountreOpenOutlookLicensereOpenPrivateAccountreOpenPrivateVmsetAccountsetAccountArchivesetAliassetDistributionGroupsetDnssetDomainsetDomainDisclaimersetExchangeAccountProtocolsetExchangeRemoteMailboxsetExchangeServiceDevicesetExternalAntiSpamReceiveConnectorsetExternalContactsetPublicFoldersetPublicFolderPermissionsetResourceAccountsetSendConnectorsetServicesetSharedAccountsuspendAccountsuspendExchangeServicesuspendHostedAccountsuspendOutlookLicensesuspendPrivateAccountsuspendPrivateVmunsuspendAccountunsuspendExchangeServiceunsuspendHostedAccountupdateExchangeServiceDeviceupgrade2016id
read-only
integer
Task id
status
read-only
Task
Task status
Values
cancelleddoingdoneerrortodotodo
read-only
stringdate-time
Creation date
Example uses exchangeService = string, mailingListAddress = string, organizationName = string
$ curl https:/{ "finishDate": "2024-01-01T12:00:00Z", "function": "activateSharepoint", "id": 0, "status": "cancelled", "todoDate": "2024-01-01T12:00:00Z"}
Remove a send on behalf permissionProduction
DELETE
/1.0/
Remove a send on behalf permission. Withdraws the right of the allowed account to send emails on behalf of this group, and returns the task.
Path parameters
allowed
required
integer
Account id to give send on behalf to
exchange
required
string
The internal name of your exchange service
mailing
required
string
The mailing list address
organization
required
string
The internal name of your exchange organization
Response
200Tasksuccessful operation
finish
read-only
stringdate-time
Completion date
function
read-only
Task
Function name
Values
activateSharepointaddAccountaddAccountArchiveaddAccountImpersonationaddActiveSyncMailNotificationaddAliasaddDistributionGroupaddDistributionGroupManageraddDistributionGroupMemberaddDistributionGroupSendAsaddDistributionGroupSendOnBehalfToaddDomainaddDomainDisclaimeraddExchangeCustomIsolationaddExchangeDomainDKIMaddExchangeRemoteMailboxaddExchangeServiceAuthorizedIpaddExportPstRequestaddExternalContactaddFullAccessaddOutlookLicenseaddPublicFolderaddPublicFolderPermissionaddResourceAccountaddResourceDelegateaddSendAsaddSendConnectoraddSendOnBehalfToaddSharedAccountaddSharedAccountFullAccessaddSharedAccountSendAsaddSharedAccountSendOnBehalfTochangeHostnamechangePasswordclearDataOnDevicecloneTemplateExchangePrivateconfigureExchangeCustomerconfigureExchangeOwaMfacopyMailboxcreateExternalAntiSpamReceiveConnectordeleteAccountdeleteAccountArchivedeleteAccountImpersonationdeleteActiveSyncMailNotificationdeleteAliasdeleteDistributionGroupdeleteDistributionGroupManagerdeleteDistributionGroupMemberdeleteDistributionGroupSendAsdeleteDistributionGroupSendOnBehalfTodeleteDomaindeleteDomainDisclaimerdeleteExchangeCustomIsolationdeleteExchangeDomainDKIMdeleteExchangeRemoteMailboxdeleteExchangeServicedeleteExchangeServiceAuthorizedIpdeleteExportPstRequestdeleteExternalAntiSpamReceiveConnectordeleteExternalContactdeleteFullAccessdeleteOutlookLicensedeletePublicFolderdeletePublicFolderPermissiondeleteResourceAccountdeleteResourceDelegatedeleteSendAsdeleteSendConnectordeleteSendOnBehalfTodeleteSharedAccountdeleteSharedAccountFullAccessdeleteSharedAccountSendAsdeleteSharedAccountSendOnBehalfTodestroyPrivateVmdiagnoseAccountdisableExchangeDKIMenableExchangeDKIMexpandDrivegenerateOutlookUrlgeneratePstUrlinstallExchangeinstallSSLmaintenancemigrationAccountmigrationDisclaimermigrationExternalContactmigrationHistorymigrationMailingListmigrationResourceAccountmigrationServicereOpenHostedAccountreOpenOutlookLicensereOpenPrivateAccountreOpenPrivateVmsetAccountsetAccountArchivesetAliassetDistributionGroupsetDnssetDomainsetDomainDisclaimersetExchangeAccountProtocolsetExchangeRemoteMailboxsetExchangeServiceDevicesetExternalAntiSpamReceiveConnectorsetExternalContactsetPublicFoldersetPublicFolderPermissionsetResourceAccountsetSendConnectorsetServicesetSharedAccountsuspendAccountsuspendExchangeServicesuspendHostedAccountsuspendOutlookLicensesuspendPrivateAccountsuspendPrivateVmunsuspendAccountunsuspendExchangeServiceunsuspendHostedAccountupdateExchangeServiceDeviceupgrade2016id
read-only
integer
Task id
status
read-only
Task
Task status
Values
cancelleddoingdoneerrortodotodo
read-only
stringdate-time
Creation date
Example uses allowedAccountId = 0, exchangeService = string, mailingListAddress = string, organizationName = string
$ curl https:/{ "finishDate": "2024-01-01T12:00:00Z", "function": "activateSharepoint", "id": 0, "status": "cancelled", "todoDate": "2024-01-01T12:00:00Z"}