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

POST /api/developer-portal/invitations deprecated

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

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.

Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.

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 PowerShell TypeScript C# Python

cURL

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

$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

npm install @winkpg/winkpg-api

TypeScript (SDK)

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)

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();

dotnet add package WinkPg.Api.Client

C# (SDK)

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)

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();

pip install winkpg-api

Python (SDK)

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)

pip install requests

Python (raw HTTP)

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()

Parameters

Name	In	Type	Description
`suppressNulls` required	query	boolean	If true, omit properties with null values.
`X-Acting-Merchant-Id` required	header	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

application/json , required

Field	Type	Description
`invitedIdentityUserId` required	string (uuid)	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` required	string	Where to send the invitation. Blank sends it to the invited user's own registered address. nullablemax length 256
`role` required	all of DeveloperPortalRole	The portal capability a redemption will grant.

This request body has no documented fields.