---
title: "POST /api/custom-reports/{customReport}/share"
method: POST
path: "/api/custom-reports/{customReport}/share"
tags: ["Custom Reports"]
---

# POST /api/custom-reports/{customReport}/share

`POST /api/custom-reports/{customReport}/share`

## Request

- Base URL: `https://api.sponsorunited.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.sponsorunited.com/api/custom-reports/{customReport}/share`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/sponsorunited/apis/sponsorunited-api/docs/api/custom-reports/:customReport/share/post.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `customReport` integer, required

## Request body

- CustomReportShareRequest
  - `user_ids` integer[], required: Array of user IDs to share the report with

## Response `200`

Report shared successfully

- object
  - `data` CustomReportResource[]
    - `id` integer
    - `title` string
    - `description` string, nullable
    - `report_file_id` integer, nullable
    - `thumbnail_url` string, nullable
    - `published_at` string, date-time, nullable
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `deleted_at` string, date-time, nullable
    - `tags` Tag[]
      - `id` integer: Tag Model
      - `name` string
      - `created_at` string, date-time
      - `updated_at` string, date-time
      - `deleted_at` string, date-time, nullable
    - `brands` Company[]
      - `id` integer
      - `parent_company_id` integer
      - `subcategory_id` integer
      - `categories_id` integer
      - `name` string
      - `synopsis` string
      - `corporate_phone` string
      - `website` string
      - `linkedin` string
      - `linkedin_id_url` string
      - `linkedin_employees` string
      - `facebook` string
      - `twitter` string
      - `instagram` string
      - `twitch` string
      - `tiktok` string
      - `youtube` string
      - `exclude_from_social_scan` boolean
      - `exclude_from_transcribe` boolean
      - `feed_url` string
      - `statistics` string
      - `no_of_employees` string
      - `priority_markets` string
      - `parent_company` string
      - `ad_agency` string
      - `existing` string
      - `owned_by` string
      - `approved` boolean
      - `approved_by` string
      - `created_at` string, date-time
      - `updated_at` string, date-time
      - `deleted_at` string, date-time
    - `properties` Property[]
      - `id` integer
      - `parent_id` integer
      - `type_id` integer
      - `uuid` integer
      - `division_id` integer
      - `sport_id` integer
      - `name` string
      - `synopsis` string
      - `alias` string
      - `logo` string
      - `cover` string
      - `is_continuous` integer
      - `league_level_property` integer
      - `no_of_employees` integer
      - `email` string
      - `website_url` string
      - `linkedin_url` string
      - `linkedin_id_url` string
      - `facebook_url` string
      - `twitter_url` string
      - `instagram_url` string
      - `twitch_url` string
      - `tiktok_url` string
      - `youtube_url` string
      - `exclude_from_social_scan` integer
      - `inactive` integer
      - `market` string
      - `state` string
      - `city` string
      - `geolocation` string
      - `corporate_phone` string
      - `linkedin_employees` string
      - `targeted_prospects_feed_url` string
      - `top_sponsorship_headlines_feed_url` string
      - `headlines_feed_url` string
      - `capacity` string
      - `venue_uuid` string
      - `created_at` string, date-time
      - `updated_at` string, date-time
      - `deleted_at` string, date-time
    - `agencies` Agency[]
      - `id` integer
      - `name` string
      - `synopsis` string
      - `logo` string
      - `no_of_employees` integer
      - `corporate_phone` string
      - `website` string
      - `linkedin` string
      - `linkedin_id_url` string
      - `linkedin_employees` string
      - `facebook` string
      - `twitter` string
      - `instagram` string
      - `twitch` string
      - `tiktok` string
      - `youtube` string
      - `feed_url` string
      - `created_at` string, date-time
      - `updated_at` string, date-time
      - `deleted_at` string, date-time
    - `organization_users` object[]: Organizations with their users who have access to the report
      - `id` integer: Organization ID
      - `name` string: Organization name
      - `users` object[]: Users from this organization with access
        - `id` integer: User ID
        - `name` string: User name
    - `file` object, nullable
      - `id` integer: The FileUpload model represents an uploaded file record, including its metadata and relation to a user and thumbnail image.
      - `user_id` integer: The ID of the user who uploaded the file
      - `original_name` string: The original name of the uploaded file
      - `stored_name` string: The stored name of the file in the filesystem
      - `mime_type` string: The MIME type of the file
      - `file_size` integer: The size of the file in bytes
      - `file_hash` string: A hash of the file for integrity verification
      - `url` string: The URL where the file can be accessed
      - `thumbnail_id` integer: The ID of the thumbnail image associated with the file
      - `created_at` string, date-time: Timestamp when the file upload was created
      - `updated_at` string, date-time: Timestamp when the file upload was last updated
      - `deleted_at` string, date-time, nullable: Timestamp when the file upload was deleted, if applicable
    - `sent_count` integer: Number of users this report was shared with
    - `opened_count` integer: Number of recipients who have viewed the report

## Other responses

- `404`: Report not found
- `422`: Validation error
- `500`: Internal server error

---

[API](https://skmtc.dev/sponsorunited/apis/sponsorunited-api.md) - [All operations](https://skmtc.dev/sponsorunited/apis/sponsorunited-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sponsorunited/apis/sponsorunited-api/revisions/cbf1ca5bff8f?raw)