Skip to main content
PATCH
/
entities
/
{entityId}
Update an Entity
curl --request PATCH \
  --url https://api.syntage.com/entities/{entityId} \
  --header 'Content-Type: application/merge-patch+json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "tags": [
    "/entity-tags/91106968-1abd-4d64-85c1-4e73d96fb997"
  ],
  "name": "Syntage"
}
'
{
  "@context": "/contexts/Entity",
  "@id": "/entities/91106968-1abd-4d64-85c1-4e73d96fb997",
  "@type": "Link",
  "id": "e0a24894-7fbf-48ae-bfb0-efaae30a6319",
  "type": "company",
  "taxpayer": {
    "@id": "/taxpayers/PEIC211118IS0",
    "@type": "Taxpayer",
    "id": "PEIC211118IS0",
    "personType": "physical",
    "registrationDate": "2023-12-25",
    "name": "Pedro Infante Cruz"
  },
  "credential": {
    "@id": "/credentials/91106968-1abd-4d64-85c1-4e73d96fb997",
    "@type": "Credential",
    "id": "91106968-1abd-4d64-85c1-4e73d96fb997",
    "type": "ciec",
    "rfc": "PEIC211118IS0",
    "status": "pending",
    "createdAt": "2020-01-01T12:15:00.000Z",
    "updatedAt": "2020-01-01T12:15:00.000Z"
  },
  "tags": [
    {
      "@id": "/entity-tags/91106968-1abd-4d64-85c1-4e73d96fb997",
      "@type": "EntityTag",
      "id": "e0a24894-7fbf-48ae-bfb0-efaae30a6319",
      "name": "Priority Entity",
      "createdAt": "2020-01-01T12:15:00.000Z",
      "updatedAt": "2020-01-01T12:15:00.000Z"
    }
  ],
  "createdAt": "2020-01-01T12:15:00.000Z",
  "updatedAt": "2020-01-01T12:15:00.000Z"
}

Authorizations

​
X-API-Key
string
header
required

Your API key is available in the Production and Sandbox dashboards.

Path Parameters

​
entityId
string<uuid>
required

Body

application/merge-patch+json
​
tags
string<iri-reference>[]
write-only

Tags to associate with the entity; sending this key replaces the existing tag collection

Example:
[
  "/entity-tags/91106968-1abd-4d64-85c1-4e73d96fb997"
]
​
name
string
write-only

Entity name

Example:

"Syntage"

Response

Entity resource response

​
@context
string
default:/contexts/Entity
​
@id
string<iri-reference>

Entity IRI reference

Example:

"/entities/91106968-1abd-4d64-85c1-4e73d96fb997"

​
@type
string
default:Link

JSON-LD resource type; Entity resources currently use the legacy Link JSON-LD type for backwards compatibility

​
id
string<uuid>
Example:

"e0a24894-7fbf-48ae-bfb0-efaae30a6319"

​
type
enum<string>

Type of entity

Available options:
company,
person
Example:

"company"

​
taxpayer
object
​
credential
object
​
tags
object[]
​
createdAt
string

Date and time the resource was created

Example:

"2020-01-01T12:15:00.000Z"

​
updatedAt
string

Date and time the resource was last updated

Example:

"2020-01-01T12:15:00.000Z"