Create a company

Needs customers.write. The name is unique per seller, and so are the tax id (validated as a Chilean RUT) and the email domain. Unknown fields are rejected with 422.

POST/shops/{shop_id}/companies

Authorization

AuthorizationBearer token (JWT) · headerrequired

Path parameters

shop_idintegerrequired

Request body

requiredapplication/json

namestringrequired

id_numberstring

Tax id (RUT), stored without dots and dash.

activity_codeinteger

email_domainstring

New customers with this email domain join the company.

Responses

201

The created company

403

Access denied

422

Invalid or duplicate values, or unknown fields

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

shop_idpath*

Bodyapplication/json

namestring*id_numberstringTax id (RUT), stored without dots and dash.activity_codeintegeremail_domainstringNew customers with this email domain join the company.

Request

curl -X POST 'https://api.onbolder.com/v2/shops/1/companies' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "id_number": "string",
  "activity_code": 0,
  "email_domain": "string"
}'

const response = await fetch("https://api.onbolder.com/v2/shops/1/companies", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\",\n  \"id_number\": \"string\",\n  \"activity_code\": 0,\n  \"email_domain\": \"string\"\n}"
});

import requests

response = requests.post(
    "https://api.onbolder.com/v2/shops/1/companies",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\",\n  \"id_number\": \"string\",\n  \"activity_code\": 0,\n  \"email_domain\": \"string\"\n}",
)

Response

The created company