POST
/:site_number/individuals/:individual_id/email /:email_id
Creates a change request to add, edit or delete an individual's e-mail address.
Example
Required Permissions
The user must fall into one of the categories below:
System Administration
A user with the following rights:
Ability to create a change request
- Ability to locate a person or search for a member
Request Header
Basic Authorization is used to determine security rights for the user credentials supplied using the following parameters.
u sername : "jadams"
password : "password231"
URL Parameters
Site_number – Site number to gather data for.
Individual_ID – Individual associated with the record. Values from Individual Search API.
Email_ID – The specific email address for this individual to be edited or deleted. Value from Individual Details API. (Not used for Add Change Request)
JSON Body Text
EmailType: ["2"] Values from Email Types API
EmailAddress: [johndoe@example.com]
Listed: ["Y" | "N"] Viewable by Non-Staff members?
Preferred: ["Y" | "N"] Make this the preferred e-mail
Delete: ["N"] Only used when Deleting the Email Address. By default, the value is "Y".
Return Data
HTTP 200 OK
POST | /:site_number/individuals/:individual_id/email /:email_id |
|---|
Creates a change request to add, edit or delete an individual's e-mail address.
Example
Required Permissions
The user must fall into one of the categories below:
System Administration
A user with the following rights:
Ability to create a change request
- Ability to locate a person or search for a member
Request Header
Basic Authorization is used to determine security rights for the user credentials supplied using the following parameters.
u sername : "jadams"
password : "password231"
URL Parameters
Site_number – Site number to gather data for.
Individual_ID – Individual associated with the record. Values from Individual Search API.
Email_ID – The specific email address for this individual to be edited or deleted. Value from Individual Details API. (Not used for Add Change Request)
JSON Body Text
EmailType: ["2"] Values from Email Types API EmailAddress: [johndoe@example.com] Listed: ["Y" | "N"] Viewable by Non-Staff members? Preferred: ["Y" | "N"] Make this the preferred e-mail Delete: ["N"] Only used when Deleting the Email Address. By default, the value is "Y".
Return Data
HTTP 200 OK
Related Topics
Overview
Content Tools
