# offer_friendship

Offers friendship to a resident.

```csharp
// See "LSL Helper Functions" page for this function
smartbotsAPI("offer_friendship", [
  "avatar", "f2c1f1d5-2f67-4de4-8d0e-8bcb9e5b1c6a",
  "message", "Let's connect!",
  "nosafehub", 1
]);
```

# Variables

The following table shows input values (you send them with the API call) and returned output values.

## Input basic parameters

| Variable | Required | Description |
|----------|----------|-------------|
| action   | yes      | = offer_friendship |
| apikey   | yes      | Your personal [developer's API key](/doc/developers-api-key-tw8bQj4LSJ) |
| botname  | yes      | Your bot's SL login |
| secret   | yes      | [Bot access code](https://www.mysmartbots.com/docs/Bot_access_code) of your bot |
| dataType | optional | Set to "json" to get JSON reply instead of URL-encoded string |
| custom   | optional | The custom data (string) to be passed back to caller script. This value will be returned back to the caller in HTTP response |

## Input

| Variable | Required | Description |
|----------|----------|-------------|
| avatar   | yes      | The UUID of the resident |
| message  | optional | Optional message to send |
| nosafehub | optional | Set to `1` to ignore the command if the bot is currently in a Linden Safe Hub (Welcome Area). Recommended for greeters and inviters. |

## Output

*(To be received in* `*http_response*` *LSL event, see* [*docs for details*](/doc/doing-http-api-calls-c6FSEMF7bP)*)*

| Variable | Description |
|----------|-------------|
| result   | OK - command completed successfully<br>FAIL - command failed |
| resulttext | Detailed reason for the failure |
| custom   | The value from input "custom" parameter. See above |