The ability to update a person via this endpoint has been deprecated. If you need to update a person, please refer to the Update a Person endpoint.
This Example Project demonstrates how to consume an older version this API endpoint within a Java project.
This Example Project demonstrates how to consume an older version of this API endpoint within a C# project.
URI: https://api.onlinephotosubmission.com/api/people
HTTP Method: POST
Required Headers: X-Auth-Token (see: Authentication)
Optional URL Parameters:
sendInvitation=[true|false]
default istrue
IfsendInvitation
is false, cardholders will not receive an email invitation.If sendInvitation is true (or not specified)
, an email invitation will be sent to the cardholder.
Example HTTP Request Body - Email Only
{ "email": "jon.doe@foo.edu" }
Example HTTP Request Body - Using option "identifier" field to set ID Number
{ "email": "jon.doe@foo.edu", "identifier":"ABC123" }
Example HTTP Request Body - Set the user's custom fields
{ "email": "jon.doe@foo.edu", "identifier":"ABC123", "customFields":{ "Last_Name":"Card", "First Name":"Carry A", "Upload Date":"2017 - 06 - 22 11:17AM", "Batch":"1" } }