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

> Personalize an existing collection for a specific store user (deprecated)

# Personalize a collection

The personalization takes around 15-20 seconds and only works on personalizable collections.
The response will return:

* a `sha` that is used for displaying the images (see [personalization guide](/guides/personalization))
* a `fields` property that is used when submitting personalized orders (see [personalization guide](/guides/personalization))


## OpenAPI

````yaml post /api/ext/v1/collection/{collectionId}/personalize
openapi: 3.0.1
info:
  title: Covver External API docs
  description: Covver External API docs
  version: 0.1.0
servers:
  - url: https://staging-api.covver.io
    description: Covver Staging Server
  - url: https://api.covver.io
    description: Covver Production Server
  - url: http://localhost:8080
    description: Covver Local Server
security:
  - BearerAuth: []
tags:
  - name: Auth
    description: Authentication endpoints
  - name: Products
    description: Product endpoints
  - name: People
    description: People endpoints
  - name: Orders
    description: Orders endpoints
  - name: Reports
    description: Report endpoints
externalDocs:
  url: https://swagger.io
  description: Find more info here
paths:
  /api/ext/v1/collection/{collectionId}/personalize:
    post:
      tags:
        - Products
      summary: Personalize a collection
      description: Personalize a collection for a specific user
      parameters:
        - schema:
            type: string
          in: path
          name: collectionId
          required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                companyId:
                  type: string
                sourceFields:
                  type: object
                  properties:
                    firstName:
                      description: First name
                      type: string
                      nullable: true
                    lastName:
                      description: Last name
                      type: string
                      nullable: true
                    department:
                      description: Work department (e.g. sales)
                      type: string
                      nullable: true
                    location:
                      description: Work location (site/city/country)
                      type: string
                      nullable: true
                    startDate:
                      format: date-time
                      description: Start date in ISO format
                      type: string
                      nullable: true
                    birthDate:
                      format: date-time
                      description: Birth date in ISO format
                      type: string
                      nullable: true
              required:
                - companyId
                - sourceFields
        required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  sha:
                    type: string
                  fields:
                    type: object
                    properties:
                      name:
                        type: object
                        properties:
                          first:
                            type: string
                            nullable: true
                          last:
                            type: string
                            nullable: true
                          firstNameInitials:
                            type: string
                          lastNameInitials:
                            type: string
                          initials:
                            type: string
                          firstPossessive:
                            type: string
                            nullable: true
                      anniversary:
                        type: object
                        properties:
                          month:
                            type: number
                          monthPadded:
                            type: string
                          year:
                            type: number
                          decade:
                            type: string
                          years:
                            type: number
                          yearsPadded:
                            type: string
                          hundreds:
                            type: string
                          zodiac:
                            enum:
                              - Capricorn
                              - Aquarius
                              - Pisces
                              - Aries
                              - Taurus
                              - Gemini
                              - Cancer
                              - Leo
                              - Virgo
                              - Libra
                              - Scorpio
                              - Sagittarius
                          ordinal:
                            type: string
                          elapsed:
                            type: string
                          elapsedYears:
                            type: string
                      birth:
                        type: object
                        properties:
                          month:
                            type: number
                          monthPadded:
                            type: string
                          year:
                            type: number
                          decade:
                            type: string
                          years:
                            type: number
                          yearsPadded:
                            type: string
                          hundreds:
                            type: string
                          zodiac:
                            enum:
                              - Capricorn
                              - Aquarius
                              - Pisces
                              - Aries
                              - Taurus
                              - Gemini
                              - Cancer
                              - Leo
                              - Virgo
                              - Libra
                              - Scorpio
                              - Sagittarius
                          ordinal:
                            type: string
                          elapsed:
                            type: string
                          elapsedYears:
                            type: string
                      work:
                        type: object
                        properties:
                          department:
                            type: string
                            nullable: true
                          location:
                            type: string
                            nullable: true
                    required:
                      - name
                      - anniversary
                      - birth
                      - work
                  status:
                    enum:
                      - Pending
                      - Done
                      - Error
                required:
                  - sha
                  - fields
                  - status
        4XX:
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errorCode:
                    type: string
                  error: {}
                  statusCode:
                    type: number
                required:
                  - message
                  - errorCode
                  - statusCode
        5XX:
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errorCode:
                    type: string
                  error: {}
                  statusCode:
                    type: number
                required:
                  - message
                  - errorCode
                  - statusCode
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````