POST : Create company

This endpoint lets you create one company for a given media.

This endpoint requires :

• brand_admin, media_admin or media_partner roles.

• r_w_companies scope.

Important informations

• This endpoint have a short rate limits → Rate limits

For Data management purpose, Only one company with unique name a or/and domain_url

Create new company

POST https://api-piloty.fr/companies

Request Body

Name	Type	Description
media_public_id*	string	ex: "acme_media"
name*	string	eg: "ACME Company"
domain_url	string	eg: "acme-company.com"
sector_id	string	Can be multiple separate by ; from List Sectors
size_id	string	from List Sizes
description	string	eg: "Lorem Ipsum ..."
logo_url	string	eg : "https://domain.com/url_path" Required format image : MIME IMAGE
logo	file	Image file format are accepted To use with content-type : multipart/form-data

You can add a logo to a company by add to the body : logo_url as string url OR logo as file

201: Created success

[
    "data":{
            "id": "6295debf398f8985f09dc99d",
            "name": "Trusty",
            "public_id": "trusty",
            "size": "62cc627cf40fc5d45819d8f8",
            "sectors": [
                "630f96baa4ef90ff2a51ee34"
            ],
            "content": {
                "visual": {
                    "logo": "https://piloty-public-staging.s3.amazonaws.com/companiesDocuments/6295debf398f8985f09dc99d/6295debf398f8985f09dc99d_logo_1710944607812"
                },
                "description":"Lorem Ipsum ...",
                "language": "fr"
            },
            "is_published": true,
            "is_vme_page_published" : false
        }
]

401: Unauthorized unauthorized-limitation

{
    "status": 401,
    "error": "unauthorized-limitation",
    "errorMessage": "Unauthorized"
}

409: Conflict company-already-existed

{
    "status": 409,
    "error": "company-already-existed",
    "errorMessage":"Company already exists; Please contact [e-mail] if you want to add this company"
}

Request example with application/x-www-form-urlencoded

curl -X POST -G "https://api-piloty.fr/companies
    -H "Authorization: Bearer PILOTY_TOKEN" \
    -H "Content-Type: application/x-www-form-urlencoded" \
    -d @- <<EOF
      {
        "media_public_id":"acme_media",
        "name": "Acme Company",
        "domain_url": "acme-company.com",
        "sector_id": "querty1234",
        "size_id": "querty1234",
        
      }
      EOF

Request example with multipart/form-data

curl -X POST -G "https://api-piloty.fr/companies
   -H 'Authorization: Bearer PILOTY_TOKEN' \
   -H 'Content-Type: multipart/form-data' 
   -F 'media_public_id=acme_media' 
   -F 'name=ACME Company' 
   -F 'domain_url=company.com' 
   -F 'size_id=size_123' \
   -F 'sector_id=sector_123' \
   -F 'description=Company description' 
   -F 'logo=@/path/to/logo.png'
   -F 'logo_url=https://example.com/logo.png'