> ## Documentation Index
> Fetch the complete documentation index at: https://docs.repdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Recipient list recipient

> # Description

Create a recipient where `recipientListId` is the id of the recipient list that the recipient will be added. 

# Body

```json
{
    "phone": string,
    "email": string,
    "recipientListId": string,
    "isUnsubscribed": boolean,
    "values": object,
}
```

where:

- `phone`: Recipient phone.  
- `email`: Recipient email.
- `recipientListId`: Recipient list id.
- `isUnsubscribed`: Flag to prevent sending emails to the recipient.
- `values`: Object indexed by column number with the recipient data.  

# Response
```json
{
    "email: "email",
    "phone": "phone",
    "isDeleted": false,
    "isUnsubscribed": false,
    "values": {
        "0": "first column,
        "1": "second column",
        "2": "third column",
    },
    "id": "recipient id",
    "recipientListId": "recipient list id"
}
```

where:

- `phone`: Recipient phone.  
- `email`: Recipient email.
- `recipientListId`: Recipient list id.
- `isUnsubscribed`: Flag to prevent sending emails to the recipient.
- `values`: Object indexed by column number with the recipient data.  
- `id`: Recipient id.  
- `recipientListId`: Recipient list id.

# Description

Create a recipient where `recipientListId` is the id of the recipient list that the recipient will be added.

# Body

```json theme={null}
{
    "phone": string,
    "email": string,
    "recipientListId": string,
    "isUnsubscribed": boolean,
    "values": object,
}
```

where:

* `phone`: Recipient phone.
* `email`: Recipient email.
* `recipientListId`: Recipient list id.
* `isUnsubscribed`: Flag to prevent sending emails to the recipient.
* `values`: Object indexed by column number with the recipient data.

# Response

```json theme={null}
{
    "email: "email",
    "phone": "phone",
    "isDeleted": false,
    "isUnsubscribed": false,
    "values": {
        "0": "first column,
        "1": "second column",
        "2": "third column",
    },
    "id": "recipient id",
    "recipientListId": "recipient list id"
}
```

where:

* `phone`: Recipient phone.
* `email`: Recipient email.
* `recipientListId`: Recipient list id.
* `isUnsubscribed`: Flag to prevent sending emails to the recipient.
* `values`: Object indexed by column number with the recipient data.
* `id`: Recipient id.
* `recipientListId`: Recipient list id.


## OpenAPI

````yaml POST /campaigns-service/v1/recipientLists/{recipientListId}/recipients
openapi: 3.0.3
info:
  title: SightX API
  version: 1.0.0
  description: >-
    SightX REST API documentation. Most responses are JSON; some export
    endpoints return files. API access is a paid add-on — contact
    sales@sightx.io for details.
servers:
  - url: https://auth.admin.sightx.io
    description: Authentication (Production)
  - url: https://auth.staging-admin.sightx.io
    description: Authentication (Staging)
security:
  - AuthorizationHeader: []
paths:
  /campaigns-service/v1/recipientLists/{recipientListId}/recipients:
    post:
      summary: Create Recipient list recipient
      description: >-
        # Description


        Create a recipient where `recipientListId` is the id of the recipient
        list that the recipient will be added. 


        # Body


        ```json

        {
            "phone": string,
            "email": string,
            "recipientListId": string,
            "isUnsubscribed": boolean,
            "values": object,
        }

        ```


        where:


        - `phone`: Recipient phone.  

        - `email`: Recipient email.

        - `recipientListId`: Recipient list id.

        - `isUnsubscribed`: Flag to prevent sending emails to the recipient.

        - `values`: Object indexed by column number with the recipient data.  


        # Response

        ```json

        {
            "email: "email",
            "phone": "phone",
            "isDeleted": false,
            "isUnsubscribed": false,
            "values": {
                "0": "first column,
                "1": "second column",
                "2": "third column",
            },
            "id": "recipient id",
            "recipientListId": "recipient list id"
        }

        ```


        where:


        - `phone`: Recipient phone.  

        - `email`: Recipient email.

        - `recipientListId`: Recipient list id.

        - `isUnsubscribed`: Flag to prevent sending emails to the recipient.

        - `values`: Object indexed by column number with the recipient data.  

        - `id`: Recipient id.  

        - `recipientListId`: Recipient list id.
      operationId: >-
        create-recipient-list-recipient-post-campaigns-service-v1-recipientlists-recipientlistid-recipients
      parameters:
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
            example:
              phone: phone
              email: email
              recipientListId: recipient list id
              isUnsubscribed: false
              values:
                '0': first column
                '1': second column
                '2': third column
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '500':
          description: Internal server error
      servers:
        - url: https://campaigns.sightx.io
components:
  securitySchemes:
    AuthorizationHeader:
      type: apiKey
      in: header
      name: Authorization
      description: Access token obtained from the m2m-token endpoint.

````