Create Job Share Link

Overview

This endpoint allows an integration to programmatically generate a Job Share link to share with a homeowner, pro, or other stakeholder.

The job share link will direct users to Hover's Design Studio, allowing them to edit a 3D model of the property.

Sample Response Body

{
    "job_share": {
        "id": 1093186,
        "job_id": 9795709,
        "user_id": 1527247,
        "recipient_id": null,
        "token": "AyyAP33PEBy_9AdvV1s7",
        "external_service": null,
        "external_identifier": null,
        "expired": false,
        "expires_at": "2023-09-19T20:13:18.890Z",
        "url": "https://hover.to/shared/AyyAP33PEBy_9AdvV1s7",
        "image_url": "https://hover.to/api/v1/images/102934450/rotated_image.jpg?share_token=AyyAP33PEBy_9AdvV1s7&version=medium",
        "video_url": "https://hover.to/api/v1/models/9793284/video.mp4?share_token=AyyAP33PEBy_9AdvV1s7",
        "open_graph_url": "https://hover.to/shared/AyyAP33PEBy_9AdvV1s7",
        "street_address": "123 HOVER Way",
        "state": null
    }
}