Postpone Logo
Scheduling Posts

Post Tags

Learn how to query post tags to organize your scheduled content using the Postpone API.

Post Tags

Post tags allow you to organize and categorize your scheduled posts. You can query your post tags via the API to use them when scheduling posts across any platform.

Post tags are referenced by their ID when scheduling posts. Use the postTags query to retrieve your available tags and their IDs.

Query

Use the postTags query to retrieve all post tags for your account:

query postTags($activeOnly: Boolean) {
  postTags(activeOnly: $activeOnly) {
    id
    name
    color
    dateArchived
    dateCreated
    dateUpdated
  }
}

Parameters

activeOnly
Boolean
When true, returns only active (non-archived) tags. When false, returns all tags including archived ones. Defaults to true.

Response Fields

id
ID!
The unique identifier for the post tag. Use this ID when assigning tags to scheduled posts.
name
String!
The display name of the tag.
color
String!
The hex color code associated with the tag (e.g., #FF5733).
dateArchived
DateTime
The date when the tag was archived, or null if the tag is active.
dateCreated
DateTime!
The date when the tag was created.
dateUpdated
DateTime!
The date when the tag was last updated.

Examples

Get All Active Tags

query {
  postTags {
    id
    name
    color
  }
}

Response:

{
  "data": {
    "postTags": [
      {
        "id": "123",
        "name": "Product Launch",
        "color": "#4CAF50"
      },
      {
        "id": "456",
        "name": "Blog Content",
        "color": "#2196F3"
      }
    ]
  }
}

Using Tags When Scheduling Posts

When scheduling posts to any platform, you can include the postTags parameter with an array of tag IDs:

mutation ScheduleTweet($input: ScheduleTweetInput!) {
  scheduleTweet(input: $input) {
    success
    errors {
      message
    }
  }
}
Variables
{
  "input": {
    "username": "myhandle",
    "postAt": "2025-12-15T14:30:00.000Z",
    "thread": [{ "text": "Check out our new product!", "order": 0 }],
    "postTags": ["123", "456"]
  }
}
The postTags parameter accepts an array of post tag IDs. You can assign multiple tags to a single post.

Creating a Post Tag

Use the createPostTag mutation to create a new post tag:

mutation CreatePostTag($input: PostTagInputType!) {
  createPostTag(input: $input) {
    success
    errors {
      field
      message
    }
    postTag {
      id
      name
      color
    }
  }
}

PostTagInputType Fields

name
String! required
Display name for the tag.
color
String! required
Hex color code for the tag (e.g., #4CAF50).

Updating a Post Tag

Use the updatePostTag mutation to update an existing post tag's name or color:

mutation UpdatePostTag($input: UpdatePostTagInputType!) {
  updatePostTag(input: $input) {
    success
    errors {
      field
      message
    }
    postTag {
      id
      name
      color
    }
  }
}

UpdatePostTagInputType Fields

id
ID! required
The ID of the tag to update.
name
String
New display name for the tag. If not provided, the current name is kept.
color
String
New hex color code for the tag. If not provided, the current color is kept.

Archiving a Post Tag

Use the archivePostTag mutation to archive a post tag. Archived tags are hidden by default but can be restored later.

mutation ArchivePostTag($postTagId: ID!) {
  archivePostTag(postTagId: $postTagId) {
    success
    errors {
      field
      message
    }
  }
}
postTagId
ID! required
The unique identifier of the post tag to archive.

Restoring a Post Tag

Use the restorePostTag mutation to restore a previously archived post tag:

mutation RestorePostTag($postTagId: ID!) {
  restorePostTag(postTagId: $postTagId) {
    success
    errors {
      field
      message
    }
  }
}
postTagId
ID! required
The unique identifier of the archived post tag to restore.

Deleting a Post Tag

Use the deletePostTag mutation to permanently delete a post tag:

mutation DeletePostTag($postTagId: ID!) {
  deletePostTag(postTagId: $postTagId) {
    success
    errors {
      field
      message
    }
  }
}
postTagId
ID! required
The unique identifier of the post tag to permanently delete.
This action permanently deletes the tag and removes it from all analytics submissions. This cannot be undone.