Foundry API

<back to all web services

ChangeEmailAddressRequest

Requires Authentication
The following routes are available for this service:
PUT,PATCH/profile/{Id}/email
namespace Application.Interfaces.Resources

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type PersonName() = 
        member val FirstName:String = null with get,set
        member val LastName:String = null with get,set

    [<AllowNullLiteral>]
    type ProfileBasic() = 
        member val Name:PersonName = null with get,set
        member val DisplayName:String = null with get,set
        member val EmailAddress:String = null with get,set
        member val PhoneNumber:String = null with get,set
        member val Timezone:String = null with get,set
        member val Id:String = null with get,set

    [<AllowNullLiteral>]
    type Profile() = 
        inherit ProfileBasic()
        member val DefaultOrganisationId:String = null with get,set

    [<AllowNullLiteral>]
    type UpdateProfileResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Profile:Profile = null with get,set

    [<AllowNullLiteral>]
    type ChangeEmailAddressRequest() = 
        inherit PutPatchOperationUnTenanted<UpdateProfileResponse>()
        member val Id:String = null with get,set
        member val EmailAddress:String = null with get,set

    [<AllowNullLiteral>]
    type PutPatchOperationUnTenanted<'TResponse>() = 
        interface IPatch
        interface IPut

F# ChangeEmailAddressRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /profile/{Id}/email HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"id":"String","emailAddress":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"profile":{"defaultOrganisationId":"String","name":{"firstName":"String","lastName":"String"},"displayName":"String","emailAddress":"String","phoneNumber":"String","timezone":"String","id":"String"}}