Business Card Usgae

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

Mobile_API »Store Business Card Usage

Base URL

https://apimobile.callproof.com

Endpoint

/api/business-card-usage

Purpose

Records that the authenticated user used the business card scanner. Stores a usage entry for the user and their company (no additional request fields are required).

HTTP Method

POST

Headers

Header Required Description
Authorization Yes Bearer access token

Security

  • Yes – Requires Bearer Token authentication.

Parameters

Path Parameters

None.

Query Parameters

None.

Request Body

None.

cURL Example for Android

 curl --location 'https://apimobile.callproof.com/api/business-card-usage' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' 

cURL Example for iOS

 curl --location 'https://apimobile.callproof.com/api/business-card-usage' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' 

Successful Response (200)

Indicates that business card usage was recorded 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, "User Business Card Usage Details Stored successfully")
uri string Requested resource URI

Error Responses

Status Code Meaning
400 Bad Request – usage could not be stored
401 Unauthorized – missing, invalid, or expired Bearer token
  • 400 – An error occurred while storing usage (for example, "Error while adding the business card details").
  • 401 – Authentication failed or the access token is missing/expired.