Users > User email preferences Mailhub

Get preferences

get
/mailhub/users/{userId}/preferences
chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
userIdstringRequired
Responses
chevron-right
200

Successful response

application/json
get
/mailhub/users/{userId}/preferences
200

Successful response

Update global preferences

patch
/mailhub/users/{userId}/preferences
chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
userIdstringRequired
Body
idstringOptional
enabledbooleanOptional
Responses
chevron-right
200

Successful response

application/json
patch
/mailhub/users/{userId}/preferences
200

Successful response

Get team preferences

get
/mailhub/users/{userId}/organizations/{organizationId}/teams/{teamId}/preferences
chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
userIdstringRequired
organizationIdstringRequired
teamIdstringRequired
Responses
chevron-right
200

Successful response

application/json
get
/mailhub/users/{userId}/organizations/{organizationId}/teams/{teamId}/preferences
200

Successful response

Update team preferences

patch
/mailhub/users/{userId}/organizations/{organizationId}/teams/{teamId}/preferences
chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
userIdstringRequired
organizationIdstringRequired
teamIdstringRequired
Body
idstringOptional
enabledbooleanOptional
Responses
chevron-right
200

Successful response

application/json
patch
/mailhub/users/{userId}/organizations/{organizationId}/teams/{teamId}/preferences
200

Successful response

Update team native preferences

patch
/mailhub/users/{userId}/organizations/{organizationId}/teams/{teamId}/native-preferences
chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
userIdstringRequired
organizationIdstringRequired
teamIdstringRequired
Body
idstring · utc-millisecOptional
enabledbooleanOptional
Responses
chevron-right
200

Successful response

application/json
patch
/mailhub/users/{userId}/organizations/{organizationId}/teams/{teamId}/native-preferences
200

Successful response

Last updated