Create fundraising secure link

POST

https://api.sureshake.com/v2/entities/{entityId}/vault/fundraising/artifacts/{artifactId}/secure-links

Path parameters

entityId
string
required
format: uuid

artifactId
string
required
format: uuid

Request body JSON required

email
string
required
format: email
expiresAt
optional
string
format: date-time

Returns

200

Default Response

JSON

data
object
required
- id
  string
  required
  format: uuid
- entityId
  string
  required
  format: uuid
- artifactId
  string
  required
  format: uuid
- collectionId
  string
  required
  format: uuid
- invitedEmail
  string
  required
  format: email
- status
  active
  or
  converted
  or
  revoked
  or
  expired
  required
- expiresAt
  string
  or null
  required
  format: date-time
- convertedBy
  string
  or null
  required
- convertedAt
  string
  or null
  required
  format: date-time
- createdBy
  string
  required
- createdAt
  string
  required
  format: date-time
- updatedAt
  string
  required
  format: date-time
- url
  optional
  string
  format: uri
}
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
}

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
}

503

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/entities/<entityId>/vault/fundraising/artifacts/<artifactId>/secure-links' \ --header 'Content-Type: application/json' \ --data ' { "email": "user@example.com", "expiresAt": "2019-08-24T14:15:22Z" } '

{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5", "artifactId": "706a3f1e-c357-4634-b1bf-20c221b5bb4e", "collectionId": "0ffe69e2-b7af-4b1e-835c-867376165f50", "invitedEmail": "user@example.com", "status": "active", "expiresAt": "2019-08-24T14:15:22Z", "convertedBy": "string", "convertedAt": "2019-08-24T14:15:22Z", "createdBy": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "url": "http://example.com" }, "meta": { "timestamp": "2019-08-24T14:15:22Z" } }