Create Tag

SecurityAPIKeyHeader
Request
Request Body schema: application/json
required
name
required
string (Name)

Name of the tag

description
string (Description)

Description of the tag

status
required
string (TagStatus)

Tag status

Enum: "ACTIVE" "INACTIVE"
color
required
string (Color)

Color of the tag. This is a hex or hexadecimal color code (e.g. #0969da, #000, etc.)

Responses
201

Successful Response

Response Schema: application/json
name
required
string (Name)

Name of the tag

description
string (Description)

Description of the tag

status
required
string (TagStatus)

Tag status

Enum: "ACTIVE" "INACTIVE"
color
required
string (Color)

Color of the tag. This is a hex or hexadecimal color code (e.g. #0969da, #000, etc.)

id
required
string (Id)

Unique identifier for the tag

slug
required
string (Slug)

Slug of the tag

created_at
required
string <date-time> (Created At)

Timestamp of when the tag was created

updated_at
required
string <date-time> (Updated At)

Timestamp of when the tag was updated

deleted_at
string <date-time> (Deleted At)

Timestamp of when the tag was deleted

400

Validation Error

post/tags
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "status": "ACTIVE",
  • "color": "string"
}
Response samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "status": "ACTIVE",
  • "color": "string",
  • "id": "string",
  • "slug": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}
Copyright © Shipwell 2024. All right reserved.