Redeem Invitation

post

Path parameters

idstringRequired

Body

application/jsontext/jsonapplication/*+json

codestringOptional

Responses

200

OK

application/json

idstringOptional

namestringOptional

revisioninteger · int32Optional

statusstring · enumOptionalPossible values:

configurationany · nullableOptional

400

Bad Request

application/json

404

Not Found

application/json

post

/public/v1/integration/installations/{id}/redeem

HTTPcURLJavaScriptPython

POST /public/v1/integration/installations/{id}/redeem HTTP/1.1
Host: api.s1.show
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "code": "text",
  "modules": [
    {
      "id": "text"
    }
  ]
}

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-03-31T02:25:40.119Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-03-31T02:25:40.119Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "invited": {
      "at": "2026-03-31T02:25:40.119Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "installed": {
      "at": "2026-03-31T02:25:40.119Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "expired": {
      "at": "2026-03-31T02:25:40.119Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "uninstalled": {
      "at": "2026-03-31T02:25:40.119Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "revision": 1,
  "account": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active"
  },
  "extension": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1
  },
  "status": "Invited",
  "configuration": null,
  "invitation": {
    "url": "text",
    "expiresAt": "2026-03-31T02:25:40.119Z",
    "message": "text",
    "externalId": "text",
    "validity": "7d"
  },
  "modules": [
    {
      "id": "text",
      "name": "text",
      "revision": 1,
      "description": "text",
      "filters": {
        "group.buyers": [
          "text"
        ]
      },
      "settings": {
        "configurable": true,
        "default": true,
        "paid": true,
        "type": [
          "text"
        ],
        "obsolete": true,
        "eligibility": {
          "multi": true,
          "single": true
        }
      }
    }
  ],
  "terms": [
    {
      "id": "text",
      "name": "text",
      "revision": 1,
      "accepted": "2026-03-31T02:25:40.119Z",
      "acceptedBy": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2026-03-31T02:25:40.119Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "updated": {
            "at": "2026-03-31T02:25:40.119Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    }
  ]
}