Skip to main content
POST
/
tags
Create a tag
curl --request POST \
  --url https://api.syntage.com/tags \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "To be reviewed",
  "resourceType": "invoice"
}
'
{
  "@id": "/tags/91106968-1abd-4d64-85c1-4e73d96fb997",
  "@type": "Tag",
  "id": "e0a24894-7fbf-48ae-bfb0-efaae30a6319",
  "name": "To be reviewed",
  "resourceType": "invoice",
  "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.

Body

application/json
​
name
string
required
write-only

Tag name

Example:

"To be reviewed"

​
resourceType
string
required
write-only

Resource type this tag can be applied to

Example:

"invoice"

Response

Tag resource response

​
@id
string<iri-reference>

Resource tag IRI reference

Example:

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

​
@type
string
default:Tag

JSON-LD resource type

​
id
string<uuid>
Example:

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

​
name
string

Display name for the tag

Example:

"To be reviewed"

​
resourceType
string

Resource type this tag can be applied to

Example:

"invoice"

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