Prepare the exact Hive short-link address, destination, schedule, routing and tracking settings for review. Resolves current defaults without reserving an address or creating a link. Send its unchanged proposal to create_bio_short_link after the person reviews it.

post/api/v1/tools/prepare_bio_short_link

Request

  • Base URL: https://hivepublish.com
  • URL: https://hivepublish.com/api/v1/tools/prepare_bio_short_link
  • Auth: HTTP bearer

Request body

destinationUrlstring required

Where the short link goes. A full web address.

titlestring

A name for it inside Hive.

slugstring

A custom ending, 3 to 64 letters, numbers, hyphens or underscores. Leave it out for a generated one.

domainstring nullable

An active branded domain owned by this workspace; otherwise use its Hive default.

startsAtstring nullable

Optional start time in ISO format.

expiresAtstring nullable

Optional expiry time in ISO format.

tagsstring[]
campaignIdstring nullable

An existing campaign in this workspace; its tracking defaults are merged during preparation.

socialPostIdstring nullable

An existing saved Publishing post you can access in this workspace.

platformstring

Optional social network attribution.

Response

Tool result

dataunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.