# POST /api/developer-portal/invitations

Issues an invitation and emails its redemption link to the invited party.

The invited party must already be an active user of the acting merchant. The returned
invitation carries no token; the link travels only in the email. If the email cannot be
sent, the invitation is revoked before the call returns. Issues are rate limited per
merchant, and a spent budget answers 429 until the window rolls over.

**Operation ID:** `developerPortalIssue`

## Authorization

Requires: DeveloperPortal.Invitations, DeveloperPortal.Invitations.Create, merchant scope.

Required permissions:
- `DeveloperPortal.Invitations`
- `DeveloperPortal.Invitations.Create`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |
| X-Acting-Merchant-Id | header | no | string(uuid) | The merchant to act for. Optional: when absent, the caller's own merchant scope answers. A caller whose identity carries no merchant scope, such as an administrator, must send it. The selection is authorized on every operation; a merchant the caller may not act for is refused. |

## Request Body

Who to invite, the portal role offered, and an optional address override.

**Content type:** `application/json`

Schema: `DeveloperPortalInvitationCreateDto`

Properties:
- `invitedIdentityUserId` (string(uuid)) required: The existing identity user to invite. Must already be an active merchant user of the caller's  merchant, which the picker guarantees and the issue path asserts anyway.
- `email` (string): Where to send the invitation. Blank sends it to the invited user's own registered address.
- `role` (object): The portal capability a redemption will grant.

**Content type:** `text/json`

Schema: `DeveloperPortalInvitationCreateDto`

Properties:
- `invitedIdentityUserId` (string(uuid)) required: The existing identity user to invite. Must already be an active merchant user of the caller's  merchant, which the picker guarantees and the issue path asserts anyway.
- `email` (string): Where to send the invitation. Blank sends it to the invited user's own registered address.
- `role` (object): The portal capability a redemption will grant.

**Content type:** `application/*+json`

Schema: `DeveloperPortalInvitationCreateDto`

Properties:
- `invitedIdentityUserId` (string(uuid)) required: The existing identity user to invite. Must already be an active merchant user of the caller's  merchant, which the picker guarantees and the issue path asserts anyway.
- `email` (string): Where to send the invitation. Blank sends it to the invited user's own registered address.
- `role` (object): The portal capability a redemption will grant.

## Responses

### 200

OK

**Content type:** `application/json`

Schema: `DeveloperPortalInvitationDto`

Properties:
- `id` (string(uuid))
- `creationTime` (string(date-time)): The date and time when this entity was created.
- `creatorId` (string(uuid)): The ID of the user who created this entity.
- `lastModificationTime` (string(date-time)): The date and time when this entity was last modified.
- `lastModifierId` (string(uuid)): The ID of the user who last modified this entity.
- `isDeleted` (boolean): Indicates whether this entity has been deleted.
- `deleterId` (string(uuid)): The ID of the user who deleted this entity, if it is deleted.
- `deletionTime` (string(date-time)): The date and time when this entity was deleted, if it is deleted.
- `merchantId` (string(uuid)): The merchant the invitation offers access to, or `null` when it offers access to a  reseller. Exactly one of this and `resellerId` is set.
- `resellerId` (string(uuid)): The reseller the invitation offers access to, or `null` when it offers access to a  merchant. Exactly one of this and `merchantId` is set.
- `email` (string): The address the invitation was emailed to.
- `invitedIdentityUserId` (string(uuid)): The identity user the invitation is for, and the only one who can redeem it.
- `role` (object): The portal capability a redemption will grant.
- `expiresAt` (string(date-time)): When the invitation stops being redeemable, in UTC. The contract stays UTC in and UTC out;  display surfaces convert it to the viewer's time zone.
- `status` (object): The lifecycle state, already resolved against the clock by the reader.
- `issuedByUserId` (string(uuid)): The back-office user who issued the invitation.
- `redeemedAt` (string(date-time)): When the invitation was redeemed, in UTC, or `null` if it never was.
- `revokedAt` (string(date-time)): When the invitation was revoked, in UTC, or `null` if it never was.
- `concurrencyStamp` (string): Optimistic-concurrency token.
- `user` (object): The identity half of the invited party: who they are, and whether they already hold a  back-office role. `null` when the reader did not enrich the row.

### 403

Forbidden

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 401

Unauthorized

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 400

Bad Request

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 404

Not Found

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 501

Not Implemented

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 500

Internal Server Error

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### default

The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 429

The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

**Content type:** `application/problem+json`

Schema: `RateLimitProblemDetails`

Properties:
- `type` (string) required: The problem type identifier. Always the same value: the failure is the status code itself,  so there is no sub-type for a caller to branch on.
- `title` (string) required: A short, human-readable summary of the problem type.
- `status` (integer(int32)) required: The HTTP status code, repeated in the body as the problem-details format defines.
- `detail` (string) required: A human-readable explanation of this occurrence of the problem.
- `retryAfterSeconds` (integer(int32)) required: How long to wait before retrying, in whole seconds, carrying the same figure as the  `Retry-After` header. Always at least one: a value of zero would invite an immediate  retry that is certain to be rejected again.

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

## Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a DeveloperPortalInvitationCreateDto. See the Request body section below for its fields.

### cURL

```bash
curl -X POST "{{BASE_URL}}/api/developer-portal/invitations" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "invitedIdentityUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'
```

### PowerShell

```powershell
$headers = @{
    'api-key' = '{{API_KEY}}'
}

$body = @'
{
  "invitedIdentityUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/developer-portal/invitations' `
    -Headers $headers -ContentType 'application/json' -Body $body
```

### TypeScript (SDK)

```bash
npm install @winkpg/winkpg-api
```

```typescript
import { Configuration, DeveloperPortalApi } from '@winkpg/winkpg-api';

const api = new DeveloperPortalApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.developerPortalIssue({
  "invitedIdentityUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
});
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/developer-portal/invitations', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "invitedIdentityUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }),
});

const data = await response.json();
```

### C# (SDK)

```bash
dotnet add package WinkPg.Api.Client
```

```csharp
using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new DeveloperPortalApi(config);
var body = JsonSerializer.Deserialize<DeveloperPortalInvitationCreateDto>("""
    {
      "invitedIdentityUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
    """);

var result = await api.DeveloperPortalIssueAsync(body);
```

### C# (raw HTTP)

```csharp
using System.Text;

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/developer-portal/invitations");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "invitedIdentityUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
    """, Encoding.UTF8, "application/json");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();
```

### Python (SDK)

```bash
pip install winkpg-api
```

```python
import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.DeveloperPortalApi(client)
    body = winkpg_api.DeveloperPortalInvitationCreateDto.from_dict({
      "invitedIdentityUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    })
    result = api.developer_portal_issue(body)
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "invitedIdentityUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/developer-portal/invitations",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()
```

## See also

- [All documentation](https://devportal-simpay-sbx.winkpg.io/llms.txt): the machine-readable index of every public page on this site.