mintInviteInstallHandoff

Public: no authentication required.

Mint a single-use INSTALL HANDOFF code for an invite. The portal /invite page passes it through the Play Store referrer (Android) or the clipboard (iOS) so the newly installed buyer app can claim the invite (mobileClaimInvite) with nothing typed. Never the invite token itself.

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 MintInviteInstallHandoff($input: MintInviteInstallHandoffInput!) {
  mintInviteInstallHandoff(input: $input)
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation MintInviteInstallHandoff($input: MintInviteInstallHandoffInput!) {\n  mintInviteInstallHandoff(input: $input)\n}",
  "variables": {
    "input": {
      "token": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "token": "string"
  }
}

Response:

{
  "data": {
    "mintInviteInstallHandoff": "string"
  }
}

mintInviteInstallHandoff(
  input: MintInviteInstallHandoffInput!
): String!

Arguments

mintInviteInstallHandoff.input ● MintInviteInstallHandoffInput! non-null input

The details of the invite install handoff to mint.

Type

String scalar

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.