> ## Documentation Index > Fetch the complete documentation index at: https://docs.erp.arukz.com/llms.txt > Use this file to discover all available pages before exploring further. # Create partner > Create a new partner ## OpenAPI ````yaml /api-reference/openapi.json post /admin/api/v1/partners/partners openapi: 3.0.3 info: title: ARUKZ ERP API version: v1 description: >- The REST API of ARUKZ ERP: sales, purchases, inventory, products, partners, accounts, projects and reference data. Every call acts as the user whose token it carries and sees only that user's company. servers: - url: https://erp.arukz.com description: ARUKZ ERP (hosted) security: - bearerAuth: [] tags: - name: Authentication description: Sign in for a token and sign out. - name: Sales description: Quotations, sales orders and their lines, deliveries and invoices. - name: Purchases description: Purchase orders, receipts, bills, agreements and vendor price lists. - name: Inventory description: >- Warehouses, locations, lots, stock quantities, receipts, deliveries, transfers and scrap. - name: Products description: 'The product catalogue: categories, attributes, variants and packaging.' - name: Partners description: Customers, vendors, contacts, addresses and bank accounts. - name: Accounts description: >- Invoices, bills, credit notes, refunds, taxes, journals and the chart of accounts. - name: Projects description: Projects, tasks, stages and milestones. - name: Reference data description: Currencies and rates, banks, countries, states and units of measure. paths: /admin/api/v1/partners/partners: post: tags: - Partners summary: Create partner description: Create a new partner operationId: partners-create-partner requestBody: required: true content: application/json: schema: type: object properties: account_type: type: string description: Account type. enum: - individual - company - address example: individual name: type: string description: >- Partner name (max 255 characters). Must not be greater than 255 characters. example: Acme Corporation email: type: string description: >- Email address (max 255 characters). Must be a valid email address. Must not be greater than 255 characters. nullable: true example: contact@example.com phone: type: string description: >- Phone number (max 20 characters). Must not be greater than 20 characters. nullable: true example: '+1234567890' mobile: type: string description: >- Mobile number (max 20 characters). Must not be greater than 20 characters. nullable: true example: '+1234567890' avatar: type: string description: >- Avatar file path (max 255 characters). Must not be greater than 255 characters. nullable: true example: avatars/partner.jpg job_title: type: string description: >- Job title (max 255 characters). Must not be greater than 255 characters. nullable: true example: CEO website: type: string description: >- Website URL (max 255 characters). Must be a valid URL. Must not be greater than 255 characters. nullable: true example: https://acme.com tax_id: type: string description: >- Tax identification number (max 255 characters). Must not be greater than 255 characters. nullable: true example: TAX-123456 company_registry: type: string description: >- Company registry number (max 255 characters). Must not be greater than 255 characters. nullable: true example: REG-123456 reference: type: string description: >- Reference code (max 255 characters). Must not be greater than 255 characters. nullable: true example: PART-001 color: type: string description: >- Color in hex format (max 7 characters). Must not be greater than 7 characters. nullable: true example: '#FF5733' street1: type: string description: >- Street address line 1 (max 255 characters). Must not be greater than 255 characters. nullable: true example: 123 Main Street street2: type: string description: >- Street address line 2 (max 255 characters). Must not be greater than 255 characters. nullable: true example: Suite 100 city: type: string description: >- City (max 255 characters). Must not be greater than 255 characters. nullable: true example: New York zip: type: string description: >- Postal/ZIP code (max 20 characters). Must not be greater than 20 characters. nullable: true example: '10001' state_id: type: integer description: >- State ID. The `id` of an existing record in the states table. nullable: true example: 9 country_id: type: integer description: >- Country ID. The `id` of an existing record in the countries table. nullable: true example: 233 parent_id: type: integer description: >- Parent partner ID (for addresses and contacts). The `id` of an existing record in the partners_partners table. nullable: true title_id: type: integer description: >- Title ID. The `id` of an existing record in the partners_titles table. nullable: true example: 1 company_id: type: integer description: >- Company ID. The `id` of an existing record in the companies table. nullable: true example: 1 industry_id: type: integer description: >- Industry ID. The `id` of an existing record in the partners_industries table. nullable: true example: 1 user_id: type: integer description: >- Associated user ID/Responsible Sale user. The `id` of an existing record in the users table. nullable: true example: 1 required: - account_type - name responses: '201': description: Created content: application/json: example: data: id: 1 account_type: individual sub_type: company name: TechNova Solutions Pvt. Ltd. email: technova@example.com phone: '1234567890' mobile: '1234567890' avatar: company-logos/01JRA5TEK5HTHJAYXSDBZRJF8B.png avatar_url: >- https://erp.arukz.com/storage/company-logos/01JRA5TEK5HTHJAYXSDBZRJF8B.png job_title: null website: https://www.technovasolutions.com tax_id: TNS123456 company_registry: TN-20251234 reference: null is_active: true color: '#AAAAAA' street1: 1234 Silicon Street street2: Tech Park city: New York zip: '10001' country_id: 233 state_id: 35 parent_id: null title_id: null company_id: 1 industry_id: null user_id: null creator_id: 1 created_at: '2025-04-07T12:34:34.000000Z' updated_at: '2025-04-08T07:46:16.000000Z' deleted_at: null country: id: 233 name: United States code: US phone_code: '1' state_required: true zip_required: true currency_id: 1 created_at: '2025-04-07T12:34:34.000000Z' updated_at: '2025-04-07T12:34:34.000000Z' state: id: 35 name: New York code: NY country_id: 233 created_at: '2025-04-07T12:34:34.000000Z' updated_at: '2025-04-07T12:34:34.000000Z' message: Partner created successfully. '401': description: Unauthenticated content: application/json: example: message: Unauthenticated. '422': description: Validation error content: application/json: example: message: The given data was invalid. errors: name: - The name field is required. components: securitySchemes: bearerAuth: type: http scheme: bearer description: >- An API token from [Sign in](/api-reference/authentication), sent as `Authorization: Bearer `. Tokens last 30 days. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.