Update the Contact Personnel Details

From docs
Revision as of 08:40, 17 July 2026 by Ashley DeBon (talk | contribs) (Successful Response (200))
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Update Contact Personnel

Base URL

https://apimobile.callproof.com

Endpoint

/api/contacts/{id}/contact-personnel/{personnel_id}

Purpose

Updates an existing person associated with a specific contact. The request can change name, email, title, role, notes, phone numbers, and optionally the person’s image so the contact’s personnel record stays current.

HTTP Method

PUT

Headers

Header Required Description
Authorization Yes Bearer access token

Security

  • Yes – Requires Bearer Token authentication.

Parameters

Path Parameters

Parameter Type Required Description
id integer Yes Unique identifier of the contact that owns the personnel record
personnel_id integer Yes Unique identifier of the person to update

Query Parameters

None.

Request Body

Parameter Type Required Description
first_name string Yes First name of the person (maximum 73 characters)
last_name string No Last name of the person (maximum 30 characters)
email string No Email address (maximum 64 characters). Must be a valid email format when provided
title string No Job title (maximum 73 characters)
people_role_id integer No People role identifier for the person
phones string No JSON array of phone objects. Each object may include id (existing phone ID, or 0 for new), phone_number (maximum 15 characters), phone_type_id, country_code, and extension (maximum 6 characters)
contact_notes string No Notes associated with the person
contact_image file No Updated profile image file for the person
form_data string No JSON custom field data; used when an image-type custom field should store the uploaded image reference

cURL Example for Android

curl --location --request PUT 'https://apimobile.callproof.com/api/contacts/{id}/contact-personnel/{personnel_id}' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--form 'first_name=YOUR_FIRST_NAME'

cURL Example for iOS

curl --location --request PUT 'https://apimobile.callproof.com/api/contacts/{id}/contact-personnel/{personnel_id}' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--form 'first_name=YOUR_FIRST_NAME'

Successful Response (200)

Indicates that the contact person was updated successfully.

Field Type Description
clientStatusCode integer Status indicator for the client (for example, 200)
user_id integer Identifier of the authenticated user
company_id integer Identifier of the authenticated user’s company
message string Confirmation message (for example, "Contact Personnel Updated Successfully")
uri string Requested resource URI

Error Responses

Status Code Meaning
200 Validation failure – request body failed validation (returned with an error payload and clientStatusCode 401)
400 Bad Request – the contact person could not be updated
401 Unauthorized – missing, invalid, or expired Bearer token
  • 200 (validation failure) – Fields failed Form Request validation (for example, invalid email or invalid phones JSON / phone number or extension length).
  • 400 – First name is missing; a field exceeds its maximum length; the contact or personnel record was not found; a phone number conflict occurred ("Phone Number Already Exists"); or another error occurred while updating the person.
  • 401 – Authentication failed or the access token is missing/expired.