/entity.create

Create a new data record for an entityType. Once created, the new id and uuid values are returned.

Refer to the Registration Error Codes section for details on error codes.

This endpoint uses the following methods:

  • POST


POST

Authentication

This endpoint supports both Basic authentication (recommended) and janrain-signed authentication.

How to Create an Authentication String

Base URL

The base URL for this endpoint is your Janrain Capture domain; for example:

https://educationcenter.us-dev.janraincapture.com

Your Capture domains (also known as Registration domains) can be found in the Janrain Console on the Manage Application page:

Examples

Example Request

Create a new instance of entityType named user with the attributes givenName, familyName, email and a plural statuses. The attributes id, uuid, created and lastUpdated are system generated.


curl -X POST \
    -H "Authorization: Basic aW1fYV...NfbXk="\
    --data-urlencode type_name=user\
    --data-urlencodeattributes='{"givenName":"Matt","familyName":"Parker",
      "email":"parkerm@example.com","statuses":[{"status":"active",
      "statusCreated":"2015-12-15T07:36:25Z"}]}' \
      https://my-app.janraincapture.com/entity.create
   
      Running this command in Postman

Example Response


{
  "id": 11649,
  "uuid": "02b0c68d-7d7a-49d8-a88d-022585b0f877",
  "stat": "ok"
}
   

Example Error Response


{
  "argument_name": "attributes",
  "request_id": "geup8cd3gvcvjjnc",
  "code": 200,
  "error_description": "attributes was not valid for the following
    reason: the JSON isnot syntactically valid",
  "error": "invalid_argument",
  "stat": "error"
}
   

Authorized Clients

  • owner 
  • direct_access

Query Parameters

Parameter Type Required Description
attributes string Yes Attribute names and values (formatted as a JSON object) for the entity. Note that you do not need to include all the possible user profile attributes: the new record will be created using whatever attributes and attribute values you supply.
 
include_record string When set to true, the API response includes all the attributes and attribute values assigned to the new record. 
 
type_name string entityType of the entity. Required if you are authenticating with client settings.