Ashley DeBon: Created page with "== Create Contact == === Base URL === https://apimobile.callproof.com === Endpoint === /api/contacts === Purpose === Creates a new contact / account for the authenticated u..."

2026-07-17T07:23:44Z

Created page with "== Create Contact == === Base URL === https://apimobile.callproof.com === Endpoint === /api/contacts === Purpose === Creates a new contact / account for the authenticated u..."

New page

== Create Contact ==

=== Base URL ===
https://apimobile.callproof.com

=== Endpoint ===
/api/contacts

=== Purpose ===
Creates a new contact / account for the authenticated user’s company. The request captures company details, address, phone, email, website, and optional location information. On success, the new contact is saved, related notes and assignment activity can be recorded, and the newly created contact identifier is returned.

=== HTTP Method ===
POST

=== Headers ===
{| class="wikitable"
! Header !! Required !! Description
|-
| Authorization || Yes || Bearer access token
|}

=== Security ===
* '''Yes''' – Requires Bearer Token authentication.

=== Parameters ===

==== Path Parameters ====
None.

==== Query Parameters ====
None.

==== Request Body ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| company_name || string || Yes || Company / account name
|-
| account_type_id || integer || Yes || Contact / account type identifier
|-
| account_number || number / string || No || Account number
|-
| parent_company || string || No || Parent company / title
|-
| address || string || No || Primary street address (maximum 80 characters)
|-
| address2 || string || No || Secondary street address (maximum 80 characters)
|-
| city || string || No || City
|-
| state_id || integer || No || State identifier
|-
| zipcode || string || No || Postal / ZIP code
|-
| country_id || integer || No || Country identifier
|-
| company_email || string || No || Company email address. Must be a valid email format when provided
|-
| phone || string || No || Primary phone number (7–15 digits). When provided, phone type becomes required
|-
| extension || string || No || Phone extension
|-
| phone_type_id || integer || No || Phone type identifier. Required when <code>phone</code> is provided
|-
| country_code || string || No || Country calling code for the phone number
|-
| website || string || No || Website URL
|-
| notes || string || No || Notes to store with the new contact
|-
| contact_company_id || integer || No || Existing contact company identifier, when linking to an existing company record
|-
| is_business_upload || boolean || No || Indicates whether the contact is being created from a business card upload
|-
| business_card_id || integer || No || Business card identifier to associate with the new contact when created from a business card
|-
| latitude || string || No || Latitude used for location logging / geocoding of the new contact
|-
| longitude || string || No || Longitude used for location logging / geocoding of the new contact
|}

=== Successful Response (200) ===
Indicates that the contact was created successfully.

{| class="wikitable"
! 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, "{company_name} was added to Callproof Successfully")
|-
| contact_id || integer || Unique identifier of the newly created contact
|-
| uri || string || Requested resource URI
|}

=== Error Responses ===
{| class="wikitable"
! Status Code !! Meaning
|-
| 200 || Validation failure – request body failed validation (returned with an error payload and <code>clientStatusCode</code> 401)
|-
| 400 || Bad Request – the contact could not be created
|-
| 401 || Unauthorized – missing, invalid, or expired Bearer token
|}

* '''200 (validation failure)''' – Required fields are missing or invalid (for example, missing company name or account type, invalid email, invalid phone format, address too long, or missing phone type when a phone number is provided).
* '''400''' – An error occurred while creating the contact, phone details, notes, or related assignment information.
* '''401''' – Authentication failed or the access token is missing/expired.

Create a New Contact - Revision history

Ashley DeBon: Created page with "== Create Contact == === Base URL === https://apimobile.callproof.com === Endpoint === /api/contacts === Purpose === Creates a new contact / account for the authenticated u..."