> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.sailorhq.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.sailorhq.io/_mcp/server.

# Create a staff invitation

POST https://api.sailorhq.io/staff/invites
Content-Type: application/json

Creates or renews one Sailor staff invitation pinned to the credential's workspace. Organization and subaccount identifiers are derived server-side and cannot be supplied by the caller.

Reference: https://docs.sailorhq.io/api-reference/staff/create-staff-invite

## Authentication

- `Authorization` header (bearer token, required) — Workspace API key created in Sailor Settings > Integrations > API access.

## Request

### Headers

- `Idempotency-Key` (string, required) — Unique retry key retained for 86400 seconds. Reusing it with different request data is rejected.

### Body (application/json)

This endpoint expects an object.

- `email` (string, required)
- `role` (enum, required)
  - Allowed values: `admin`, `agent`
- `team_ids` (list of string, optional)

## Response

### 201

The tenant-pinned Sailor staff invitation is ready.

- `ok` (true, required)
- `staff_invite` (StaffInvitesPostResponsesContentApplicationJsonSchemaStaffInvite, required)

## Errors

### 400 Bad Request Error

The request body is invalid.

- `type` (string, required)
- `title` (string, required)
- `status` (integer, required)
- `code` (enum, required)
  - Allowed values: `unauthorized`, `insufficient_scope`, `invalid_request`, `payload_too_large`, `unsupported_media_type`, `feature_not_available`, `resource_not_found`, `resource_conflict`, `integration_not_connected`, `integration_reauthorization_required`, `missing_idempotency_key`, `request_in_progress`, `idempotency_key_reused`, `rate_limit_exceeded`, `temporarily_unavailable`
- `request_id` (string, required)
- `detail` (string, required)

### 401 Unauthorized Error

Authentication failed.

- `type` (string, required)
- `title` (string, required)
- `status` (integer, required)
- `code` (enum, required)
  - Allowed values: `unauthorized`, `insufficient_scope`, `invalid_request`, `payload_too_large`, `unsupported_media_type`, `feature_not_available`, `resource_not_found`, `resource_conflict`, `integration_not_connected`, `integration_reauthorization_required`, `missing_idempotency_key`, `request_in_progress`, `idempotency_key_reused`, `rate_limit_exceeded`, `temporarily_unavailable`
- `request_id` (string, required)
- `detail` (string, required)

### 403 Forbidden Error

The credential lacks the required scope.

- `type` (string, required)
- `title` (string, required)
- `status` (integer, required)
- `code` (enum, required)
  - Allowed values: `unauthorized`, `insufficient_scope`, `invalid_request`, `payload_too_large`, `unsupported_media_type`, `feature_not_available`, `resource_not_found`, `resource_conflict`, `integration_not_connected`, `integration_reauthorization_required`, `missing_idempotency_key`, `request_in_progress`, `idempotency_key_reused`, `rate_limit_exceeded`, `temporarily_unavailable`
- `request_id` (string, required)
- `detail` (string, required)

### 409 Conflict Error

The invitation conflicts with an existing member or pending invitation.

- `type` (string, required)
- `title` (string, required)
- `status` (integer, required)
- `code` (enum, required)
  - Allowed values: `unauthorized`, `insufficient_scope`, `invalid_request`, `payload_too_large`, `unsupported_media_type`, `feature_not_available`, `resource_not_found`, `resource_conflict`, `integration_not_connected`, `integration_reauthorization_required`, `missing_idempotency_key`, `request_in_progress`, `idempotency_key_reused`, `rate_limit_exceeded`, `temporarily_unavailable`
- `request_id` (string, required)
- `detail` (string, required)

### 413 Content Too Large Error

The request body exceeds 64 KiB.

- `type` (string, required)
- `title` (string, required)
- `status` (integer, required)
- `code` (enum, required)
  - Allowed values: `unauthorized`, `insufficient_scope`, `invalid_request`, `payload_too_large`, `unsupported_media_type`, `feature_not_available`, `resource_not_found`, `resource_conflict`, `integration_not_connected`, `integration_reauthorization_required`, `missing_idempotency_key`, `request_in_progress`, `idempotency_key_reused`, `rate_limit_exceeded`, `temporarily_unavailable`
- `request_id` (string, required)
- `detail` (string, required)

### 415 Unsupported Media Type Error

Send an uncompressed application/json request.

- `type` (string, required)
- `title` (string, required)
- `status` (integer, required)
- `code` (enum, required)
  - Allowed values: `unauthorized`, `insufficient_scope`, `invalid_request`, `payload_too_large`, `unsupported_media_type`, `feature_not_available`, `resource_not_found`, `resource_conflict`, `integration_not_connected`, `integration_reauthorization_required`, `missing_idempotency_key`, `request_in_progress`, `idempotency_key_reused`, `rate_limit_exceeded`, `temporarily_unavailable`
- `request_id` (string, required)
- `detail` (string, required)

### 422 Unprocessable Entity Error

The idempotency key was already used with different request data.

- `type` (string, required)
- `title` (string, required)
- `status` (integer, required)
- `code` (enum, required)
  - Allowed values: `unauthorized`, `insufficient_scope`, `invalid_request`, `payload_too_large`, `unsupported_media_type`, `feature_not_available`, `resource_not_found`, `resource_conflict`, `integration_not_connected`, `integration_reauthorization_required`, `missing_idempotency_key`, `request_in_progress`, `idempotency_key_reused`, `rate_limit_exceeded`, `temporarily_unavailable`
- `request_id` (string, required)
- `detail` (string, required)

### 429 Too Many Requests Error

Rate limit exceeded.

- `type` (string, required)
- `title` (string, required)
- `status` (integer, required)
- `code` (enum, required)
  - Allowed values: `unauthorized`, `insufficient_scope`, `invalid_request`, `payload_too_large`, `unsupported_media_type`, `feature_not_available`, `resource_not_found`, `resource_conflict`, `integration_not_connected`, `integration_reauthorization_required`, `missing_idempotency_key`, `request_in_progress`, `idempotency_key_reused`, `rate_limit_exceeded`, `temporarily_unavailable`
- `request_id` (string, required)
- `detail` (string, required)

### 503 Service Unavailable Error

The API is temporarily unavailable.

- `type` (string, required)
- `title` (string, required)
- `status` (integer, required)
- `code` (enum, required)
  - Allowed values: `unauthorized`, `insufficient_scope`, `invalid_request`, `payload_too_large`, `unsupported_media_type`, `feature_not_available`, `resource_not_found`, `resource_conflict`, `integration_not_connected`, `integration_reauthorization_required`, `missing_idempotency_key`, `request_in_progress`, `idempotency_key_reused`, `rate_limit_exceeded`, `temporarily_unavailable`
- `request_id` (string, required)
- `detail` (string, required)

## Types

### StaffInvitesPostResponsesContentApplicationJsonSchemaStaffInvite

- `id` (string, required)
- `email` (string, required)
- `role` (enum, required)
  - Allowed values: `admin`, `agent`
- `subaccount_id` (string, required)
- `team_ids` (list of string, required)
- `status` (StaffInvitesPostResponsesContentApplicationJsonSchemaStaffInviteStatus, required)
- `expires_at` (datetime, required)

### StaffInvitesPostResponsesContentApplicationJsonSchemaStaffInviteStatus

- "email_sent"
- "email_delivery_failed"

## Examples

**Request**

```json
{
  "email": "agent@example.com",
  "role": "agent",
  "team_ids": [
    "00000000-0000-4000-8000-000000000012"
  ]
}
```

**Response**

```json
{
  "ok": true,
  "staff_invite": {
    "id": "00000000-0000-4000-8000-000000000010",
    "email": "agent@example.com",
    "role": "agent",
    "subaccount_id": "00000000-0000-4000-8000-000000000011",
    "team_ids": [
      "00000000-0000-4000-8000-000000000012"
    ],
    "status": "email_sent",
    "expires_at": "2026-08-18T00:00:00.000Z"
  }
}
```

**SDK Code**

```python Staff_createStaffInvite_example
import requests

url = "https://api.sailorhq.io/staff/invites"

payload = {
    "email": "agent@example.com",
    "role": "agent",
    "team_ids": ["00000000-0000-4000-8000-000000000012"]
}
headers = {
    "Idempotency-Key": "Idempotency-Key",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Staff_createStaffInvite_example
const url = 'https://api.sailorhq.io/staff/invites';
const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': 'Idempotency-Key',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"email":"agent@example.com","role":"agent","team_ids":["00000000-0000-4000-8000-000000000012"]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Staff_createStaffInvite_example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sailorhq.io/staff/invites"

	payload := strings.NewReader("{\n  \"email\": \"agent@example.com\",\n  \"role\": \"agent\",\n  \"team_ids\": [\n    \"00000000-0000-4000-8000-000000000012\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "Idempotency-Key")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Staff_createStaffInvite_example
require 'uri'
require 'net/http'

url = URI("https://api.sailorhq.io/staff/invites")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = 'Idempotency-Key'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"agent@example.com\",\n  \"role\": \"agent\",\n  \"team_ids\": [\n    \"00000000-0000-4000-8000-000000000012\"\n  ]\n}"

response = http.request(request)
puts response.read_body
```

```java Staff_createStaffInvite_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.sailorhq.io/staff/invites")
  .header("Idempotency-Key", "Idempotency-Key")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"agent@example.com\",\n  \"role\": \"agent\",\n  \"team_ids\": [\n    \"00000000-0000-4000-8000-000000000012\"\n  ]\n}")
  .asString();
```

```php Staff_createStaffInvite_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.sailorhq.io/staff/invites', [
  'body' => '{
  "email": "agent@example.com",
  "role": "agent",
  "team_ids": [
    "00000000-0000-4000-8000-000000000012"
  ]
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
    'Idempotency-Key' => 'Idempotency-Key',
  ],
]);

echo $response->getBody();
```

```csharp Staff_createStaffInvite_example
using RestSharp;

var client = new RestClient("https://api.sailorhq.io/staff/invites");
var request = new RestRequest(Method.POST);
request.AddHeader("Idempotency-Key", "Idempotency-Key");
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"email\": \"agent@example.com\",\n  \"role\": \"agent\",\n  \"team_ids\": [\n    \"00000000-0000-4000-8000-000000000012\"\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Staff_createStaffInvite_example
import Foundation

let headers = [
  "Idempotency-Key": "Idempotency-Key",
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "email": "agent@example.com",
  "role": "agent",
  "team_ids": ["00000000-0000-4000-8000-000000000012"]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.sailorhq.io/staff/invites")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```