---
title: "Create commitment attestation invitation"
---

> 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 › execution

`POST /v2/execution/cycles/{cycleId}/commitments/{commitmentId}/attestation-invitations`

## Path parameters

- `cycleId` (`execution-create-commitment-attestation-invitation.path.cycleId`; string, required)
  - format `uuid`
- `commitmentId` (`execution-create-commitment-attestation-invitation.path.commitmentId`; string, required)
  - format `uuid`

## Request body

_Required._

- `expectedVersionNumber` (`execution-create-commitment-attestation-invitation.expectedVersionNumber`; integer, required)
  - min 1
- `invitedEmail` (`execution-create-commitment-attestation-invitation.invitedEmail`; string, required)
  - format `email`; maxLength 320
- `relationship` (`execution-create-commitment-attestation-invitation.relationship`; string, required)
  - one of `"customer"`, `"mentor"`, `"advisor"`, `"program_operator"`, `"capital_provider"`
- `expiresAt` (`execution-create-commitment-attestation-invitation.expiresAt`; string, optional)
  - format `date-time`

## Example request

```json
{
  "expectedVersionNumber": 1,
  "invitedEmail": "user@example.com",
  "relationship": "customer",
  "expiresAt": "2019-08-24T14:15:22Z"
}
```

## Code samples

### cURL

```bash
curl --request POST \
  --url 'https://api.sureshake.com/v2/execution/cycles/<cycleId>/commitments/<commitmentId>/attestation-invitations' \
  --header 'Content-Type: application/json' \
  --data '
{
  "expectedVersionNumber": 1,
  "invitedEmail": "user@example.com",
  "relationship": "customer",
  "expiresAt": "2019-08-24T14:15:22Z"
}
'
```

### TypeScript

```typescript
const url = 'https://api.sureshake.com/v2/execution/cycles/<cycleId>/commitments/<commitmentId>/attestation-invitations';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    expectedVersionNumber: 1,
    invitedEmail: 'user@example.com',
    relationship: 'customer',
    expiresAt: '2019-08-24T14:15:22Z'
  })
};

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/execution/cycles/<cycleId>/commitments/<commitmentId>/attestation-invitations"

payload = {
    "expectedVersionNumber": 1,
    "invitedEmail": "user@example.com",
    "relationship": "customer",
    "expiresAt": "2019-08-24T14:15:22Z"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
```

## Responses

### 201

Default Response

#### Example

```json
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "cycleId": "811bdbf8-a42f-4f8c-b62e-39c77332ffe1",
    "commitmentId": "4e1ecf7c-8127-4207-92b0-010ff43ff54d",
    "commitmentVersionNumber": 1,
    "resolutionId": "bc6d8f79-6014-4352-9db6-903e2ea5d245",
    "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
    "inviteeUserId": "string",
    "invitedEmail": "user@example.com",
    "relationship": "customer",
    "status": "pending",
    "invitedByUserId": "string",
    "expiresAt": "2019-08-24T14:15:22Z",
    "usedByUserId": "string",
    "usedAt": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "delivery": "in_app"
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
```

- `data` (`execution-create-commitment-attestation-invitation.response.201.data`; object, required)
  - `id` (`execution-create-commitment-attestation-invitation.response.201.data.id`; string, required)
    - format `uuid`
  - `cycleId` (`execution-create-commitment-attestation-invitation.response.201.data.cycleId`; string, required)
    - format `uuid`
  - `commitmentId` (`execution-create-commitment-attestation-invitation.response.201.data.commitmentId`; string, required)
    - format `uuid`
  - `commitmentVersionNumber` (`execution-create-commitment-attestation-invitation.response.201.data.commitmentVersionNumber`; integer, required)
    - min 1
  - `resolutionId` (`execution-create-commitment-attestation-invitation.response.201.data.resolutionId`; string, required)
    - format `uuid`
  - `entityId` (`execution-create-commitment-attestation-invitation.response.201.data.entityId`; string, required)
    - format `uuid`
  - `inviteeUserId` (`execution-create-commitment-attestation-invitation.response.201.data.inviteeUserId`; string, required)
    - minLength 1
  - `invitedEmail` (`execution-create-commitment-attestation-invitation.response.201.data.invitedEmail`; string, required)
    - format `email`
  - `relationship` (`execution-create-commitment-attestation-invitation.response.201.data.relationship`; string, required)
    - one of `"customer"`, `"mentor"`, `"advisor"`, `"program_operator"`, `"capital_provider"`
  - `status` (`execution-create-commitment-attestation-invitation.response.201.data.status`; string, required)
    - one of `"pending"`, `"used"`, `"revoked"`, `"expired"`
  - `invitedByUserId` (`execution-create-commitment-attestation-invitation.response.201.data.invitedByUserId`; string, required)
    - minLength 1
  - `expiresAt` (`execution-create-commitment-attestation-invitation.response.201.data.expiresAt`; string, required)
    - format `date-time`
  - `usedByUserId` (`execution-create-commitment-attestation-invitation.response.201.data.usedByUserId`; string, required, nullable)
    - minLength 1
  - `usedAt` (`execution-create-commitment-attestation-invitation.response.201.data.usedAt`; string, required, nullable)
    - format `date-time`
  - `createdAt` (`execution-create-commitment-attestation-invitation.response.201.data.createdAt`; string, required)
    - format `date-time`
  - `delivery` (`execution-create-commitment-attestation-invitation.response.201.data.delivery`; string, required)
    - one of `"in_app"`
- `meta` (`execution-create-commitment-attestation-invitation.response.201.meta`; object, optional)
  - `timestamp` (`execution-create-commitment-attestation-invitation.response.201.meta.timestamp`; string, required)
    - format `date-time`

### 400

Default Response

#### Example

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

- `error` (`execution-create-commitment-attestation-invitation.response.400.error`; object, required)
  - `code` (`execution-create-commitment-attestation-invitation.response.400.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-create-commitment-attestation-invitation.response.400.error.message`; string, required) — Human-readable error message
  - `details` (`execution-create-commitment-attestation-invitation.response.400.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-create-commitment-attestation-invitation.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` (`execution-create-commitment-attestation-invitation.response.401.error`; object, required)
  - `code` (`execution-create-commitment-attestation-invitation.response.401.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-create-commitment-attestation-invitation.response.401.error.message`; string, required) — Human-readable error message
  - `details` (`execution-create-commitment-attestation-invitation.response.401.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-create-commitment-attestation-invitation.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` (`execution-create-commitment-attestation-invitation.response.403.error`; object, required)
  - `code` (`execution-create-commitment-attestation-invitation.response.403.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-create-commitment-attestation-invitation.response.403.error.message`; string, required) — Human-readable error message
  - `details` (`execution-create-commitment-attestation-invitation.response.403.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-create-commitment-attestation-invitation.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` (`execution-create-commitment-attestation-invitation.response.404.error`; object, required)
  - `code` (`execution-create-commitment-attestation-invitation.response.404.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-create-commitment-attestation-invitation.response.404.error.message`; string, required) — Human-readable error message
  - `details` (`execution-create-commitment-attestation-invitation.response.404.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-create-commitment-attestation-invitation.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` (`execution-create-commitment-attestation-invitation.response.409.error`; object, required)
  - `code` (`execution-create-commitment-attestation-invitation.response.409.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-create-commitment-attestation-invitation.response.409.error.message`; string, required) — Human-readable error message
  - `details` (`execution-create-commitment-attestation-invitation.response.409.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-create-commitment-attestation-invitation.response.409.error.traceId`; string, optional) — Unique ID for log correlation

### 422

Default Response

#### Example

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

- `error` (`execution-create-commitment-attestation-invitation.response.422.error`; object, required)
  - `code` (`execution-create-commitment-attestation-invitation.response.422.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-create-commitment-attestation-invitation.response.422.error.message`; string, required) — Human-readable error message
  - `details` (`execution-create-commitment-attestation-invitation.response.422.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-create-commitment-attestation-invitation.response.422.error.traceId`; string, optional) — Unique ID for log correlation

### 429

Default Response

#### Example

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

- `error` (`execution-create-commitment-attestation-invitation.response.429.error`; object, required)
  - `code` (`execution-create-commitment-attestation-invitation.response.429.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-create-commitment-attestation-invitation.response.429.error.message`; string, required) — Human-readable error message
  - `details` (`execution-create-commitment-attestation-invitation.response.429.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-create-commitment-attestation-invitation.response.429.error.traceId`; string, optional) — Unique ID for log correlation

### 500

Default Response

#### Example

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

- `error` (`execution-create-commitment-attestation-invitation.response.500.error`; object, required)
  - `code` (`execution-create-commitment-attestation-invitation.response.500.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-create-commitment-attestation-invitation.response.500.error.message`; string, required) — Human-readable error message
  - `details` (`execution-create-commitment-attestation-invitation.response.500.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-create-commitment-attestation-invitation.response.500.error.traceId`; string, optional) — Unique ID for log correlation

### 502

Default Response

#### Example

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

- `error` (`execution-create-commitment-attestation-invitation.response.502.error`; object, required)
  - `code` (`execution-create-commitment-attestation-invitation.response.502.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-create-commitment-attestation-invitation.response.502.error.message`; string, required) — Human-readable error message
  - `details` (`execution-create-commitment-attestation-invitation.response.502.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-create-commitment-attestation-invitation.response.502.error.traceId`; string, optional) — Unique ID for log correlation

### 503

Default Response

#### Example

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

- `error` (`execution-create-commitment-attestation-invitation.response.503.error`; object, required)
  - `code` (`execution-create-commitment-attestation-invitation.response.503.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-create-commitment-attestation-invitation.response.503.error.message`; string, required) — Human-readable error message
  - `details` (`execution-create-commitment-attestation-invitation.response.503.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-create-commitment-attestation-invitation.response.503.error.traceId`; string, optional) — Unique ID for log correlation


Source: https://docs.sureshake.com/reference/execution-create-commitment-attestation-invitation/index.md