PATCH
/
entity-tags
/
{id}
Update an Entity tag
curl --request PATCH \
  --url https://api.syntage.com/entity-tags/{id} \
  --header 'Content-Type: application/merge-patch+json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "name": "Important Taxpayer"
}'
{
  "@id": "/entity-tags/91106968-1abd-4d64-85c1-4e73d96fb997",
  "@type": "EntityTag",
  "id": "e0a24894-7fbf-48ae-bfb0-efaae30a6319",
  "name": "Important Taxpayer",
  "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

​
id
string<uuid>
required

Body

application/merge-patch+json
​
name
string

The tag name

Example:

"Important Taxpayer"

Response

Entity tag resource response

​
@id
string<iri-reference>

Entity Tag IRI reference

Example:

"/entity-tags/91106968-1abd-4d64-85c1-4e73d96fb997"

​
@type
string
default:EntityTag
​
id
string<uuid>
Example:

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

​
name
string
Example:

"Important Taxpayer"

​
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"