Request

PUT http:///api/v1/partner/companycontacts/contact/{contactId}

Path parameters

Parameter name Value Description Additional
contactId string Required

Request body

The request body takes a complete PartnerCompanyContactRequest resource, containing the following writable properties:

{
    "assets": [
        {
            "active": "boolean",
            "assetType": "string",
            "companyId": "string",
            "created": "int64",
            "deleted": "boolean",
            "id": "string",
            "key": "string",
            "largeURL": "string",
            "largeX2URL": "string",
            "mediumURL": "string",
            "modified": "int64",
            "name": "string",
            "origURL": "string",
            "priority": "int32",
            "publicURL": "string",
            "secured": "boolean",
            "thumbURL": "string",
            "type": "string",
            "updated": "boolean"
        }
    ],
    "companyId": "string",
    "created": "int64",
    "customerCompanyId": "string",
    "deleted": "boolean",
    "dirty": "boolean",
    "email": "string",
    "employeeId": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "modified": "int64",
    "note": {
        "created": "int64",
        "deleted": "boolean",
        "enableOnFleet": "boolean",
        "id": "string",
        "message": "string",
        "modified": "int64",
        "updated": "boolean",
        "writerId": "string",
        "writerName": "string"
    },
    "officeNumber": "string",
    "phoneNumber": "string",
    "role": "string",
    "salutation": "string",
    "shopId": "string",
    "updated": "boolean",
    "userPhoto": {
        "active": "boolean",
        "assetType": "string",
        "companyId": "string",
        "created": "int64",
        "deleted": "boolean",
        "id": "string",
        "key": "string",
        "largeURL": "string",
        "largeX2URL": "string",
        "mediumURL": "string",
        "modified": "int64",
        "name": "string",
        "origURL": "string",
        "priority": "int32",
        "publicURL": "string",
        "secured": "boolean",
        "thumbURL": "string",
        "type": "string",
        "updated": "boolean"
    }
}

Properties

Name Type Description Additional
assets[] array Optional
assets[].active boolean Optional
assets[].assetType string

Possible values are:

  • Photo
  • Document
  • Kml
Optional
assets[].companyId string Optional
assets[].created int64 Optional
assets[].deleted boolean Optional
assets[].id string Optional
assets[].key string Optional
assets[].largeURL string Optional
assets[].largeX2URL string Optional
assets[].mediumURL string Optional
assets[].modified int64 Optional
assets[].name string Optional
assets[].origURL string Optional
assets[].priority int32 Optional
assets[].publicURL string Optional
assets[].secured boolean Optional
assets[].thumbURL string Optional
assets[].type string

Possible values are:

  • Photo
  • Document
  • Kml
Optional
assets[].updated boolean Optional
companyId string Optional
created int64 Optional
customerCompanyId string Optional
deleted boolean Optional
dirty boolean Optional
email string Optional
employeeId string Optional
firstName string Optional
id string Optional
lastName string Optional
modified int64 Optional
note object Note Optional
note.created int64 Optional
note.deleted boolean Optional
note.enableOnFleet boolean Optional
note.id string Optional
note.message string Optional
note.modified int64 Optional
note.updated boolean Optional
note.writerId string Optional
note.writerName string Optional
officeNumber string Optional
phoneNumber string Optional
role string Optional
salutation string Optional
shopId string Optional
updated boolean Optional
userPhoto object CompanyAsset Optional
userPhoto.active boolean Optional
userPhoto.assetType string

Possible values are:

  • Photo
  • Document
  • Kml
Optional
userPhoto.companyId string Optional
userPhoto.created int64 Optional
userPhoto.deleted boolean Optional
userPhoto.id string Optional
userPhoto.key string Optional
userPhoto.largeURL string Optional
userPhoto.largeX2URL string Optional
userPhoto.mediumURL string Optional
userPhoto.modified int64 Optional
userPhoto.name string Optional
userPhoto.origURL string Optional
userPhoto.priority int32 Optional
userPhoto.publicURL string Optional
userPhoto.secured boolean Optional
userPhoto.thumbURL string Optional
userPhoto.type string

Possible values are:

  • Photo
  • Document
  • Kml
Optional
userPhoto.updated boolean Optional

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

successful operation

CompanyContact

Explore this API

contactId
body
Request Content-Type
Response Content-Type
Try it out!