/api/v1/organisation/people/{personId}

patch https://api.capmo.de/api/v1/organisation/people/{personId}

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

Path Params

personId

string

required

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.

first_name

string

length ≤ 255

The first name of the person.

last_name

string

length ≤ 255

The last name of the person.

string

length ≤ 255

The email address of the person.

position

string

length ≤ 255

The position of the person.

phone_number

string

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

company_id

string

The company ID assigned to the person.

Headers

Request-Id

json

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


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://api.capmo.de/api/v1/organisation/people/personId \
3
     --header 'Request-Id: YOUR_REQUEST_ID' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json'

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

application/json

200The organisation contact book person has been successfully updated.

400Bad request, Invalid input

401Unauthorized

403Forbidden

404Object not found

409Conflict

500Internal server error