Foundry API

ChangeEmailAddressRequest

The following routes are available for this service:
PUT,PATCH	/profile/{Id}/email

import java.math.*
import java.util.*
import net.servicestack.client.*


open class ChangeEmailAddressRequest : PutPatchOperationUnTenanted<UpdateProfileResponse>()
{
    var id:String? = null
    var emailAddress:String? = null
}

open class PutPatchOperationUnTenanted<TResponse> : IPatch, IPut
{
}

open class UpdateProfileResponse
{
    var responseStatus:ResponseStatus? = null
    var profile:Profile? = null
}

open class Profile : ProfileBasic()
{
    var defaultOrganisationId:String? = null
}

open class ProfileBasic : IIdentifiableResource
{
    var name:PersonName? = null
    var displayName:String? = null
    var emailAddress:String? = null
    var phoneNumber:String? = null
    var timezone:String? = null
    var id:String? = null
}

open class PersonName
{
    var firstName:String? = null
    var lastName:String? = null
}

Kotlin 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"}}