mobileClaimInvite

Public: no authentication required.

Claim an invite with an exact credential — the invite token (link opened in the app) or an install handoff code (Play referrer / iOS clipboard) — accepting it and returning a MOBILE session. Only accepts a PENDING invite; never a login for an existing account.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation MobileClaimInvite($input: MobileClaimInviteInput!) {
  mobileClaimInvite(input: $input) {
    accessToken
    isNewBuyer
    refreshToken
    userId
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation MobileClaimInvite($input: MobileClaimInviteInput!) {\n  mobileClaimInvite(input: $input) {\n    accessToken\n    isNewBuyer\n    refreshToken\n    userId\n  }\n}",
  "variables": {
    "input": {}
  }
}
EOF

Variables:

{
  "input": {}
}

Response:

{
  "data": {
    "mobileClaimInvite": {
      "accessToken": "string",
      "isNewBuyer": true,
      "refreshToken": "string",
      "userId": "id"
    }
  }
}

mobileClaimInvite(
  input: MobileClaimInviteInput!
): MobileAuthResponse!

Arguments

mobileClaimInvite.input ● MobileClaimInviteInput! non-null input

The details of the mobile claim invite request.

Type

MobileAuthResponse object

The result of a buyer sign in.