# Invite Club creators to a campaign

`POST https://api.tryscouty.com/v1/campaigns/{campaignId}/invites`

Invites up to 10 Club creators, picked from scouty_browse_club, to one live campaign. Scouty messages each one once, in its own words, and they apply or pass; an invited creator who applies is accepted and goes to signing. Each invite that is sent uses one of the workspace's monthly invites, and a message cannot be taken back. Each creator is answered on its own: invited, or refused with a reason. invitesLeft is what the month has left.

- Scope: `creators:manage`
- Kind: write
- Safe to retry with the same idempotency key: no
- MCP tool: `scouty_invite_creators`

## Authorization

Send `Authorization: Bearer $SCOUTY_TOKEN`. The token needs the `creators:manage` scope.

## Path parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `campaignId` | `integer` | Required | The live campaign. |

## Headers

| Name | Type | Required | Description |
|---|---|---|---|
| `Idempotency-Key` | `string` | Optional | The same key the body's idempotencyKey carries. Send one or the other, or both with the same value. |

## Body parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `idempotencyKey` | `string` | Required | A key you choose for this call, 8 to 128 characters of letters, digits, dot, underscore, colon or hyphen. Sending the same key with the same arguments replays the first answer and changes nothing, so a retry after a timeout is safe. |
| `memberIds` | `integer[]` | Required | The creators to invite, by the memberId scouty_browse_club reports. 1 to 10. |

## Request

### cURL

```bash
curl -s -X POST https://api.tryscouty.com/v1/campaigns/42/invites \
  -H "Authorization: Bearer $SCOUTY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"idempotencyKey":"invite-42-1","memberIds":[7]}'
```

### JavaScript

```js
const response = await fetch("https://api.tryscouty.com/v1/campaigns/42/invites", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SCOUTY_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    idempotencyKey: "invite-42-1",
    memberIds: [
      7
    ]
  }),
});
console.log(await response.json());
```

### Python

```python
import os

import requests

token = os.environ["SCOUTY_TOKEN"]
response = requests.post(
    "https://api.tryscouty.com/v1/campaigns/42/invites",
    headers={"Authorization": f"Bearer {token}"},
    json={
        "idempotencyKey": "invite-42-1",
        "memberIds": [7],
    },
)
print(response.json())
```

## Responses

### 200 OK

```json
{
  "invited": [
    {
      "memberId": 7,
      "displayName": "Sample C."
    }
  ],
  "refused": [],
  "invitesLeft": 6
}
```

### 400 Bad Request

```json
{
  "error": {
    "code": "invalid_request",
    "message": "Those arguments are not the shape this capability takes: idempotencyKey."
  }
}
```

### 401 Unauthorized

```json
{
  "error": {
    "code": "missing_token",
    "message": "This API needs an Authorization header carrying a bearer token."
  }
}
```

### 403 Forbidden

```json
{
  "error": {
    "code": "insufficient_scope",
    "message": "This token does not carry the creators:manage scope. Ask the team for one that does."
  }
}
```

### 404 Not Found

```json
{
  "error": {
    "code": "not_found",
    "message": "No such campaign."
  }
}
```

### 409 Conflict

```json
{
  "error": {
    "code": "idempotency_conflict",
    "message": "That idempotency key was already used for a different request. Use a new key."
  }
}
```

### 429 Too Many Requests

```json
{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please wait for the current minute to end."
  }
}
```

## Errors

| Status | `error.code` | Meaning |
|---|---|---|
| 400 Bad Request | `invalid_request` | The request was not the shape this capability takes, or its body was not JSON. |
| 401 Unauthorized | `missing_token`, `invalid_token`, `token_revoked`, `token_expired`, `token_orphaned` | No token, or one that is not recognized, revoked or expired. |
| 403 Forbidden | `insufficient_scope`, `wrong_principal` | The token does not carry the scope this capability needs. |
| 404 Not Found | `not_found` | No such route, or no such campaign for this client. |
| 409 Conflict | `idempotency_conflict` | That idempotency key was already used for a different request. Nothing was changed. |
| 429 Too Many Requests | `rate_limited` | Too many requests this minute. Retry-After says how long is left. |

Full reference: https://docs.tryscouty.com/reference