update_user

update_user

Update an existing user in Ghost.

Args:
    user_id: ID of the user to update (required)
    name: User's full name (optional)
    slug: User's slug (optional)
    email: User's email address (optional)
    profile_image: URL for profile image (optional)
    cover_image: URL for cover image (optional)
    bio: User's bio (optional)
    website: User's website URL (optional)
    location: User's location (optional)
    facebook: Facebook username (optional)
    twitter: Twitter username (optional)
    meta_title: Meta title for SEO (optional)
    meta_description: Meta description for SEO (optional)
    accessibility: Accessibility settings (optional)
    comment_notifications: Enable comment notifications (optional)
    free_member_signup_notification: Enable free member signup notifications (optional)
    paid_subscription_started_notification: Enable paid subscription started notifications (optional)
    paid_subscription_canceled_notification: Enable paid subscription canceled notifications (optional)
    mention_notifications: Enable mention notifications (optional)
    milestone_notifications: Enable milestone notifications (optional)
    ctx: Optional context for logging

Returns:
    String representation of the updated user

Raises:
    GhostError: If the Ghost API request fails
    ValueError: If no fields to update are provided

Input Schema

Name	Required	Description	Default
`accessibility`	No
`bio`	No
`comment_notifications`	No
`cover_image`	No
`email`	No
`facebook`	No
`free_member_signup_notification`	No
`location`	No
`mention_notifications`	No
`meta_description`	No
`meta_title`	No
`milestone_notifications`	No
`name`	No
`paid_subscription_canceled_notification`	No
`paid_subscription_started_notification`	No
`profile_image`	No
`slug`	No
`twitter`	No
`user_id`	Yes
`website`	No

Input Schema (JSON Schema)

{
  "properties": {
    "accessibility": {
      "default": null,
      "title": "Accessibility",
      "type": "string"
    },
    "bio": {
      "default": null,
      "title": "Bio",
      "type": "string"
    },
    "comment_notifications": {
      "default": null,
      "title": "Comment Notifications",
      "type": "boolean"
    },
    "cover_image": {
      "default": null,
      "title": "Cover Image",
      "type": "string"
    },
    "email": {
      "default": null,
      "title": "Email",
      "type": "string"
    },
    "facebook": {
      "default": null,
      "title": "Facebook",
      "type": "string"
    },
    "free_member_signup_notification": {
      "default": null,
      "title": "Free Member Signup Notification",
      "type": "boolean"
    },
    "location": {
      "default": null,
      "title": "Location",
      "type": "string"
    },
    "mention_notifications": {
      "default": null,
      "title": "Mention Notifications",
      "type": "boolean"
    },
    "meta_description": {
      "default": null,
      "title": "Meta Description",
      "type": "string"
    },
    "meta_title": {
      "default": null,
      "title": "Meta Title",
      "type": "string"
    },
    "milestone_notifications": {
      "default": null,
      "title": "Milestone Notifications",
      "type": "boolean"
    },
    "name": {
      "default": null,
      "title": "Name",
      "type": "string"
    },
    "paid_subscription_canceled_notification": {
      "default": null,
      "title": "Paid Subscription Canceled Notification",
      "type": "boolean"
    },
    "paid_subscription_started_notification": {
      "default": null,
      "title": "Paid Subscription Started Notification",
      "type": "boolean"
    },
    "profile_image": {
      "default": null,
      "title": "Profile Image",
      "type": "string"
    },
    "slug": {
      "default": null,
      "title": "Slug",
      "type": "string"
    },
    "twitter": {
      "default": null,
      "title": "Twitter",
      "type": "string"
    },
    "user_id": {
      "title": "User Id",
      "type": "string"
    },
    "website": {
      "default": null,
      "title": "Website",
      "type": "string"
    }
  },
  "required": [
    "user_id"
  ],
  "title": "update_userArguments",
  "type": "object"
}

Input Schema

Input Schema (JSON Schema)

Other Tools