Foundry API

<back to all web services

UpdateProfileRequest

Requires Authentication
The following routes are available for this service:
PUT,PATCH/profile/{Id}
UpdateProfileRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathstringNo
FirstNamebodystringNo
LastNamebodystringNo
DisplayNamebodystringNo
PhoneNumberbodystringNo
TimezonebodystringNo
UpdateProfileResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ProfileformProfileNo
Profile Parameters:
NameParameterData TypeRequiredDescription
DefaultOrganisationIdformstringNo
ProfileBasic Parameters:
NameParameterData TypeRequiredDescription
NameformPersonNameNo
DisplayNameformstringNo
EmailAddressformstringNo
PhoneNumberformstringNo
TimezoneformstringNo
IdformstringNo
PersonName Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringNo
LastNameformstringNo
UpdateProfileResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ProfileformProfileNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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

{"id":"String","firstName":"String","lastName":"String","displayName":"String","phoneNumber":"String","timezone":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}