Skip to main content

createInviteUser

create an invite for user

createInviteUser(
input: CreateInviteUserInput!
): CreateInviteUserPayload

Arguments​

createInviteUser.input ● CreateInviteUserInput! non-null input​

Parameters for CreateInviteUser

Type​

CreateInviteUserPayload object​

Autogenerated return type of CreateInviteUser.

Example request

This generated mutation uses placeholders for required values. Replace them with values available to your API key before running it.

Before you run it

Run the companies query first and use data.companies.collection[].id as companyId.

curl --request POST https://api.convisoappsec.com/graphql \
--header "x-api-key: $CONVISO_API_KEY" \
--header "content-type: application/json" \
--data '{"query":"mutation MutateCreateInviteUser($input: CreateInviteUserInput!) {\n createInviteUser(input: $input) { clientMutationId msg }\n}","variables":{"input":{"companyId":"<company_id>","emails":["example"],"accesses":{}}}}'

Contribute to the Docs

Found something outdated or missing? Help us improve the documentation with a quick suggestion or edit.

How to contribute