---
updatedAt: 2025-09-22T21:26:19.000Z
agentTools:
  projectIndex: https://docs.cupid.travel/llms.txt
---

# Run mapping process for a partner

This endpoint starts the partner inventory mapping process.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Cupid Hotel Mapping API",
    "version": "3.0"
  },
  "security": [
    {
      "apikeyAuth": []
    }
  ],
  "servers": [
    {
      "url": "https://api.cupid.travel"
    }
  ],
  "paths": {
    "/api/run-mapping": {
      "post": {
        "tags": [
          "Hotel Mapping"
        ],
        "summary": "Run mapping process for a partner",
        "description": "This endpoint starts the partner inventory mapping process.",
        "security": [
          {
            "apikeyAuth": []
          }
        ],
        "parameters": [
          {
            "name": "x-api-key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": ""
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "Name of the mapping.",
                    "example": "test"
                  },
                  "partner_id": {
                    "type": "integer",
                    "description": "The partner ID , you can get it from the partner list endpoint.",
                    "example": 1391
                  },
                  "restrict_mapping_to_add_hotels": {
                    "type": "boolean",
                    "description": "Whether to restrict mapping to add hotels.",
                    "example": true
                  },
                  "model": {
                    "type": "string",
                    "description": "Mapping model version. If not provided, the default 'Cupid v5 Hybrid' will be used.",
                    "example": "Cupid v5 Hybrid",
                    "default": "Cupid v5 Hybrid",
                    "enum": [
                      "Cupid v5 Hybrid",
                      "Cupid v5"
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Mapping started successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "integer",
                      "example": 200
                    },
                    "msg": {
                      "type": "string",
                      "example": "Mapping started successfully"
                    },
                    "data": {
                      "type": "object",
                      "description": "Catalog data returned after the mapping is started."
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "integer",
                      "example": 400
                    },
                    "msg": {
                      "type": "string",
                      "example": "Please upload a file"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized - missing or invalid credentials.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "Not authorized"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Partner inventory not found.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "integer",
                      "example": 404
                    },
                    "msg": {
                      "type": "string",
                      "example": "NO Active Partner inventory found"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error occurred during mapping process.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "integer",
                      "example": 500
                    },
                    "msg": {
                      "type": "string",
                      "example": "Error occurred while getting partner inventory"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```