API Reference

/api/v1/organisation/companies/{companyId}

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

This can be used to update a specific organisation contact book company by its ID.

Path Params
string
required
Body Params
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.

string
length ≤ 255

The name of the company.

string
length ≤ 255

The address (street) of the company.

string
length ≤ 255

The address (zip code) of the company.

string
length ≤ 255

The address (city) of the company.

string
length ≤ 255

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

string
length ≤ 255

The tax ID of the company.

string

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

Headers
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
200

The organisation contact book company has been successfully updated.

Updated about 2 months ago

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

Updated about 2 months ago