Blog authors

Update a blog author

Changed on

Updates the specified blog author by setting the values of the parameters passed. Any parameters not provided will be left unchanged. The request is idempotent when an Idempotency-Key header is supplied.

patch/blog/authors/{id}

Request

  • Base URL: https://api.cavuno.com/v1
  • URL: https://api.cavuno.com/v1/blog/authors/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The author's opaque object id: the id field returned by the author endpoints (e.g. a4u7t9k2d6q0r3s8v1w5x9y2z6b0c4m7). This is NOT the slug or name; passing a slug like jane-doe returns 404. To look up an author by name or slug, use GET /v1/blog/authors and read the returned id.

Request body

slugstring

URL-friendly slug for the author. Auto-generated from name when omitted.

biostring

Short biography for the author. Sanitized HTML.

emailstring email nullable

The author's email address. Pass null to clear the stored value; omitted means unchanged.

locationstring

Free-text location label for the author (e.g. Sydney, Australia).

status'active' | 'inactive'

Author visibility status. One of active or inactive.

avatarMediaIdstring nullable

Cavuno media ID of an uploaded avatar image. Pass null to clear it.

websiteUrlstring nullable

The author's personal website URL. Normalized to a canonical URL when stored. Pass null or "" to clear the stored value; omitted means unchanged.

facebookUrlstring nullable

The author's Facebook profile URL. Pass null or "" to clear the stored value; omitted means unchanged.

twitterUrlstring nullable

The author's X (Twitter) profile URL. Stored as the canonical https://x.com/<handle> URL. Pass null or "" to clear the stored value; omitted means unchanged.

linkedinUrlstring nullable

The author's LinkedIn profile URL. Pass null or "" to clear the stored value; omitted means unchanged.

githubUrlstring nullable

The author's GitHub profile URL. Pass null or "" to clear the stored value; omitted means unchanged.

metaTitlestring

SEO meta title for the author page.

metaDescriptionstring

SEO meta description for the author page.

namestring

The author's display name.

Response

Successful response.

idstring required

Unique identifier for the object. Use this value as the {id} path parameter for the author endpoints (e.g. GET /v1/blog/authors/{id}).

object'blog_author' required

String representing the object's type. Objects of the same type share the same value.

namestring required

Display name of the author.

slugstring required

URL-friendly slug for the author.

biostring nullable required

Short biography, or null if not set.

emailstring nullable required

The author's email address, or null if not set.

locationstring nullable required

The author's free-text location label, or null if not set.

statusstring nullable required

Author visibility status, or null if not set.

avatarUrlstring nullable required

URL of the author avatar, or null if no avatar is set.

websiteUrlstring nullable required

The author's website URL, or null if not set.

facebookUrlstring nullable required

The author's Facebook URL, or null if not set.

twitterUrlstring nullable required

The author's X (Twitter) URL, or null if not set.

linkedinUrlstring nullable required

The author's LinkedIn URL, or null if not set.

githubUrlstring nullable required

The author's GitHub URL, or null if not set.

metaTitlestring nullable required

SEO meta title, or null if not set.

metaDescriptionstring nullable required

SEO meta description, or null if not set.

createdAtstring required

Time at which the author was created. ISO 8601 datetime.

updatedAtstring nullable required

Time at which the author was last updated, or null if it has never been updated. ISO 8601 datetime.

Changes

  • c34152c38176Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status