> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.kuudo.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.kuudo.com/_mcp/server.

# Create authorization invitation

POST https://app.kuudo.com/api/authorization-invitations
Content-Type: application/json

Development contract: availability requires the invitation feature release. API-key-derived JWT only; other OAuth bearers are rejected. Machine visibility is limited to the initiating M2M client. Creates a seven-day capability URL for downstream Amazon consent. Distribute it yourself; no email is sent. An eligible idempotent replay returns 200; changed bodies conflict. Terminal replay returns status without a URL. Creation does not grant provider token access. Maximum 20 requests/minute per organization/actor and 100 outstanding invitations.

Requires every scope: `authorization-invitations:write`.

Reference: https://docs.kuudo.com/api-reference/authorization-invitations/create-authorization-invitation

## Authentication

- `Authorization` header (bearer token, required) — JWT returned by POST /api/auth/token-exchange. Amazon, authorization invitations, and developer credentials require API-key-derived tokens.

## Request

### Headers

- `Idempotency-Key` (string, required) — Trimmed nonempty request key; reuse only with the identical body.

### Body (application/json)

This endpoint expects an InvitationCreate.

- `InvitationCreate`
  - `provider`: `amazon_ads` (amazon_ads)
    - `externalCustomerReference` (string, optional)
    - `options` (InvitationCreateOneOf0Options, optional)
  - `provider`: `amazon_sp_api` (amazon_sp_api)
    - `externalCustomerReference` (string, optional)
    - `options` (InvitationCreateOneOf1Options, optional)

## Response

### 200

Idempotent replay. Terminal replay omits authorizationUrl.

- `id` (string, required)
- `provider` (enum, required)
  - Allowed values: `amazon_ads`, `amazon_sp_api`
- `origin` (enum, required)
  - Allowed values: `invited`
- `externalCustomerReference` (string, required, nullable)
- `options` (InvitationCreateResultOptions, required)
- `status` (enum, required)
  - Allowed values: `pending`, `processing`, `completed`, `cancelled`, `expired`
- `authorizationId` (integer, required, nullable)
- `createdAt` (datetime, required)
- `expiresAt` (datetime, required)
- `completedAt` (datetime, required, nullable)
- `providerMetadata` (AmazonIdentity, optional)
- `authorizationUrl` (string, optional) — Secret capability URL, supplied only on eligible create/replay responses. Expires after seven days.

### 201

Success

- `id` (string, required)
- `provider` (enum, required)
  - Allowed values: `amazon_ads`, `amazon_sp_api`
- `origin` (enum, required)
  - Allowed values: `invited`
- `externalCustomerReference` (string, required, nullable)
- `options` (InvitationCreateResultOptions, required)
- `status` (enum, required)
  - Allowed values: `pending`, `processing`, `completed`, `cancelled`, `expired`
- `authorizationId` (integer, required, nullable)
- `createdAt` (datetime, required)
- `expiresAt` (datetime, required)
- `completedAt` (datetime, required, nullable)
- `providerMetadata` (AmazonIdentity, optional)
- `authorizationUrl` (string, optional) — Secret capability URL, supplied only on eligible create/replay responses. Expires after seven days.

## Errors

### 400 Bad Request Error

Invalid request or unsupported resource state.

- `error` (ErrorError, required)
- `code` (string, optional)
- `details` (any, optional) — Endpoint-specific validation or failure details; shape varies.
- `requiredScopes` (list of string, optional)
- `errorCode` (string, optional)
- `message` (string, optional)
- `remediation` (string, optional)

### 401 Unauthorized Error

Missing or invalid credentials, or inactive machine principal.

- `error` (ErrorError, required)
- `code` (string, optional)
- `details` (any, optional) — Endpoint-specific validation or failure details; shape varies.
- `requiredScopes` (list of string, optional)
- `errorCode` (string, optional)
- `message` (string, optional)
- `remediation` (string, optional)

### 403 Forbidden Error

Insufficient scope, authorization policy, or entitlement.

- `error` (ErrorError, required)
- `code` (string, optional)
- `details` (any, optional) — Endpoint-specific validation or failure details; shape varies.
- `requiredScopes` (list of string, optional)
- `errorCode` (string, optional)
- `message` (string, optional)
- `remediation` (string, optional)

### 409 Conflict Error

Conflicting state, duplicate resource, or idempotency conflict.

- `error` (ErrorError, required)
- `code` (string, optional)
- `details` (any, optional) — Endpoint-specific validation or failure details; shape varies.
- `requiredScopes` (list of string, optional)
- `errorCode` (string, optional)
- `message` (string, optional)
- `remediation` (string, optional)

### 429 Too Many Requests Error

Too many requests. Honor Retry-After where returned.

- `error` (ErrorError, required)
- `code` (string, optional)
- `details` (any, optional) — Endpoint-specific validation or failure details; shape varies.
- `requiredScopes` (list of string, optional)
- `errorCode` (string, optional)
- `message` (string, optional)
- `remediation` (string, optional)

### 503 Service Unavailable Error

Dependency unavailable or application maintenance.

- `error` (ErrorError, required)
- `code` (string, optional)
- `details` (any, optional) — Endpoint-specific validation or failure details; shape varies.
- `requiredScopes` (list of string, optional)
- `errorCode` (string, optional)
- `message` (string, optional)
- `remediation` (string, optional)

## Types

### InvitationCreateOneOf0Options

- `region` (enum, optional)
  - Allowed values: `na`, `eu`, `fe`

### InvitationCreateOneOf1Options

- `sellingPartnerType` (enum, optional)
  - Allowed values: `seller`, `vendor`
- `marketplace` (enum, optional)
  - Allowed values: `ca`, `us`, `mx`, `br`, `ie`, `es`, `uk`, `fr`, `be`, `nl`, `de`, `it`, `se`, `za`, `pl`, `eg`, `tr`, `sa`, `ae`, `in`, `au`, `jp`

### InvitationCreateResultOptions

- `region` (enum, optional)
  - Allowed values: `na`, `eu`, `fe`
- `sellingPartnerType` (enum, optional)
  - Allowed values: `seller`, `vendor`
- `marketplace` (enum, optional)
  - Allowed values: `ca`, `us`, `mx`, `br`, `ie`, `es`, `uk`, `fr`, `be`, `nl`, `de`, `it`, `se`, `za`, `pl`, `eg`, `tr`, `sa`, `ae`, `in`, `au`, `jp`

### AmazonIdentity

- `id` (string, required) — Canonical authorization ID; use this exact ID for token vending.
- `provider` (enum, required)
  - Allowed values: `amazon_ads`, `amazon_sp_api`
- `mode` (string, required)
- `status` (string, required)
- `account_summary` (AmazonIdentityAccountSummary, required)
- `created_at` (datetime, required)
- `updated_at` (datetime, required)
- `region` (string, optional, nullable)

### ErrorError

- string
- ErrorError1

### AmazonIdentityAccountSummary

- `display_name` (string, optional, nullable)
- `name` (string, optional, nullable)
- `email` (string, optional, nullable)
- `selling_partner_id` (string, optional, nullable)
- `selling_partner_type` (enum, optional, nullable)
  - Allowed values: `seller`, `vendor`
- `authorization_marketplace` (enum, optional, nullable)
  - Allowed values: `ca`, `us`, `mx`, `br`, `ie`, `es`, `uk`, `fr`, `be`, `nl`, `de`, `it`, `se`, `za`, `pl`, `eg`, `tr`, `sa`, `ae`, `in`, `au`, `jp`
- `amazon_user_id` (string, optional, nullable)
- `marketplaces` (list of map from string to any, optional)
- `profiles` (list of map from string to any, optional)

### ErrorError1

- `code` (string, required)
- `message` (string, required)

## Examples

### Authorization invitations_createAuthorizationInvitation_example

**Request**

```json
{
  "provider": "amazon_sp_api",
  "externalCustomerReference": "customer_example",
  "options": {
    "sellingPartnerType": "seller",
    "marketplace": "uk"
  }
}
```

**Response**

```json
{
  "id": "string",
  "provider": "amazon_ads",
  "origin": "invited",
  "externalCustomerReference": "string",
  "options": {
    "region": "na",
    "sellingPartnerType": "seller",
    "marketplace": "ca"
  },
  "status": "pending",
  "authorizationId": 1,
  "createdAt": "2024-01-15T09:30:00Z",
  "expiresAt": "2024-01-15T09:30:00Z",
  "completedAt": "2024-01-15T09:30:00Z",
  "providerMetadata": {
    "id": "string",
    "provider": "amazon_ads",
    "mode": "string",
    "status": "string",
    "account_summary": {
      "display_name": "string",
      "name": "string",
      "email": "string",
      "selling_partner_id": "string",
      "selling_partner_type": "seller",
      "authorization_marketplace": "ca",
      "amazon_user_id": "string",
      "marketplaces": [
        {}
      ],
      "profiles": [
        {}
      ]
    },
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:30:00Z",
    "region": "string"
  },
  "authorizationUrl": "string"
}
```

**SDK Code**

```python Authorization invitations_createAuthorizationInvitation_example
import requests

url = "https://app.kuudo.com/api/authorization-invitations"

payload = {
    "provider": "amazon_sp_api",
    "externalCustomerReference": "customer_example",
    "options": {
        "sellingPartnerType": "seller",
        "marketplace": "uk"
    }
}
headers = {
    "Idempotency-Key": "Idempotency-Key",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript Authorization invitations_createAuthorizationInvitation_example
const url = 'https://app.kuudo.com/api/authorization-invitations';
const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': 'Idempotency-Key',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"provider":"amazon_sp_api","externalCustomerReference":"customer_example","options":{"sellingPartnerType":"seller","marketplace":"uk"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Authorization invitations_createAuthorizationInvitation_example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.kuudo.com/api/authorization-invitations"

	payload := strings.NewReader("{\n  \"provider\": \"amazon_sp_api\",\n  \"externalCustomerReference\": \"customer_example\",\n  \"options\": {\n    \"sellingPartnerType\": \"seller\",\n    \"marketplace\": \"uk\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "Idempotency-Key")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Authorization invitations_createAuthorizationInvitation_example
require 'uri'
require 'net/http'

url = URI("https://app.kuudo.com/api/authorization-invitations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = 'Idempotency-Key'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"provider\": \"amazon_sp_api\",\n  \"externalCustomerReference\": \"customer_example\",\n  \"options\": {\n    \"sellingPartnerType\": \"seller\",\n    \"marketplace\": \"uk\"\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java Authorization invitations_createAuthorizationInvitation_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://app.kuudo.com/api/authorization-invitations")
  .header("Idempotency-Key", "Idempotency-Key")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"provider\": \"amazon_sp_api\",\n  \"externalCustomerReference\": \"customer_example\",\n  \"options\": {\n    \"sellingPartnerType\": \"seller\",\n    \"marketplace\": \"uk\"\n  }\n}")
  .asString();
```

```php Authorization invitations_createAuthorizationInvitation_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://app.kuudo.com/api/authorization-invitations', [
  'body' => '{
  "provider": "amazon_sp_api",
  "externalCustomerReference": "customer_example",
  "options": {
    "sellingPartnerType": "seller",
    "marketplace": "uk"
  }
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
    'Idempotency-Key' => 'Idempotency-Key',
  ],
]);

echo $response->getBody();
```

```csharp Authorization invitations_createAuthorizationInvitation_example
using RestSharp;

var client = new RestClient("https://app.kuudo.com/api/authorization-invitations");
var request = new RestRequest(Method.POST);
request.AddHeader("Idempotency-Key", "Idempotency-Key");
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"provider\": \"amazon_sp_api\",\n  \"externalCustomerReference\": \"customer_example\",\n  \"options\": {\n    \"sellingPartnerType\": \"seller\",\n    \"marketplace\": \"uk\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Authorization invitations_createAuthorizationInvitation_example
import Foundation

let headers = [
  "Idempotency-Key": "Idempotency-Key",
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "provider": "amazon_sp_api",
  "externalCustomerReference": "customer_example",
  "options": [
    "sellingPartnerType": "seller",
    "marketplace": "uk"
  ]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://app.kuudo.com/api/authorization-invitations")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Authorization invitations_createAuthorizationInvitation_example

**Request**

```json
{
  "provider": "amazon_sp_api",
  "externalCustomerReference": "customer_example",
  "options": {
    "sellingPartnerType": "seller",
    "marketplace": "uk"
  }
}
```

**Response**

```json
{
  "id": "string",
  "provider": "amazon_ads",
  "origin": "invited",
  "externalCustomerReference": "string",
  "options": {
    "region": "na",
    "sellingPartnerType": "seller",
    "marketplace": "ca"
  },
  "status": "pending",
  "authorizationId": 1,
  "createdAt": "2024-01-15T09:30:00Z",
  "expiresAt": "2024-01-15T09:30:00Z",
  "completedAt": "2024-01-15T09:30:00Z",
  "providerMetadata": {
    "id": "string",
    "provider": "amazon_ads",
    "mode": "string",
    "status": "string",
    "account_summary": {
      "display_name": "string",
      "name": "string",
      "email": "string",
      "selling_partner_id": "string",
      "selling_partner_type": "seller",
      "authorization_marketplace": "ca",
      "amazon_user_id": "string",
      "marketplaces": [
        {}
      ],
      "profiles": [
        {}
      ]
    },
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:30:00Z",
    "region": "string"
  },
  "authorizationUrl": "string"
}
```

**SDK Code**

```python Authorization invitations_createAuthorizationInvitation_example
import requests

url = "https://app.kuudo.com/api/authorization-invitations"

payload = {
    "provider": "amazon_sp_api",
    "externalCustomerReference": "customer_example",
    "options": {
        "sellingPartnerType": "seller",
        "marketplace": "uk"
    }
}
headers = {
    "Idempotency-Key": "Idempotency-Key",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript Authorization invitations_createAuthorizationInvitation_example
const url = 'https://app.kuudo.com/api/authorization-invitations';
const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': 'Idempotency-Key',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"provider":"amazon_sp_api","externalCustomerReference":"customer_example","options":{"sellingPartnerType":"seller","marketplace":"uk"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Authorization invitations_createAuthorizationInvitation_example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.kuudo.com/api/authorization-invitations"

	payload := strings.NewReader("{\n  \"provider\": \"amazon_sp_api\",\n  \"externalCustomerReference\": \"customer_example\",\n  \"options\": {\n    \"sellingPartnerType\": \"seller\",\n    \"marketplace\": \"uk\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "Idempotency-Key")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Authorization invitations_createAuthorizationInvitation_example
require 'uri'
require 'net/http'

url = URI("https://app.kuudo.com/api/authorization-invitations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = 'Idempotency-Key'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"provider\": \"amazon_sp_api\",\n  \"externalCustomerReference\": \"customer_example\",\n  \"options\": {\n    \"sellingPartnerType\": \"seller\",\n    \"marketplace\": \"uk\"\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java Authorization invitations_createAuthorizationInvitation_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://app.kuudo.com/api/authorization-invitations")
  .header("Idempotency-Key", "Idempotency-Key")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"provider\": \"amazon_sp_api\",\n  \"externalCustomerReference\": \"customer_example\",\n  \"options\": {\n    \"sellingPartnerType\": \"seller\",\n    \"marketplace\": \"uk\"\n  }\n}")
  .asString();
```

```php Authorization invitations_createAuthorizationInvitation_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://app.kuudo.com/api/authorization-invitations', [
  'body' => '{
  "provider": "amazon_sp_api",
  "externalCustomerReference": "customer_example",
  "options": {
    "sellingPartnerType": "seller",
    "marketplace": "uk"
  }
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
    'Idempotency-Key' => 'Idempotency-Key',
  ],
]);

echo $response->getBody();
```

```csharp Authorization invitations_createAuthorizationInvitation_example
using RestSharp;

var client = new RestClient("https://app.kuudo.com/api/authorization-invitations");
var request = new RestRequest(Method.POST);
request.AddHeader("Idempotency-Key", "Idempotency-Key");
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"provider\": \"amazon_sp_api\",\n  \"externalCustomerReference\": \"customer_example\",\n  \"options\": {\n    \"sellingPartnerType\": \"seller\",\n    \"marketplace\": \"uk\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Authorization invitations_createAuthorizationInvitation_example
import Foundation

let headers = [
  "Idempotency-Key": "Idempotency-Key",
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "provider": "amazon_sp_api",
  "externalCustomerReference": "customer_example",
  "options": [
    "sellingPartnerType": "seller",
    "marketplace": "uk"
  ]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://app.kuudo.com/api/authorization-invitations")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```