Destinations

Remove a publishing destination from the org

Removes a destination assignment from the organization, choosing what to do with content already published there via action.

post/org/destinations/{publisherId}/remove

Request

  • Base URL
    https://apiv2.senso.ai/api/v1
  • Auth
    API key in header X-API-Key

Path parameters

publisherIdstring uuid required

The destination (publisher) id to remove.

Request body

action'leave' | 'unpublish' | 'delete' required

What to do with content already published to this destination — leave it as-is, unpublish it, or delete it.

also_remove_destinationboolean

Also hard-delete the destination row after the content action completes (org scope only).

keep_domainboolean

For a custom domain, keep the domain reachable instead of deregistering it.

Response

Summary of what the removal changed.

affected_record_countinteger required

Number of publish records (live or failed) on this destination that the removal acted on.

unpublished_countinteger required

How many publish records were unpublished.

deleted_content_countinteger required

How many content items were deleted (only for the delete action).

destination_removedboolean required

Whether the destination (publisher) record itself was hard-deleted — true only when also_remove_destination is set. The org's assignment to the destination is always removed on success, regardless of this flag.

domain_deregisteredboolean required

Whether the custom domain was deregistered (citeables custom domains only).

partial_failuresstring[]

Any per-item failures that occurred during removal.

Changes

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