# 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. Requires API key scope: `admin` 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`](https://devportal.demo.winkpg.io/docs/api/models/DeveloperPortalInvitationCreateDto.md) 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. (nullable, max length 256) - `role` ([DeveloperPortalRole](https://devportal.demo.winkpg.io/docs/api/models/DeveloperPortalRole.md)): The portal capability a redemption will grant. Values: - `Admin`: Full portal access: reads everything the read-only role does and additionally manages the merchant's portal configuration. - `ReadOnly`: Read-only portal access. **Content type:** `text/json` Schema: [`DeveloperPortalInvitationCreateDto`](https://devportal.demo.winkpg.io/docs/api/models/DeveloperPortalInvitationCreateDto.md) 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. (nullable, max length 256) - `role` ([DeveloperPortalRole](https://devportal.demo.winkpg.io/docs/api/models/DeveloperPortalRole.md)): The portal capability a redemption will grant. Values: - `Admin`: Full portal access: reads everything the read-only role does and additionally manages the merchant's portal configuration. - `ReadOnly`: Read-only portal access. **Content type:** `application/*+json` Schema: [`DeveloperPortalInvitationCreateDto`](https://devportal.demo.winkpg.io/docs/api/models/DeveloperPortalInvitationCreateDto.md) 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. (nullable, max length 256) - `role` ([DeveloperPortalRole](https://devportal.demo.winkpg.io/docs/api/models/DeveloperPortalRole.md)): The portal capability a redemption will grant. Values: - `Admin`: Full portal access: reads everything the read-only role does and additionally manages the merchant's portal configuration. - `ReadOnly`: Read-only portal access. ## Responses ### 200 OK **Content type:** `application/json` Schema: [`DeveloperPortalInvitationDto`](https://devportal.demo.winkpg.io/docs/api/models/DeveloperPortalInvitationDto.md) 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. (nullable) - `lastModificationTime` (string(date-time)): The date and time when this entity was last modified. (nullable) - `lastModifierId` (string(uuid)): The ID of the user who last modified this entity. (nullable) - `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. (nullable) - `deletionTime` (string(date-time)): The date and time when this entity was deleted, if it is deleted. (nullable) - `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. (nullable) - `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. (nullable) - `email` (string): The address the invitation was emailed to. (nullable) - `invitedIdentityUserId` (string(uuid)): The identity user the invitation is for, and the only one who can redeem it. (nullable) - `role` ([DeveloperPortalRole](https://devportal.demo.winkpg.io/docs/api/models/DeveloperPortalRole.md)): The portal capability a redemption will grant. (nullable) Values: - `Admin`: Full portal access: reads everything the read-only role does and additionally manages the merchant's portal configuration. - `ReadOnly`: Read-only portal access. - `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. (nullable) - `status` ([DeveloperPortalInvitationStatus](https://devportal.demo.winkpg.io/docs/api/models/DeveloperPortalInvitationStatus.md)): The lifecycle state, already resolved against the clock by the reader. (nullable) Values: - `Pending`: Issued, not yet redeemed, and not yet past its expiry. - `Redeemed`: Redeemed. The developer account it created exists. - `Expired`: Past its expiry without having been redeemed. - `Revoked`: Withdrawn by an operator before it was redeemed. - `issuedByUserId` (string(uuid)): The back-office user who issued the invitation. (nullable) - `redeemedAt` (string(date-time)): When the invitation was redeemed, in UTC, or `null` if it never was. (nullable) - `revokedAt` (string(date-time)): When the invitation was revoked, in UTC, or `null` if it never was. (nullable) - `concurrencyStamp` (string): Optimistic-concurrency token. (nullable) - `user` ([DeveloperPortalUserSummaryDto](https://devportal.demo.winkpg.io/docs/api/models/DeveloperPortalUserSummaryDto.md)): 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. Fields: - `id` (string(uuid)) - `userName` (string): The user's sign-in name. (nullable) - `email` (string): The user's email address. (nullable) - `hasBackOfficeRole` (boolean): Whether the user already holds a back-office role, i.e. one carrying a `RoleType` and therefore sitting on the Admin > Reseller > Merchant ladder. The two portal-only roles deliberately carry no `RoleType`, so a developer who has never been given a gateway account reads as `false` here. (nullable) - `displayName` (string): The label to show for this user: the sign-in name where there is one, the email otherwise, and the bare id as a last resort so a row never renders blank. (nullable, read only) ### 403 Forbidden **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 401 Unauthorized **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 400 Bad Request **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Request failed validation_ One or more fields were rejected before any rule ran. error.code is null on the envelope and the causes are in validationErrors, one entry per failure. An entry carries code when the validator declared a publishable one, and memberPaths when the full path says more than members does (an element inside a collection, for example). Both keys are omitted when they would add nothing. ```json { "error": { "code": "null", "message": "Your request is not valid!", "details": "The following errors were detected during validation.", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": [ { "message": "'Amount' must be greater than 0.", "members": [ "amount" ] }, { "message": "The card has expired.", "members": [ "expirationDate" ], "code": "CardData:CardExpired" }, { "message": "'Value' must not be empty.", "members": [ "value" ], "memberPaths": [ "customFields[2].value" ] } ] } } ``` ### 404 Not Found **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Resource not found_ The id in the path names no record the caller can see. Most resources answer with a null error.code and a message naming the resource type and the id; a resource that publishes a not-found code in the catalog above carries it in error.code instead, so check for one before matching on the message. ```json { "error": { "code": "null", "message": "There is no entity Transaction with id = 7d1f3a52-0c4e-4b8a-9e21-5a6b7c8d9e00!", "details": "null", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": "null" } } ``` ### 501 Not Implemented **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 500 Internal Server Error **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 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. The [error reference](https://devportal.demo.winkpg.io/docs/errors.md) lists the values `error.code` can take. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Business rule refused the request_ The request was understood and rejected by a platform rule. This is the shape that carries a code from the catalog above, so branch on error.code rather than on the message text. The HTTP status is the one listed against the code. ```json { "error": { "code": "Transactions:OperationNotAllowed", "message": "The operation 'Void' is not allowed on a Sale transaction with result 'Approved' and settlement state 'Settled'.", "details": "null", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": "null" } } ``` ### 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`](https://devportal.demo.winkpg.io/docs/api/models/RateLimitProblemDetails.md) 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. (nullable) - `title` (string) required: A short, human-readable summary of the problem type. (nullable) - `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. (nullable) - `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`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ## 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(""" { "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.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.