Biklo for developersTESTsandbox-api.biklo.comchange

Update the profile

PUT/v1/company

scope company.write

Presentation fields only: description, contact details and links. Your legal identity — business name, fiscal codes, IBAN — is not editable here; it appears on invoices and changes through verification in the seller dashboard. Sending a field outside the editable set returns 400 with the list of what is allowed.

Request body#

FieldTypeRequiredDescription
descriptionstringoptionalYour shop description, shown on the company page. Basic HTML is accepted. Every field here is optional — send only what changes.
websitestringoptionalYour own site.
phonestringoptionalPublic contact phone.
titlestringoptionalThe shop name as buyers see it.
contact_personstringoptionalWho to ask for.
emailstringoptionalPublic contact address. Must be a valid address (invalid_email, 400).
addressstringoptionalYour public address, as free text. This is DISPLAY only — it is not where parcels are collected from. Use pickup points for that.
google_mapsstringoptionalA Google Maps link to your shop.
facebookstringoptionalSocial link.
instagramstringoptionalSocial link.
linkedinstringoptionalSocial link.
tiktokstringoptionalSocial link.
youtubestringoptionalSocial link. Anything NOT in this list is rejected with unknown_field (400), which names both what you sent and what is editable — legal identity, VAT number and bank details are changed through support, not here.

Example

{
    "description": "<p>Mountain bike apparel from Barcelona.</p>",
    "website": "https://example.com",
    "phone": "+34600000000"
}

Response#

FieldTypeDescription
companyobjectYour public shop profile — what buyers see on your company page.
company.idintegerYour company id.
company.namestringThe account name.
company.business_namestring|nullThe registered legal name. READ-ONLY here: legal identity is changed through verification, not through this API.
company.titlestring|nullThe shop name buyers see.
company.descriptionstring|nullYour shop description. May contain HTML.
company.logo_urlstring|nullYour logo, once uploaded through POST /v1/company/logo.
company.cover_urlstring|nullThe cover image on your company page.
company.contactobjectPublic contact details.
company.contact.personstring|nullWho to ask for.
company.contact.emailstring|nullPublic email.
company.contact.phonestring|nullPublic phone.
company.contact.addressstring|nullA DISPLAY address only — not where parcels are collected. Pickup points are where that is decided.
company.linksobjectYour links. Every one is optional and null when unset.
company.links.websitestring|nullYour own site.
company.links.marketplacestring|nullYour page on another marketplace.
company.links.google_mapsstring|nullA map link to your shop.
company.links.facebookstring|nullSocial link.
company.links.instagramstring|nullSocial link.
company.links.linkedinstring|nullSocial link.
company.links.tiktokstring|nullSocial link.
company.links.youtubestring|nullSocial link.
company.is_activebooleanWhether the company can trade. false means listings are not being shown.
company.onboarding_completed_atstring|nullISO-8601 UTC, or null while onboarding is unfinished.

Example

{
    "company": {
        "id": 9000010,
        "name": "Example Bikes SL",
        "business_name": "Example Bikes SL",
        "title": "Example Bikes",
        "description": "<p>Mountain bike apparel from Barcelona.</p>",
        "logo_url": null,
        "cover_url": null,
        "contact": {
            "person": "Sandbox Contact",
            "email": "[email protected]",
            "phone": "0700000000",
            "address": "Carrer Gran 42, Barcelona"
        },
        "links": {
            "website": "https://example.com",
            "marketplace": null,
            "google_maps": null,
            "facebook": null,
            "instagram": null,
            "linkedin": null,
            "tiktok": null,
            "youtube": null
        },
        "is_active": true,
        "onboarding_completed_at": "2026-08-02T09:14:00Z"
    }
}

Failures use the shared error envelope — a machine-readable code and a request_id to quote to support. Error handling.

curl -X PUT "https://sandbox-api.biklo.com/v1/company" \
  -H "Authorization: Bearer bk_test_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "<p>Mountain bike apparel from Barcelona.</p>",
    "website": "https://example.com",
    "phone": "+34600000000"
}'
<?php

$ch = curl_init('https://sandbox-api.biklo.com/v1/company');

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST  => 'PUT',
    CURLOPT_HTTPHEADER     => [
        'Authorization: Bearer bk_test_YOUR_KEY',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS     => json_encode([
      'description' => '<p>Mountain bike apparel from Barcelona.</p>',
      'website' => 'https://example.com',
      'phone' => '+34600000000',
    ]),
]);

$response = json_decode(curl_exec($ch), true);
curl_close($ch);

using System.Net.Http;
using System.Net.Http.Headers;

var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", "bk_test_YOUR_KEY");

var request = new HttpRequestMessage(
    new HttpMethod("PUT"),
    "https://sandbox-api.biklo.com/v1/company");

request.Content = new StringContent(
    @"{ ""description"": ""<p>Mountain bike apparel from Barcelona.</p>"", ""website"": ""https://example.com"", ""phone"": ""+34600000000"" }",
    System.Text.Encoding.UTF8,
    "application/json");

var response = await client.SendAsync(request);
var json = await response.Content.ReadAsStringAsync();

import requests

response = requests.put(
    "https://sandbox-api.biklo.com/v1/company",
    headers={"Authorization": "Bearer bk_test_YOUR_KEY"},
    json={
        "description": "<p>Mountain bike apparel from Barcelona.</p>",
        "website": "https://example.com",
        "phone": "+34600000000"
    },
)

data = response.json()

const response = await fetch("https://sandbox-api.biklo.com/v1/company", {
  method: "PUT",
  headers: {
    Authorization: "Bearer bk_test_YOUR_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "description": "<p>Mountain bike apparel from Barcelona.</p>",
      "website": "https://example.com",
      "phone": "+34600000000"
  })
});

const data = await response.json();

import java.net.http.*;
import java.net.URI;

var client = HttpClient.newHttpClient();

var request = HttpRequest.newBuilder()
    .uri(URI.create("https://sandbox-api.biklo.com/v1/company"))
    .header("Authorization", "Bearer bk_test_YOUR_KEY")
    .header("Content-Type", "application/json")
    .method("PUT", HttpRequest.BodyPublishers.ofString(
        "{ \"description\": \"<p>Mountain bike apparel from Barcelona.</p>\", \"website\": \"https://example.com\", \"phone\": \"+34600000000\" }"))
    .build();

var response = client.send(request, HttpResponse.BodyHandlers.ofString());