---
updatedAt: 2026-09-15T15:20:20.000Z
agentTools:
  projectIndex: https://docs.bookboost.io/llms.txt
---

# Store user in list

Store user in list.

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Bookboost AB",
    "description": "",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://cdp.bookboost.io"
    }
  ],
  "tags": [
    {
      "name": "Users",
      "description": ""
    }
  ],
  "components": {
    "securitySchemes": {
      "default": {
        "type": "http",
        "scheme": "bearer",
        "description": "You can retrieve your token by visiting your dashboard and clicking <b>Generate API token</b>."
      }
    }
  },
  "security": [
    {
      "default": []
    }
  ],
  "paths": {
    "/api/v1/users/store-in-list": {
      "post": {
        "summary": "Store user in list",
        "operationId": "storeUserInList",
        "description": "Store user in list.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "example": {
                    "uuid": "894757cd-b7a2-4c91-98d0-d768a580382b",
                    "email": "will.smith@bookboost.io",
                    "first_name": null,
                    "last_name": null,
                    "middle_name": null,
                    "title": null,
                    "created_at": "2023-09-19T14:58:51.000000Z",
                    "updated_at": "2023-09-19T14:58:51.000000Z",
                    "signed_up_at": null,
                    "info": {},
                    "phone": null,
                    "merged_count": 0,
                    "reservation_count": null,
                    "total_amount": null,
                    "emails": [
                      {
                        "id": 5,
                        "address": "will.smith@bookboost.io",
                        "source": null,
                        "is_primary": true,
                        "type": "Business"
                      }
                    ],
                    "phones": [],
                    "salutation": null,
                    "gender": null,
                    "birthday": null,
                    "nationality": null,
                    "country_code": null,
                    "language_code": null,
                    "external_references": [
                      {
                        "type": "non",
                        "reference": "d90cf454-3ce3-3fc0-a89c-6bf3d79cbf03",
                        "created_at": "2024-05-21T12:20:43.000000Z",
                        "updated_at": "2024-05-21T12:20:43.000000Z"
                      }
                    ]
                  },
                  "properties": {
                    "uuid": {
                      "type": "string",
                      "example": "894757cd-b7a2-4c91-98d0-d768a580382b"
                    },
                    "email": {
                      "type": "string",
                      "example": "will.smith@bookboost.io"
                    },
                    "first_name": {
                      "type": "string",
                      "example": null,
                      "nullable": true
                    },
                    "last_name": {
                      "type": "string",
                      "example": null,
                      "nullable": true
                    },
                    "middle_name": {
                      "type": "string",
                      "example": null,
                      "nullable": true
                    },
                    "title": {
                      "type": "string",
                      "example": null,
                      "nullable": true
                    },
                    "created_at": {
                      "type": "string",
                      "example": "2023-09-19T14:58:51.000000Z"
                    },
                    "updated_at": {
                      "type": "string",
                      "example": "2023-09-19T14:58:51.000000Z"
                    },
                    "signed_up_at": {
                      "type": "string",
                      "example": null,
                      "nullable": true
                    },
                    "info": {
                      "type": "object",
                      "properties": {}
                    },
                    "phone": {
                      "type": "string",
                      "example": null,
                      "nullable": true
                    },
                    "merged_count": {
                      "type": "integer",
                      "example": 0
                    },
                    "reservation_count": {
                      "type": "string",
                      "example": null,
                      "nullable": true
                    },
                    "total_amount": {
                      "type": "string",
                      "example": null,
                      "nullable": true
                    },
                    "emails": {
                      "type": "array",
                      "example": [
                        {
                          "id": 5,
                          "address": "will.smith@bookboost.io",
                          "source": null,
                          "is_primary": true,
                          "type": "Business"
                        }
                      ],
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "integer",
                            "example": 5
                          },
                          "address": {
                            "type": "string",
                            "example": "will.smith@bookboost.io"
                          },
                          "source": {
                            "type": "string",
                            "example": null,
                            "nullable": true
                          },
                          "is_primary": {
                            "type": "boolean",
                            "example": true
                          },
                          "type": {
                            "type": "string",
                            "example": "Business"
                          }
                        }
                      }
                    },
                    "phones": {
                      "type": "array",
                      "example": []
                    },
                    "salutation": {
                      "type": "string",
                      "example": null,
                      "nullable": true
                    },
                    "gender": {
                      "type": "string",
                      "example": null,
                      "nullable": true
                    },
                    "birthday": {
                      "type": "string",
                      "example": null,
                      "nullable": true
                    },
                    "nationality": {
                      "type": "string",
                      "example": null,
                      "nullable": true
                    },
                    "country_code": {
                      "type": "string",
                      "example": null,
                      "nullable": true
                    },
                    "language_code": {
                      "type": "string",
                      "example": null,
                      "nullable": true
                    },
                    "external_references": {
                      "type": "array",
                      "example": [
                        {
                          "type": "non",
                          "reference": "d90cf454-3ce3-3fc0-a89c-6bf3d79cbf03",
                          "created_at": "2024-05-21T12:20:43.000000Z",
                          "updated_at": "2024-05-21T12:20:43.000000Z"
                        }
                      ],
                      "items": {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string",
                            "example": "non"
                          },
                          "reference": {
                            "type": "string",
                            "example": "d90cf454-3ce3-3fc0-a89c-6bf3d79cbf03"
                          },
                          "created_at": {
                            "type": "string",
                            "example": "2024-05-21T12:20:43.000000Z"
                          },
                          "updated_at": {
                            "type": "string",
                            "example": "2024-05-21T12:20:43.000000Z"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Users"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "list_id": {
                    "type": "string",
                    "description": "Must be a valid UUID.",
                    "example": "8e5613cf-16d0-3b7a-a483-b8f11a5568b2"
                  },
                  "consent_id": {
                    "type": "string",
                    "description": "Must be a valid UUID.",
                    "example": "6d6d8699-060d-39a8-be73-502f4d981eb3"
                  },
                  "first_name": {
                    "type": "string",
                    "description": "Must not be greater than 255 characters.",
                    "example": "John",
                    "nullable": true
                  },
                  "last_name": {
                    "type": "string",
                    "description": "Must not be greater than 255 characters.",
                    "example": "Doe",
                    "nullable": true
                  },
                  "email": {
                    "type": "string",
                    "description": "Must be a valid email address. Must be at least 6 characters. Must not be greater than 100 characters.",
                    "example": "will.smith@bookboost.io"
                  },
                  "phone": {
                    "type": "string",
                    "description": "",
                    "example": null,
                    "nullable": true
                  },
                  "gender": {
                    "type": "string",
                    "description": "Must not be greater than 7 characters.",
                    "example": null,
                    "nullable": true
                  },
                  "salutation": {
                    "type": "string",
                    "description": "Must not be greater than 255 characters.",
                    "example": "Mrs.",
                    "nullable": true
                  },
                  "title": {
                    "type": "string",
                    "description": "Must not be greater than 16 characters.",
                    "example": "Mrs.",
                    "nullable": true
                  },
                  "nationality": {
                    "type": "string",
                    "description": "Must be 2 characters.",
                    "example": null,
                    "nullable": true
                  },
                  "language_code": {
                    "type": "string",
                    "description": "Must be 2 characters.",
                    "example": null,
                    "nullable": true
                  },
                  "country_code": {
                    "type": "string",
                    "description": "Must be 2 characters.",
                    "example": null,
                    "nullable": true
                  },
                  "tags": {
                    "type": "array",
                    "description": "Must not be greater than 255 characters.",
                    "example": [
                      "q"
                    ],
                    "items": {
                      "type": "string"
                    }
                  }
                },
                "required": [
                  "list_id",
                  "consent_id",
                  "email"
                ]
              }
            }
          }
        }
      }
    }
  }
}
```