Skip to content

Tags API

4 endpoints. Every path is relative to the API base URL and needs a bearer token unless it is marked public. See the REST API overview for authentication, errors and pagination.

GET/v1/orgs/{orgId}/marketing/tags

Bearer token

Path parameters

  • orgIdstring (uuid)required

Responses

200
  • dataarray<object>required
    Item fields
    • idstring (uuid)required
    • orgIdstring (uuid)required
    • namestringrequired
    • colorstring | nullrequired
    • createdAtstringrequired
    • updatedAtstringrequired
Request
curl -X GET "https://api.adventur.ai/v1/orgs/$ORG_ID/marketing/tags" \
-H "Authorization: Bearer $ADVENTURAI_TOKEN"

POST/v1/orgs/{orgId}/marketing/tags

Bearer token

Path parameters

  • orgIdstring (uuid)required

Request body application/json

  • namestringrequired
  • colorstring

Responses

200
  • dataobjectrequired
    Fields
    • idstring (uuid)required
    • orgIdstring (uuid)required
    • namestringrequired
    • colorstring | nullrequired
    • createdAtstringrequired
    • updatedAtstringrequired
Request
curl -X POST "https://api.adventur.ai/v1/orgs/$ORG_ID/marketing/tags" \
-H "Authorization: Bearer $ADVENTURAI_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"string"}'

PATCH/v1/orgs/{orgId}/marketing/tags/{tagId}

Bearer token

Path parameters

  • orgIdstring (uuid)required
  • tagIdstring (uuid)required

Request body application/json

  • namestring
  • colorstring

Responses

200
  • dataobjectrequired
    Fields
    • idstring (uuid)required
    • orgIdstring (uuid)required
    • namestringrequired
    • colorstring | nullrequired
    • createdAtstringrequired
    • updatedAtstringrequired
Request
curl -X PATCH "https://api.adventur.ai/v1/orgs/$ORG_ID/marketing/tags/$TAG_ID" \
-H "Authorization: Bearer $ADVENTURAI_TOKEN" \
-H "Content-Type: application/json" \
-d '{}'

DELETE/v1/orgs/{orgId}/marketing/tags/{tagId}

Bearer token

Path parameters

  • orgIdstring (uuid)required
  • tagIdstring (uuid)required

Responses

200
  • dataobjectrequired
    Fields
    • idstring (uuid)required
    • orgIdstring (uuid)required
    • namestringrequired
    • colorstring | nullrequired
    • createdAtstringrequired
    • updatedAtstringrequired
Request
curl -X DELETE "https://api.adventur.ai/v1/orgs/$ORG_ID/marketing/tags/$TAG_ID" \
-H "Authorization: Bearer $ADVENTURAI_TOKEN"