Edit Person

Allows a person registered in the Organization module to be edited.

 

URL

{RMUrl}/api/Organization/people/<PersonID>

 

REQUEST METHOD

PUT

 

URL PARAMETER

PersonID: This parameter is provided in the URL and does not need to be sent through PUT.

 

FORM CONTENT

Name (Optional): Name of the person being edited. Limit of 400 characters.

Description (Optional): Description of the person being edited.

Email (Required): E-mail address of the person being edited.

Phone (Optional): Phone number of the person being edited.

AdditionalInformation (Optional): Additional information on the person being edited.

CustomAttributes (Optional): List of objects with information on the attributes associated with the person. Each attribute is referenced by its variable name. Relationship-type attributes can be referenced by the Id field, the Caption field, or both. If both fields are provided, they must refer to the same object. It is recommended to use the Id field whenever possible. See Appendix 2: Format for Completing Attributes for the list of formats for the Id and Caption fields.

 

Note: Sending the value "null" in the CustomAttributes fields means that the values entered will be erased. In the other fields, "null" means that the values will be ignored.

 

REQUEST EXAMPLE

{RMUrl}/api/Organization/people/6fe49ce4-56d4-475f-9483-1adca6b2976c

 

FORM CONTENT EXAMPLE

{

"Name":"Joseph Parks",

"Description":"Employee – Marketing department",

"Email":"jparks@example.com",

"Phone":"+1 (646) 555-0000",

"AdditionalInformation":"Marketing manager"

}

 

SUCCESS RESPONSE

HTTP status code 204: NoContent