Update a tag

Updates a tag with the provided properties.

PATCH

https://api.katapult.io/core/v1/tags/{tag}

If successful, this endpoint will return a 200 OK status.

Scopes

One of the following scopes are required to use this endpoint.

The following arguments are supported for this endpoint.

Name	Type	Default Value
tag Required The tag to update	Tag Lookup	None
properties Required The new details for the tag	TagArguments	None

Name

Type

Default Value

tag Required

The tag to update

None

properties Required

The new details for the tag

None

The following errors may occur during this request.

Details	HTTP status
permission_denied The authenticated identity is not permitted to perform this action	403 Forbidden
tag_not_found No tag was found matching any of the criteria provided in the arguments	404 Not Found
validation_error A validation error occurred with the object that was being created/updated/deleted	422 Unprocessable Entity

Details

HTTP status

The authenticated identity is not permitted to perform this action

403 Forbidden

No tag was found matching any of the criteria provided in the arguments

404 Not Found

A validation error occurred with the object that was being created/updated/deleted

422 Unprocessable Entity

When the request is successful, you can expect an object matching the specification below to be returned.

{
    tag: Tag {
        id: String
        name: String
        color: TagColorsEnum
        created_at: Unix Timestamp
    }
}