Update the Contact Info Email

From docs
Revision as of 11:21, 17 July 2026 by Ashley DeBon (talk | contribs) (Created page with "== Update Contact Info Email == === Base URL === https://apimobile.callproof.com === Endpoint === /api/contacts/{id}/info-email/{email_id}/info-personnel-email/{personnel_id...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Update Contact Info Email

Base URL

https://apimobile.callproof.com

Endpoint

/api/contacts/{id}/info-email/{email_id}/info-personnel-email/{personnel_id}

Purpose

Updates an email address for a contact. Depending on the path and body values, this can update:

  • an additional company email (`email_id` is a real ID and `contact_type` is not provided / is `0`)
  • a person’s (personnel) email (`personnel_id` is a real ID and `contact_type` is not provided / is `0`)
  • the contact’s primary email (`contact_type` is provided with a non-zero value)

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
email_id integer Yes Unique identifier of the additional company email to update. Use 0 when updating a personnel or primary email instead
personnel_id integer Yes Unique identifier of the person whose email should be updated. Use 0 when updating a company or primary email instead

Query Parameters

None.

Request Body

Parameter Type Required Description
email string Yes New email address (must be a valid email format and must be unique among contact info emails)
contact_type integer No Contact type identifier. When provided (non-zero), updates the contact’s primary email for that contact type. When omitted or 0, the update applies to the company email or personnel email based on the path IDs

Successful Response (200)

Indicates that the email was updated (or added for a person who previously had none) 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, "Email was successfully updated." or "Email successfully added.")
uri string Requested resource URI

Error Responses

Status Code Meaning
200 Validation failed – response body uses clientStatusCode 401 with the first validation error message
400 Bad Request – the email could not be updated
401 Unauthorized – missing, invalid, or expired Bearer token
  • Validation (HTTP 200, clientStatusCode 401) – Missing email, invalid email format, or email already exists.
  • 400 – Contact not found, invalid combination of email_id / personnel_id / contact_type (for example, "Email_id/Personnel_id not passed."), or another update error (for example, "Error While Updating Contact Info Email", "Error While Updating Personnel Info Email", or "Error while Updating Contact Email").
  • 401 – Authentication failed or the access token is missing/expired.