---
title: "Convert fundraising secure link"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sureshake.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Sureshake API › vault

`POST /v2/vault/fundraising/secure-links/{token}/convert`

## Path parameters

- `token` (`startup-convert-fundraising-secure-link.path.token`; string, required)
  - minLength 24

## Request body

_Required._

- `email` (`startup-convert-fundraising-secure-link.email`; string, required)
  - format `email`
- `requesterEntityId` (`startup-convert-fundraising-secure-link.requesterEntityId`; string, optional)
  - format `uuid`
- `requestNote` (`startup-convert-fundraising-secure-link.requestNote`; string, optional)
  - maxLength 2000

## Example request

```json
{
  "email": "user@example.com",
  "requesterEntityId": "af12adbd-3666-4602-844a-00328f5c0509",
  "requestNote": "string"
}
```

## Code samples

### cURL

```bash
curl --request POST \
  --url 'https://api.sureshake.com/v2/vault/fundraising/secure-links/<token>/convert' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "user@example.com",
  "requesterEntityId": "af12adbd-3666-4602-844a-00328f5c0509",
  "requestNote": "string"
}
'
```

### TypeScript

```typescript
const url = 'https://api.sureshake.com/v2/vault/fundraising/secure-links/<token>/convert';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: 'user@example.com',
    requesterEntityId: 'af12adbd-3666-4602-844a-00328f5c0509',
    requestNote: 'string'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.sureshake.com/v2/vault/fundraising/secure-links/<token>/convert"

payload = {
    "email": "user@example.com",
    "requesterEntityId": "af12adbd-3666-4602-844a-00328f5c0509",
    "requestNote": "string"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

## Responses

### 200

Default Response

#### Example

```json
{
  "data": {
    "secureLink": {
      "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"
    },
    "accessRequest": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "collectionId": "0ffe69e2-b7af-4b1e-835c-867376165f50",
      "requesterUserId": "string",
      "requesterEntityId": "af12adbd-3666-4602-844a-00328f5c0509",
      "status": "pending",
      "tokenNetwork": "base-mainnet",
      "tokenGrantStatus": "not_requested",
      "tokenGrantJobId": "string",
      "tokenGrantAttempts": 0,
      "tokenGrantLastError": "string",
      "tokenGrantLastAttemptAt": "2019-08-24T14:15:22Z",
      "tokenGrantCompletedAt": "2019-08-24T14:15:22Z",
      "requestNote": "string",
      "reviewNotes": "string",
      "reviewedBy": "string",
      "reviewedAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
```

- `data` (`startup-convert-fundraising-secure-link.response.200.data`; object, required)
  - `secureLink` (`startup-convert-fundraising-secure-link.response.200.data.secureLink`; object, required)
    - `id` (`startup-convert-fundraising-secure-link.response.200.data.secureLink.id`; string, required)
      - format `uuid`
    - `entityId` (`startup-convert-fundraising-secure-link.response.200.data.secureLink.entityId`; string, required)
      - format `uuid`
    - `artifactId` (`startup-convert-fundraising-secure-link.response.200.data.secureLink.artifactId`; string, required)
      - format `uuid`
    - `collectionId` (`startup-convert-fundraising-secure-link.response.200.data.secureLink.collectionId`; string, required)
      - format `uuid`
    - `invitedEmail` (`startup-convert-fundraising-secure-link.response.200.data.secureLink.invitedEmail`; string, required)
      - format `email`
    - `status` (`startup-convert-fundraising-secure-link.response.200.data.secureLink.status`; string, required)
      - one of `"active"`, `"converted"`, `"revoked"`, `"expired"`
    - `expiresAt` (`startup-convert-fundraising-secure-link.response.200.data.secureLink.expiresAt`; string, required, nullable)
      - format `date-time`
    - `convertedBy` (`startup-convert-fundraising-secure-link.response.200.data.secureLink.convertedBy`; string, required, nullable)
    - `convertedAt` (`startup-convert-fundraising-secure-link.response.200.data.secureLink.convertedAt`; string, required, nullable)
      - format `date-time`
    - `createdBy` (`startup-convert-fundraising-secure-link.response.200.data.secureLink.createdBy`; string, required)
    - `createdAt` (`startup-convert-fundraising-secure-link.response.200.data.secureLink.createdAt`; string, required)
      - format `date-time`
    - `updatedAt` (`startup-convert-fundraising-secure-link.response.200.data.secureLink.updatedAt`; string, required)
      - format `date-time`
    - `url` (`startup-convert-fundraising-secure-link.response.200.data.secureLink.url`; string, optional)
      - format `uri`
  - `accessRequest` (`startup-convert-fundraising-secure-link.response.200.data.accessRequest`; object, required)
    - `id` (`startup-convert-fundraising-secure-link.response.200.data.accessRequest.id`; string, required)
      - format `uuid`
    - `collectionId` (`startup-convert-fundraising-secure-link.response.200.data.accessRequest.collectionId`; string, required)
      - format `uuid`
    - `requesterUserId` (`startup-convert-fundraising-secure-link.response.200.data.accessRequest.requesterUserId`; string, required)
    - `requesterEntityId` (`startup-convert-fundraising-secure-link.response.200.data.accessRequest.requesterEntityId`; string, required, nullable)
      - format `uuid`
    - `status` (`startup-convert-fundraising-secure-link.response.200.data.accessRequest.status`; string, required)
      - one of `"pending"`, `"approved"`, `"rejected"`, `"cancelled"`
    - `tokenNetwork` (`startup-convert-fundraising-secure-link.response.200.data.accessRequest.tokenNetwork`; string, required)
      - one of `"base-mainnet"`
    - `tokenGrantStatus` (`startup-convert-fundraising-secure-link.response.200.data.accessRequest.tokenGrantStatus`; string, required)
      - one of `"not_requested"`, `"pending"`, `"granted"`, `"revoked"`, `"failed"`
    - `tokenGrantJobId` (`startup-convert-fundraising-secure-link.response.200.data.accessRequest.tokenGrantJobId`; string, required, nullable)
    - `tokenGrantAttempts` (`startup-convert-fundraising-secure-link.response.200.data.accessRequest.tokenGrantAttempts`; integer, required)
      - min 0
    - `tokenGrantLastError` (`startup-convert-fundraising-secure-link.response.200.data.accessRequest.tokenGrantLastError`; string, required, nullable)
    - `tokenGrantLastAttemptAt` (`startup-convert-fundraising-secure-link.response.200.data.accessRequest.tokenGrantLastAttemptAt`; string, required, nullable)
      - format `date-time`
    - `tokenGrantCompletedAt` (`startup-convert-fundraising-secure-link.response.200.data.accessRequest.tokenGrantCompletedAt`; string, required, nullable)
      - format `date-time`
    - `requestNote` (`startup-convert-fundraising-secure-link.response.200.data.accessRequest.requestNote`; string, required, nullable)
    - `reviewNotes` (`startup-convert-fundraising-secure-link.response.200.data.accessRequest.reviewNotes`; string, required, nullable)
    - `reviewedBy` (`startup-convert-fundraising-secure-link.response.200.data.accessRequest.reviewedBy`; string, required, nullable)
    - `reviewedAt` (`startup-convert-fundraising-secure-link.response.200.data.accessRequest.reviewedAt`; string, required, nullable)
      - format `date-time`
    - `createdAt` (`startup-convert-fundraising-secure-link.response.200.data.accessRequest.createdAt`; string, required)
      - format `date-time`
    - `updatedAt` (`startup-convert-fundraising-secure-link.response.200.data.accessRequest.updatedAt`; string, required)
      - format `date-time`
- `meta` (`startup-convert-fundraising-secure-link.response.200.meta`; object, optional)
  - `timestamp` (`startup-convert-fundraising-secure-link.response.200.meta.timestamp`; string, required)
    - format `date-time`

### 400

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`startup-convert-fundraising-secure-link.response.400.error`; object, required)
  - `code` (`startup-convert-fundraising-secure-link.response.400.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`startup-convert-fundraising-secure-link.response.400.error.message`; string, required) — Human-readable error message
  - `details` (`startup-convert-fundraising-secure-link.response.400.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`startup-convert-fundraising-secure-link.response.400.error.traceId`; string, optional) — Unique ID for log correlation

### 401

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`startup-convert-fundraising-secure-link.response.401.error`; object, required)
  - `code` (`startup-convert-fundraising-secure-link.response.401.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`startup-convert-fundraising-secure-link.response.401.error.message`; string, required) — Human-readable error message
  - `details` (`startup-convert-fundraising-secure-link.response.401.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`startup-convert-fundraising-secure-link.response.401.error.traceId`; string, optional) — Unique ID for log correlation

### 403

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`startup-convert-fundraising-secure-link.response.403.error`; object, required)
  - `code` (`startup-convert-fundraising-secure-link.response.403.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`startup-convert-fundraising-secure-link.response.403.error.message`; string, required) — Human-readable error message
  - `details` (`startup-convert-fundraising-secure-link.response.403.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`startup-convert-fundraising-secure-link.response.403.error.traceId`; string, optional) — Unique ID for log correlation

### 404

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`startup-convert-fundraising-secure-link.response.404.error`; object, required)
  - `code` (`startup-convert-fundraising-secure-link.response.404.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`startup-convert-fundraising-secure-link.response.404.error.message`; string, required) — Human-readable error message
  - `details` (`startup-convert-fundraising-secure-link.response.404.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`startup-convert-fundraising-secure-link.response.404.error.traceId`; string, optional) — Unique ID for log correlation

### 409

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`startup-convert-fundraising-secure-link.response.409.error`; object, required)
  - `code` (`startup-convert-fundraising-secure-link.response.409.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`startup-convert-fundraising-secure-link.response.409.error.message`; string, required) — Human-readable error message
  - `details` (`startup-convert-fundraising-secure-link.response.409.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`startup-convert-fundraising-secure-link.response.409.error.traceId`; string, optional) — Unique ID for log correlation

### 500

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`startup-convert-fundraising-secure-link.response.500.error`; object, required)
  - `code` (`startup-convert-fundraising-secure-link.response.500.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`startup-convert-fundraising-secure-link.response.500.error.message`; string, required) — Human-readable error message
  - `details` (`startup-convert-fundraising-secure-link.response.500.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`startup-convert-fundraising-secure-link.response.500.error.traceId`; string, optional) — Unique ID for log correlation

### 503

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`startup-convert-fundraising-secure-link.response.503.error`; object, required)
  - `code` (`startup-convert-fundraising-secure-link.response.503.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`startup-convert-fundraising-secure-link.response.503.error.message`; string, required) — Human-readable error message
  - `details` (`startup-convert-fundraising-secure-link.response.503.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`startup-convert-fundraising-secure-link.response.503.error.traceId`; string, optional) — Unique ID for log correlation


Source: https://docs.sureshake.com/reference/startup-convert-fundraising-secure-link/index.md