/api/v1/organisation/companies

post

http://localhost:8000/api/v1/organisation/companies

This can be used to add a new organisation contact book company.

Body Params

source_id

string

The unique identifier of the source. This is a user-generated string. You can use this to link the person to a resource in an external system.

name

string

required

length ≤ 255

The name of the company.

address_street

string

length ≤ 255

The address (street) of the company.

address_zip_code

string

length ≤ 255

The address (zip code) of the company.

address_city

string

length ≤ 255

The address (city) of the company.

address_country

string

length ≤ 255

The address (country) of the company. It is an ISO 3166-1 alpha-2 country code.

tax_id

string

length ≤ 255

The tax ID of the company.

phone_number

string

The phone number of the company. It must consist of between 1 and 15 digits and an optional leading "+" character

person_id

string

The person ID assigned to the company.

Headers

Request-Id

string

The HTTP Request-Id request header is an optional and unofficial HTTP header, used to trace individual HTTP requests from the client to the server and back again. It allows the client and server to correlate each HTTP request. If not provided by the client, the server should generate a unique request ID and include it in the response.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The organisation contact book company has been successfully created.

400Bad request, Invalid input

401Unauthorized

403Forbidden

404Object not found

409Conflict

500Internal server error