Create authorization invitation | Kuudo API Documentation

curl -X POST https://app.kuudo.com/api/authorization-invitations \
     -H "Idempotency-Key: Idempotency-Key" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "provider": "amazon_sp_api",
  "externalCustomerReference": "customer_example",
  "options": {
    "sellingPartnerType": "seller",
    "marketplace": "uk"
  }
}'

{
  "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"
}

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.

Authentication

AuthorizationBearer

JWT returned by POST /api/auth/token-exchange. Amazon and authorization invitations require API-key-derived tokens.

Request

This endpoint expects an object.

amazon_adsobjectRequired

amazon_sp_apiobjectRequired

Response

Idempotent replay. Terminal replay omits authorizationUrl.

idstring

providerenum

originenum

externalCustomerReferencestring or null

optionsobject

statusenum

authorizationIdinteger or null

createdAtdatetime

expiresAtdatetime

completedAtdatetime or null

providerMetadataobjectOptional

authorizationUrlstringOptionalformat: "uri"

Secret capability URL, supplied only on eligible create/replay responses. Expires after seven days.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

429

Too Many Requests Error

503

Service Unavailable Error

Authentication

Headers

Request

Response

Errors