Save Entity | Sayari

Save an entity to a project.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Request

This endpoint expects an object.

typeenumRequired

Allowed values:

projectstringRequired

The project identifier.

entity_idstringRequired

The entity identifier.

custom_fieldsanyRequired

This property is in beta and is subject to change. It is provided for early access and testing purposes only.

custom user key/value pairs (key must be prefixed with “custom_” and value must be “string” type)

<Warning>This property is in beta and is subject to change. It is provided for early access and testing purposes only.</Warning> custom user key/value pairs (key must be prefixed with "custom_" and value must be "string" type)

Response

This endpoint returns an object.

dataobject

Errors

400

Bad Request

401

Unauthorized

404

Not Found

405

Method Not Allowed

429

Rate Limit Exceeded

500

Internal Server Error

1	curl -X POST https://api.sayari.com/v1/resource/entity \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"type": "entity",
6	"project": "GNJbkG",
7	"entity_id": "Zk0qOaM2SSYg_ZhsljykMQ",
8	"custom_fields": {
9	"properties": {
10	"custom_name": "Victoria Beckham"
11	}
12	}
13	}'

1	{
2	"data": {
3	"type": "entity",
4	"id": "Ywk6qw",
5	"project": "GNJbkG",
6	"label": "HOME DEPOT, U. S. A., INC.",
7	"created": "2024-03-12 16:12:38.528362+00",
8	"updated": "2024-03-12 16:12:38.528362+00",
9	"updated_by": "auth0\|5e45bd8caccd890e68147513",
10	"version": 0,
11	"entity_id": "n9SA4T_33tDmLtS8BhC6Zg",
12	"tag_ids": [],
13	"case_status": "not_assigned"
14	}
15	}