Rename or recolor a tag

PATCH

/tags/{id}

curl --request PATCH \
  --url https://postflow.biz.id/api/v1/tags/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "color": "example" }'

Authorizations

• apiKey
• oauth

Parameters

Path Parameters

id

required

string

Tag id

Request Body^required

Media typeapplication/json

object

name

string

>= 1 characters <= 40 characters

color

string

/^#[0-9a-f]{6}$/

Example ^generated

{
  "name": "example",
  "color": "example"
}

Responses

200

OK

Media typeapplication/json

object

id

required

string

name

required

string

color

required

Hex color

string

Example ^generated

{
  "id": "example",
  "name": "example",
  "color": "example"
}

400

Validation failed. details lists what to fix.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: UNAUTHENTICATED FORBIDDEN NOT_FOUND VALIDATION CONFLICT SUBSCRIPTION_GRACE SUBSCRIPTION_EXPIRED PLAN_LIMIT RATE_LIMITED INTERNAL

message

required

A sentence you can show to a person.

string

details

Field errors ({ field: [messages] }), or preflight: per-account rule violations with an issue code.

Example

{
  "error": {
    "code": "UNAUTHENTICATED"
  }
}

401

Missing, invalid, expired or deleted key or token.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: UNAUTHENTICATED FORBIDDEN NOT_FOUND VALIDATION CONFLICT SUBSCRIPTION_GRACE SUBSCRIPTION_EXPIRED PLAN_LIMIT RATE_LIMITED INTERNAL

message

required

A sentence you can show to a person.

string

details

Field errors ({ field: [messages] }), or preflight: per-account rule violations with an issue code.

Example

{
  "error": {
    "code": "UNAUTHENTICATED"
  }
}

403

Not allowed: a read-only key, the owner’s approval, or an owner-only action.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: UNAUTHENTICATED FORBIDDEN NOT_FOUND VALIDATION CONFLICT SUBSCRIPTION_GRACE SUBSCRIPTION_EXPIRED PLAN_LIMIT RATE_LIMITED INTERNAL

message

required

A sentence you can show to a person.

string

details

Field errors ({ field: [messages] }), or preflight: per-account rule violations with an issue code.

Example

{
  "error": {
    "code": "UNAUTHENTICATED"
  }
}

404

Not found in this workspace.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: UNAUTHENTICATED FORBIDDEN NOT_FOUND VALIDATION CONFLICT SUBSCRIPTION_GRACE SUBSCRIPTION_EXPIRED PLAN_LIMIT RATE_LIMITED INTERNAL

message

required

A sentence you can show to a person.

string

details

Field errors ({ field: [messages] }), or preflight: per-account rule violations with an issue code.

Example

{
  "error": {
    "code": "UNAUTHENTICATED"
  }
}

409

Conflict, e.g. the post is publishing right now, or the platform refused the action.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: UNAUTHENTICATED FORBIDDEN NOT_FOUND VALIDATION CONFLICT SUBSCRIPTION_GRACE SUBSCRIPTION_EXPIRED PLAN_LIMIT RATE_LIMITED INTERNAL

message

required

A sentence you can show to a person.

string

details

Field errors ({ field: [messages] }), or preflight: per-account rule violations with an issue code.

Example

{
  "error": {
    "code": "UNAUTHENTICATED"
  }
}

429

More than 120 requests in a minute with this key.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: UNAUTHENTICATED FORBIDDEN NOT_FOUND VALIDATION CONFLICT SUBSCRIPTION_GRACE SUBSCRIPTION_EXPIRED PLAN_LIMIT RATE_LIMITED INTERNAL

message

required

A sentence you can show to a person.

string

details

Field errors ({ field: [messages] }), or preflight: per-account rule violations with an issue code.

Example

{
  "error": {
    "code": "UNAUTHENTICATED"
  }
}