Create a Tag

1 min

POST

https://developer.digitail.io/api/v1/tags

Permissions needed: NONE Create a new Tag record

Body Parameters

bodyobjectrequired
- entity_typestring<pet | user>
  Example
  pet
  Description
  Tag type (on what entities it can be used)
  Allowed
  petuser
- clinic_idinteger
  Example
  766
  Description
  Clinic Id.
- color_levelstring
  Example
  #FF0000
  Description
  Tag Color (any hex color, ex:#FF0000)
- valuestring
  Example
  Happy
  Description
  Tag value

Responses

201successful operation

object
- dataobject
  Description
  Tags are purely informative and can be used to categorize pets or petParents in the system.
  - idinteger
    Example
    1
  - entity_typestring<App\\Models\\Pet | App\\Models\\User>
    Example
    App\\Models\\Pet
    Allowed
    App\\Models\\PetApp\\Models\\User
  - clinic_idinteger
    Example
    766
  - color_levelstring
    Example
    #FF0000
  - valuestring
    Example
    Happy
  - created_atstring<date-time>
    Example
    2021-10-05T12:52:53.000000Z
    Format
    date-time
  - deleted_atstring<date-time>
    Format
    date-time

curl

curl --request POST \
     --url https://developer.digitail.io/api/v1/tags \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://developer.digitail.io/api/v1/tags", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://developer.digitail.io/api/v1/tags")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://developer.digitail.io/api/v1/tags"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

201

// successful operation
{
  "data": {
    "id": 1,
    "entity_type": "App\\\\Models\\\\Pet",
    "clinic_id": 766,
    "color_level": "#FF0000",
    "value": "Happy",
    "created_at": "2021-10-05T12:52:53.000000Z",
    "deleted_at": ""
  }
}