# offerFriendship

Offers friendship to a resident.

```javascript
Bot.offerFriendship(avatar, message);
```

```snippet playground-input-2k8u0pPON3
`avatar`  | yes      | The UUID of the resident.
`message` | optional | Optional message to send with the friendship offer.
```

## Output

Function returns a Promise with the following data:

| Variable | Type | Description |
|----------|------|-------------|
| `success` | bool | True if command completed successfully |
| `error`  | string | Error string if command has failed |