# pub.chive.claiming.requestCoauthorship

> Published by [chive.pub](https://lexicon.garden/identity/did:plc:7natp5xae72bddaqlkef2t4e)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.claiming.requestCoauthorship)
- [Documentation](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.claiming.requestCoauthorship/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.claiming.requestCoauthorship/examples)

## Definitions

### `pub.chive.claiming.requestCoauthorship`

**Type**: `procedure`

Request co-authorship on an existing eprint in another user's PDS

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `message` | `string` | No | Optional message to PDS owner |
| `eprintUri` | `string` (at-uri) | Yes | AT-URI of the eprint record |
| `authorName` | `string` | Yes | Name of the author entry being claimed |
| `authorIndex` | `integer` | Yes | Index of the author entry being claimed (0-based) |
| `claimantName` | `string` | Yes | Display name for the request |
| `eprintOwnerDid` | `string` (did) | Yes | DID of the PDS owner |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `request` | `ref` → `#coauthorRequest` | Yes |  |

#### Errors

- **AuthenticationRequired**
- **NotFound**
- **InvalidRequest**

### `pub.chive.claiming.requestCoauthorship#coauthorRequest`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `id` | `integer` | Yes | Request ID |
| `status` | `string` | Yes | Request status |
| `message` | `string` | No | Message from claimant |
| `createdAt` | `string` (datetime) | Yes | When the request was created |
| `eprintUri` | `string` (at-uri) | Yes | AT-URI of the eprint record |
| `authorName` | `string` | Yes | Name of the author entry being claimed |
| `reviewedAt` | `string` (datetime) | No | When the request was reviewed |
| `authorIndex` | `integer` | Yes | Index of the author entry being claimed (0-based) |
| `claimantDid` | `string` (did) | Yes | DID of the claimant |
| `claimantName` | `string` | Yes | Display name at time of request |
| `eprintOwnerDid` | `string` (did) | Yes | DID of the PDS owner |
| `rejectionReason` | `string` | No | Rejection reason if rejected |

## Raw Schema

```json
{
  "id": "pub.chive.claiming.requestCoauthorship",
  "defs": {
    "main": {
      "type": "procedure",
      "input": {
        "schema": {
          "type": "object",
          "required": [
            "eprintUri",
            "eprintOwnerDid",
            "claimantName",
            "authorIndex",
            "authorName"
          ],
          "properties": {
            "message": {
              "type": "string",
              "maxLength": 1000,
              "description": "Optional message to PDS owner"
            },
            "eprintUri": {
              "type": "string",
              "format": "at-uri",
              "description": "AT-URI of the eprint record"
            },
            "authorName": {
              "type": "string",
              "maxLength": 200,
              "minLength": 1,
              "description": "Name of the author entry being claimed"
            },
            "authorIndex": {
              "type": "integer",
              "minimum": 0,
              "description": "Index of the author entry being claimed (0-based)"
            },
            "claimantName": {
              "type": "string",
              "maxLength": 200,
              "minLength": 1,
              "description": "Display name for the request"
            },
            "eprintOwnerDid": {
              "type": "string",
              "format": "did",
              "description": "DID of the PDS owner"
            }
          }
        },
        "encoding": "application/json"
      },
      "errors": [
        {
          "name": "AuthenticationRequired"
        },
        {
          "name": "NotFound"
        },
        {
          "name": "InvalidRequest"
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "request"
          ],
          "properties": {
            "request": {
              "ref": "#coauthorRequest",
              "type": "ref"
            }
          }
        },
        "encoding": "application/json"
      },
      "description": "Request co-authorship on an existing eprint in another user's PDS"
    },
    "coauthorRequest": {
      "type": "object",
      "required": [
        "id",
        "eprintUri",
        "eprintOwnerDid",
        "claimantDid",
        "claimantName",
        "authorIndex",
        "authorName",
        "status",
        "createdAt"
      ],
      "properties": {
        "id": {
          "type": "integer",
          "description": "Request ID"
        },
        "status": {
          "type": "string",
          "description": "Request status",
          "knownValues": [
            "pending",
            "approved",
            "rejected"
          ]
        },
        "message": {
          "type": "string",
          "description": "Message from claimant"
        },
        "createdAt": {
          "type": "string",
          "format": "datetime",
          "description": "When the request was created"
        },
        "eprintUri": {
          "type": "string",
          "format": "at-uri",
          "description": "AT-URI of the eprint record"
        },
        "authorName": {
          "type": "string",
          "description": "Name of the author entry being claimed"
        },
        "reviewedAt": {
          "type": "string",
          "format": "datetime",
          "description": "When the request was reviewed"
        },
        "authorIndex": {
          "type": "integer",
          "description": "Index of the author entry being claimed (0-based)"
        },
        "claimantDid": {
          "type": "string",
          "format": "did",
          "description": "DID of the claimant"
        },
        "claimantName": {
          "type": "string",
          "description": "Display name at time of request"
        },
        "eprintOwnerDid": {
          "type": "string",
          "format": "did",
          "description": "DID of the PDS owner"
        },
        "rejectionReason": {
          "type": "string",
          "description": "Rejection reason if rejected"
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "revision": 1
}
```