Share via email

POST

https://api.sureshake.com/v2/reports/{id}/shares/email

Path parameters

id
string
required
format: uuid

Request body JSON required

email
string
required
format: email
versionId
optional
string
format: uuid
permission
optional
read
or
comment
or
suggest
default: "read"
allowDraftShare
optional
boolean
default: false
message
optional
string
maxLength: 1000
allowDownload
optional
boolean
or null
watermark
optional
boolean
or null

Returns

200

Default Response

JSON

data
object
required
- shareId
  optional
  string
  format: uuid
- status
  optional
  pending
  or
  accepted
  or
  revoked
  or
  expired
- inviteCode
  optional
  string
- inviteEmailSent
  optional
  boolean
- success
  optional
  boolean
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

409

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

422

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

curl --request POST \ --url 'https://api.sureshake.com/v2/reports/<id>/shares/email' \ --header 'Content-Type: application/json' \ --data ' { "versionId": "14707576-2549-4848-82ed-f68f8a1b47c7", "email": "user@example.com", "permission": "read", "allowDraftShare": false, "message": "string", "allowDownload": true, "watermark": true } '