List Alternate Emails
Gets a list of the alternate emails for the specified user.
path Parameters
| userId required | number User Id |
header Parameters
| Authorization | string API Access Token used to authenticate requests to Smartsheet APIs. Example: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789 |
Responses
Request samples
- cURL
- C#
- Java
- Node.js
- Python
- Ruby
curl https://api.smartsheet.com/2.0/users/{userId}/alternateemails \ -H "Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789"
Response samples
- 200
- default
{- "pageNumber": 1,
- "pageSize": 50,
- "totalPages": 25,
- "totalCount": 136,
- "data": [
- {
- "id": 8150532427671428,
- "confirmed": true,
- "email": "johnathan.doe@smartsheet.com"
}
]
}Add Alternate Emails
Adds one or more alternate email addresses for the specified user.
This operation is only available to system administrators.
path Parameters
| userId required | number User Id |
header Parameters
| Authorization | string API Access Token used to authenticate requests to Smartsheet APIs. Example: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789 |
Request Body schema: application/json
string User's alternate email address. |
Responses
Request samples
- Payload
- cURL
- C#
- Java
- Node.js
- Python
- Ruby
[ ]Response samples
- 200
- default
{- "message": "SUCCESS",
- "resultCode": 0,
- "data": [
- {
- "id": 8150532427671428,
- "confirmed": true,
- "email": "johnathan.doe@smartsheet.com"
}
]
}Get Alternate Email
Gets the specified alternate email.
path Parameters
| userId required | number User Id |
| alternateEmailId required | number Alternate Email Id |
header Parameters
| Authorization | string API Access Token used to authenticate requests to Smartsheet APIs. Example: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789 |
Responses
Request samples
- cURL
- C#
- Java
- Node.js
- Python
- Ruby
curl https://api.smartsheet.com/2.0/users/{userId}/alternateemails/{alternateEmailId} \ -H "Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789"
Response samples
- 200
- default
{- "id": 8150532427671428,
- "confirmed": true,
- "email": "johnathan.doe@smartsheet.com"
}Delete Alternate Email
Deletes the specified alternate email address for the specified user.
path Parameters
| userId required | number User Id |
| alternateEmailId required | number Alternate Email Id |
header Parameters
| Authorization | string API Access Token used to authenticate requests to Smartsheet APIs. Example: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789 |
Responses
Request samples
- cURL
- C#
- Java
- Node.js
- Python
- Ruby
curl https://api.smartsheet.com/2.0/users/{userId}/alternateemails/{alternatEmailId} \ -H "Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789" \ -X DELETE
Response samples
- 200
- default
{- "message": "SUCCESS",
- "resultCode": 0
}Make Alternate Email Primary
Makes the specified alternate email address to become the primary email address for the specified user.
- This operation is only available to system administrators
The alternate email address can only be made primary if both conditions are met:
- The primary email address domain is validated
- The alternate email address is confirmed or the alternate email address domain is validated
path Parameters
| userId required | number User Id |
| alternateEmailId required | number Alternate Email Id |
header Parameters
| Authorization | string API Access Token used to authenticate requests to Smartsheet APIs. Example: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789 |
Responses
Request samples
- cURL
- C#
- Java
- Node.js
- Python
- Ruby
curl https://api.smartsheet.com/2.0/users/{userId}/alternateemails/{alternatEmailId}/makeprimary \ -H "Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789" \ -H "Content-Type: application/json" \ -X POST
Response samples
- 200
- default
{- "message": "SUCCESS",
- "resultCode": 0,
- "data": [
- {
- "id": 8150532427671428,
- "confirmed": true,
- "email": "johnathan.doe@smartsheet.com"
}
]
}