---
title: "API_SendInvitation"
slug: "api-sendinvitation"
updated: 2025-08-18T09:32:43Z
published: 2025-08-18T09:32:43Z
canonical: "help.quickbase.com/api-sendinvitation"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://help.quickbase.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API_SendInvitation

**Don't forget to check out our** [**JSON RESTful APIs**](https://developer.quickbase.com/)**, they can help you utilize and extend Quickbase with ease.**

## Overview

Use API_SendInvitation to send an email invitation to your application. You can send an email invitation to either an existing Quickbase user that you have granted application access to via API_AddUserToRole, or to a new Quickbase user that you have created via API_ProvisionUser.

## Request parameters

| Parameter | Value | Required? |
| --- | --- | --- |
| userid | The ID of the Quickbase user you are inviting to your application. | yes |
| usertext | The message you want to display in your email invitation. | no |
| ticket | A valid authentication ticket. The authentication ticket is returned via the API_Authenticate call. | yes, one of: - ticket - username/password - user token |
| usertoken | The user token is an alternative means of authentication, used for API access. User tokens cannot be used to access the Quickbase UI. | yes, one of: - ticket - username/password - user token |
| apptoken | A valid application token. | yes, if the application requires application tokens |
| udata | A string value that you want returned. It will not be handled by Quickbase but it will be returned in the response. | no |

## Response values

| Element Name | Value |
| --- | --- |
| action | Echoes the originating request, for example, API_SendInvitation. |
| errcode | Identifies the error code, if any. (See the [Error Codes appendix](/v1/docs/error-codes) for a list of possible error codes.) 0 indicates that no error was encountered. |
| errtext | Text that explains the error code. "No error" indicates that no error was encountered. |
| udata | Optional. Contains any udata value supplied in the request. |

## Sample XML Request

```xml
POST https://target_domain/db/target_dbid 
 HTTP/1.0
Content-Type: application/xml
Content-Length:
QUICKBASE-ACTION: API_SendInvitation

<qdbapi>
   <ticket>auth_ticket</ticket>
   <apptoken>app_token</apptoken>
   <userid>112249.ctdg</userid>
   <usertext>Welcome!</usertext>
</qdbapi>
```

## URL alternative

```plaintext
https://target_domain/db/target_dbid?a=API_SendInvitation&userid=112249.
ctdg&ticket=auth_ticket&apptoken=app_token&usertext=Hello
```

where *target_domain* is the domain against which you are invoking this call, for example, *quickbase.com*. [Read about this notation](/v1/docs/understanding-the-api-call-reference).

## Sample response

```xml
<?xml version="1.0" ?>
<qdbapi>
   <action>API_SendInvitation</action>
   <errcode>0</errcode>
   <errtext>No error</errtext>
</qdbapi>
```