Skip to content

Add update_tag_name method #115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 3, 2025
Merged

Add update_tag_name method #115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8480d84
Add `update_tag_name` method
n7studios Sep 30, 2025
7150507
Fix tests
n7studios Sep 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions src/ConvertKit_API_Traits.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -585,6 +585,23 @@ public function create_tags(array $tags, string $callback_url = '')
);
}

/**
* Updates the name of a tag.
*
* @param integer $tag_id Tag ID.
* @param string $name New name.
*
* @since 2.2.1
*
* @see https://developers.kit.com/api-reference/tags/update-tag-name
*
* @return false|mixed
*/
public function update_tag_name(int $tag_id, string $name)
{
return $this->put(sprintf('tags/%s', $tag_id), ['name' => $name]);
}

/**
* Tags a subscriber with the given existing Tag.
*
Expand Down
53 changes: 53 additions & 0 deletions tests/ConvertKitAPITest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1722,6 +1722,59 @@ public function testCreateTagsThatExist()
$this->assertEquals($result->tags[0]->name, $_ENV['CONVERTKIT_API_TAG_NAME_2']);
}

/**
* Test that update_tag_name() returns the expected data.
*
* @since 2.2.1
*
* @return void
*/
public function testUpdateTagName()
{
$result = $this->api->update_tag_name(
tag_id: (int) $_ENV['CONVERTKIT_API_TAG_ID'],
name: $_ENV['CONVERTKIT_API_TAG_NAME'],
);

// Assert existing tag is returned.
$this->assertEquals($result->tag->id, (int) $_ENV['CONVERTKIT_API_TAG_ID']);
$this->assertEquals($result->tag->name, $_ENV['CONVERTKIT_API_TAG_NAME']);
}

/**
* Test that update_tag_name() throws a ClientException when an invalid
* tag ID is specified.
*
* @since 2.2.1
*
* @return void
*/
public function testUpdateTagNameWithInvalidTagID()
{
$this->expectException(ClientException::class);
$result = $this->api->update_tag_name(
tag_id: 12345,
name: $_ENV['CONVERTKIT_API_TAG_NAME'],
);
}

/**
* Test that update_tag_name() throws a ClientException when a blank
* name is specified.
*
* @since 2.2.1
*
* @return void
*/
public function testUpdateTagNameWithBlankName()
{
$this->expectException(ClientException::class);
$result = $this->api->update_tag_name(
tag_id: (int) $_ENV['CONVERTKIT_API_TAG_ID'],
name: ''
);
}

/**
* Test that tag_subscriber_by_email() returns the expected data.
*
Expand Down