Addresses1

ApiCredentials6

Asset resources1

Attachments2

Blocks3

BoundaryDrafts6

Categories2

Cities3

Clients5

Compliance exports6

Connection2

Contractors1

Documentation3

Drench records2

Fertiliser records2

Field work records2

Husbandry records2

Image uploads2

LikedContractors3

Locations1

Mobs6

OAuth11

OauthTokens4

Organization Join Links3

Organization Roles7

Organizations5

Paddocks6

Predictions1

Products1

Properties13

PropertySetupDrafts3

Public25

Services7

Sitemap5

Sowing records2

Spray records2

Subscriptions4

Tasks13

Treatment records2

Treatment register1

Users8

Compliance exports

Share a compliance export by email or text

Changed on Oct 24, 2026

Hands a ready export to someone with a link (/s/<token> on the web app) that offers the zip without an account for seven days, and never past the export's own expiry.

email: sends the link, the file name, the properties and dates, and an optional note.
sms: sends exactly "{first name} from PurpleGrain shared a compliance export for {properties}: {link} (expires D/M/YY)". (Outside production the text is logged, not sent.)

Needs edit rights on every exported property (owner, admin or manager; a viewer is refused) and only the person who made the export may share it. First-party web and mobile only, because this sends records off the platform. The recipient is returned masked.

If the email or text fails, the share is stored as failed (its link then answers 404) and the response is a 502 with errors[0].code email_bounced or text_not_delivered.

post/compliance-exports/{compliance_export_id}/shares

Request

Base URL: https://api.purplegrain.com/api/v1
URL: https://api.purplegrain.com/api/v1/compliance-exports/{compliance_export_id}/shares
Auth: HTTP bearer

Path parameters

compliance_export_idstring required

The export to share.

Request body

via'email' | 'sms' required

recipientstring required

An email address, or an Australian mobile (0412 345 678, +61412345678).

messagestring

An optional note, shown in the email. Ignored for a text.

Response

Shared.

Example response

{
  "share": {
    "recipient": "04•• ••• 318"
  }
}

Changes

Oct 24, 2026e285768a8f1d Revision changes
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the // response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the // response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the // response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the // response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the // response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the // response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the //// response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the //// response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the //// response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the //// response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the //// response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the //// response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the // response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the // response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the // response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the // response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the // response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the // response property for the response status (media type: application/vnd.api+json)
Oct 24, 202692f716edc989 Revision changes
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: application/vnd.api+json)
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: application/vnd.api+json)
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: application/vnd.api+json)
- info
  added the optional property // to the response with the status (media type: application/json)
- info
  added the optional property // to the response with the status (media type: application/vnd.api+json)
- info
  added the optional property // to the response with the status (media type: application/json)
- info
  added the optional property // to the response with the status (media type: application/vnd.api+json)
- info
  added the optional property // to the response with the status (media type: application/json)
- info
  added the optional property // to the response with the status (media type: application/vnd.api+json)
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: application/vnd.api+json)
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: application/vnd.api+json)
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: application/vnd.api+json)
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: application/vnd.api+json)
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: application/vnd.api+json)
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: application/vnd.api+json)

Operation history (3 revisions)