Capture API: /entity.create | Janrain Developers

/entity.create

Create a new data record for an entityType. Once created, Capture returns the new id, and uuid for the entry.

Formatting the Attributes parameter

The following is an example of a valid attributes value:

{"name":"Fred","Description":"Test User"}

URL

`https://{yourdomain}.com/entity.create`

Request

Parameter	Required	Description
`client_id` `string`	Yes	The client identifier, which you can find in the dashboard.
`client_secret` `string`	Yes	The shared secret paired with the `client_id`. Also in the dashboard.
`type_name` `string`	No	The `entityType` of the `entity`. Required when authenticating with client settings.
`attributes` `string`	Yes	The attribute names and values (as JSON) for the `entity`. You do not need to include all attribute values. A new data record will be created with the data included.
`include_record` `string`	No	Values are `true` or `false`. When `true`, a `result` field is added to the response containing the data of the newly created `entity` record.

Example Response

https://yourdomain.com/entity.create?type_name=user&attributes={"firstName":"Bob","lastName":"Smith"}&client_id=12345678912345678912345678912345&client_secret=98765432198765432198765432198765

Create a new instance of entityType 'user,' with attributes id, created, lastUpdated, firstName, and lastName.

JSON

{
   "id":336,
   "uuid":"12345678-1234-1234-4321-123456789123",
   "stat":"ok"
}

Note: This API call requires a Capture Premium service level.

API Information

Service Level:
- Capture Premium
HTTP Method:
- POST
Response Formats:
- JSON