Create partner

POST

admin

api

partners

Create partner

curl --request POST \
  --url https://erp.arukz.com/admin/api/v1/partners/partners \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_type": "individual",
  "name": "Acme Corporation"
}
'

import requests

url = "https://erp.arukz.com/admin/api/v1/partners/partners"

payload = {
    "account_type": "individual",
    "name": "Acme Corporation"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({account_type: 'individual', name: 'Acme Corporation'})
};

fetch('https://erp.arukz.com/admin/api/v1/partners/partners', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://erp.arukz.com/admin/api/v1/partners/partners",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'account_type' => 'individual',
    'name' => 'Acme Corporation'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "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."
}

{
  "message": "Unauthenticated."
}

{
  "message": "The given data was invalid.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}

Authorizations

Authorization

string

header

required

An API token from Sign in, sent as Authorization: Bearer <token>. Tokens last 30 days.

Body

application/json

account_type

enum<string>

required

Account type.

Available options:

individual,

company,

address

Example:

"individual"

name

string

required

Partner name (max 255 characters). Must not be greater than 255 characters.

Example:

"Acme Corporation"

string | null

Email address (max 255 characters). Must be a valid email address. Must not be greater than 255 characters.

Example:

"contact@example.com"

phone

string | null

Phone number (max 20 characters). Must not be greater than 20 characters.

Example:

"+1234567890"

mobile

string | null

Mobile number (max 20 characters). Must not be greater than 20 characters.

Example:

"+1234567890"

avatar

string | null

Avatar file path (max 255 characters). Must not be greater than 255 characters.

Example:

"avatars/partner.jpg"

job_title

string | null

Job title (max 255 characters). Must not be greater than 255 characters.

Example:

"CEO"

website

string | null

Website URL (max 255 characters). Must be a valid URL. Must not be greater than 255 characters.

Example:

"https://acme.com"

tax_id

string | null

Tax identification number (max 255 characters). Must not be greater than 255 characters.

Example:

"TAX-123456"

company_registry

string | null

Company registry number (max 255 characters). Must not be greater than 255 characters.

Example:

"REG-123456"

reference

string | null

Reference code (max 255 characters). Must not be greater than 255 characters.

Example:

"PART-001"

color

string | null

Color in hex format (max 7 characters). Must not be greater than 7 characters.

Example:

"#FF5733"

street1

string | null

Street address line 1 (max 255 characters). Must not be greater than 255 characters.

Example:

"123 Main Street"

street2

string | null

Street address line 2 (max 255 characters). Must not be greater than 255 characters.

Example:

"Suite 100"

city

string | null

City (max 255 characters). Must not be greater than 255 characters.

Example:

"New York"

zip

string | null

Postal/ZIP code (max 20 characters). Must not be greater than 20 characters.

Example:

"10001"

state_id

integer | null

State ID. The id of an existing record in the states table.

Example:

9

country_id

integer | null

Country ID. The id of an existing record in the countries table.

Example:

233

parent_id

integer | null

Parent partner ID (for addresses and contacts). The id of an existing record in the partners_partners table.

title_id

integer | null

Title ID. The id of an existing record in the partners_titles table.

Example:

1

company_id

integer | null

Company ID. The id of an existing record in the companies table.

Example:

1

industry_id

integer | null

Industry ID. The id of an existing record in the partners_industries table.

Example:

1

user_id

integer | null

Associated user ID/Responsible Sale user. The id of an existing record in the users table.

Example:

1

Response

Created

⌘I

Create partner

curl --request POST \
  --url https://erp.arukz.com/admin/api/v1/partners/partners \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_type": "individual",
  "name": "Acme Corporation"
}
'

import requests

url = "https://erp.arukz.com/admin/api/v1/partners/partners"

payload = {
    "account_type": "individual",
    "name": "Acme Corporation"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({account_type: 'individual', name: 'Acme Corporation'})
};

fetch('https://erp.arukz.com/admin/api/v1/partners/partners', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://erp.arukz.com/admin/api/v1/partners/partners",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'account_type' => 'individual',
    'name' => 'Acme Corporation'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "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."
}

{
  "message": "Unauthenticated."
}

{
  "message": "The given data was invalid.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}

Get started

Endpoints

Authorizations

Body

Response