[BETA] Update a company by external reference ID

Partially update a company addressed by your own externalReferenceId.

Only provided fields are modified.

  • If a field is set to null → its value is reset (name cannot be reset).
  • If a field is not provided → partial update, the field is ignored.

address is replaced as a whole: send every line you want to keep; null or {} clears it. Unknown fields are ignored. The response is the mutation envelope, not the company: meta.updatedFields lists the fields the body carried. Read the company back with GET /companies/{id} when you need it.

businessIdentifier and externalReferenceId stay unique within your school: taking one held by another company answers 409 COMPANY_BUSINESS_IDENTIFIER_ALREADY_EXISTS or 409 COMPANY_ALREADY_EXISTS, and nothing is modified.

An unknown external reference ID answers 404 COMPANY_NOT_FOUND.

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…
Path Params
string
required
length between 1 and 128

The external reference ID the connector wrote on the company

Body Params
string
length between 1 and 255

Legal name of the company. Names are not unique. Cannot be reset

length ≤ 255

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

length ≤ 64

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

length ≤ 64

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

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

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

object | null

Postal address, replaced as a whole: lines you do not send are removed. null or {} clears it

length between 1 and 128

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

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