[BETA] Create a company

Create a company in your school. Only name is required, and names are not unique: two companies may share one. Unknown fields are refused. Creating a company attaches nobody to it.

Idempotency: send your own externalReferenceId (with externalReferenceType). It is unique within your school, so a retried creation answers 409 COMPANY_ALREADY_EXISTS instead of creating a duplicate: find the company with POST /companies:search (filters.externalReferenceIds) and update it with PATCH /companies/by-reference-id/{externalReferenceId}. businessIdentifier is unique within your school as well (409 COMPANY_BUSINESS_IDENTIFIER_ALREADY_EXISTS). Without either, two identical requests create two companies.

Several learners and external contacts can be attached to one company, and a change to the company applies to all of them.

Attach a learner with companyId on PATCH /students/{id} (or its by-reference-id twin): it is the "Company" field of the learner record in the School app. That call also copies the company display name into the learner's historical company text; updating the company later does not rewrite that text.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 255

Legal name of the company. Names are not unique

string
length ≤ 255

Name shown in the School app and printed on documents; the legal name is used when absent

string
length ≤ 64

Official registration number of the company (SIRET, SIREN, VAT number…), unique within your school

string
length ≤ 64

Kind of registration number, free text (e.g. SIRET, VAT)

string
^([a-zA-Z]{2})?$

ISO 3166-1 alpha-2 code of the country that issued the registration number

address
object

Postal address. Empty fields are dropped; an address with no field left is absent

string
length between 1 and 128

Your own identifier of the company, unique within your school; sent with externalReferenceType

string
length between 1 and 30

Name of the system your externalReferenceId comes from (e.g. CRM); sent with externalReferenceId

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json