Update partial contact person data

Prev Next
Patch
/contact-person/{id}/

Operation updates given contact person fields.

Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Path parameters
id
integerRequired

Id of contact person to update

Body parameters

Contact person attributes and values to be updated

object
Address
integer

Customer address id

ContactPersonRestictedType
integer

Contact person restricted type id This field determines protection level of data under GDPR

Role
integer Required

Customer role id

comments
string

Comments or additional details

contact_start_date
string (date)

Contact start date

customer_number
string

Customer number

email
string

Email address GDPR protected field

fax
string

Fax number GDPR protected field

name
string Required

Contact person name GDPR protected field

phone
string Required

Primary phone number GDPR protected field

phone2
string

Secondary phone number GDPR protected field

Responses
200

Object was updated successfully

object
Address
integer

Customer address id

ContactPersonRestictedType
integer

Contact person restricted type id This field determines protection level of data under GDPR

Role
integer

Customer role id

comments
string

Comments or additional details

contact_start_date
string (date)

Contact start date

created_by
string

Username of contact person creator

created_ts
string (date)

Date of creation

customer_number
string

Customer number

email
string

Email address GDPR protected field

fax
string

Fax number GDPR protected field

id
integer

Primary key

name
string

Contact person name GDPR protected field

phone
string

Primary phone number GDPR protected field

phone2
string

Secondary phone number GDPR protected field

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}
object
details
string

Detailed description of error

404

Object was not found

{
  "details": "Not found."
}
object
details
string

Detailed description of error