--- title: "Add Title To Workspace" url: "https://developer.pexa.co.uk/apis/lodgement-v1-v1/versions/4cf5cbcd-2fac-43d1-a87a-4c2ddc00ef30/operations/addTitle" --- > Full API specification: https://developer.pexa.co.uk/apis/lodgement-v1-v1/versions/4cf5cbcd-2fac-43d1-a87a-4c2ddc00ef30.md # Add Title To Workspace `POST` `/partner/api/platformconnect/v1/workspaces/{workspace_id}/titles` Operation ID: `addTitle` Add title to workspace to be retrieved from HMLR using Title number ## Path parameters - `workspace_id` (string, uuid, required) - Workspace id ## Header parameters - `X-Request-Correlation-Id` (string, optional) ## Request body (required) Content types: `application/json` ## Responses - `202` - ACCEPTED - `400` - BAD REQUEST - `401` - UNAUTHORIZED - Missing or invalid authentication token - `403` - FORBIDDEN - `404` - NOT FOUND - `500` - INTERNAL SERVER ERROR - `503` - SERVICE UNAVAILABLE ## OpenAPI definition ```yaml openapi: 3.0.1 info: title: Lodgement version: v1.1.0 servers: - url: https://api.pexa.co.uk description: API Gateway URL paths: /partner/api/platformconnect/v1/workspaces/{workspace_id}/titles: post: tags: - title summary: Add Title To Workspace description: Add title to workspace to be retrieved from HMLR using Title number operationId: addTitle security: - oauth2: - x-api:add:lodgement_titles parameters: - in: header name: X-Request-Correlation-Id schema: type: string description: The unique identifier for the request - name: workspace_id in: path description: Workspace id required: true schema: type: string format: uuid requestBody: content: application/json: schema: required: - titleNumber type: object properties: titleNumber: type: string description: "Title number format: optional 0-3 letters + 1-6 digits" example: ABC123456 required: true responses: "202": description: ACCEPTED headers: X-API-Version: schema: type: string description: The API version that was used to process the request. X-Request-Correlation-Id: schema: type: string description: The unique identifier for the request content: application/json: schema: required: - message type: object properties: message: type: string example: Request taken up for processing "400": description: BAD REQUEST headers: X-API-Version: schema: type: string description: The API version that was used to process the request. X-Request-Correlation-Id: schema: type: string description: The unique identifier for the request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: field: type: string description: Field message: type: string description: Error message example: errors: message: Incorrect title number format "401": description: UNAUTHORIZED - Missing or invalid authentication token headers: X-API-Version: schema: type: string description: The API version that was used to process the request. X-Request-Correlation-Id: schema: type: string description: The unique identifier for the request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: field: type: string description: Field message: type: string description: Error message example: errors: message: Unauthorised "403": description: FORBIDDEN headers: X-API-Version: schema: type: string description: The API version that was used to process the request. X-Request-Correlation-Id: schema: type: string description: The unique identifier for the request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: field: type: string description: Field message: type: string description: Error message example: errors: - message: Forbidden "404": description: NOT FOUND headers: X-API-Version: schema: type: string description: The API version that was used to process the request. X-Request-Correlation-Id: schema: type: string description: The unique identifier for the request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: field: type: string description: Field message: type: string description: Error message example: errors: - message: Not Found "500": description: INTERNAL SERVER ERROR headers: X-API-Version: schema: type: string description: The API version that was used to process the request. X-Request-Correlation-Id: schema: type: string description: The unique identifier for the request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: field: type: string description: Field message: type: string description: Error message example: errors: - message: Internal Server Error "503": description: SERVICE UNAVAILABLE headers: X-API-Version: schema: type: string description: The API version that was used to process the request. X-Request-Correlation-Id: schema: type: string description: The unique identifier for the request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: field: type: string description: Field message: type: string description: Error message example: errors: - message: Service under maintenance security: - oauth2: - x-api:add:lodgement_titles components: securitySchemes: oauth2: type: oauth2 flows: clientCredentials: tokenUrl: https://login.pexauk.co.uk/oauth/token scopes: x-api:create:attachments: Create access to the attachments x-api:add:workspace_files: Add access to the workspace files view:title_documents: View access to the title documents x-api:view:documents: View access to the documents x-api:approve:lodgement_applications: Approve access to lodgement applications x-api:unapprove:lodgement_applications: Unapprove access to lodgement applications x-api:submit:lodgement_applications: Submit access to lodgement applications x-api:add:lodgement_titles: Add titles to lodgementCase view:lodgement_cases: View lodgement cases view:lodgement_documents: View lodgement documents add:lodgement_files: Add access to the lodgement files view:lodgement_files: View access to the lodgement files submit:lodgement_applications: Submit access to the lodgement applications view:workspaces: View access to the workspaces ```