Authentication Check
Validates the API key and checks the Zapier integration authentication status. If the integration status is not connected, updates it to connected and activates the integration.
Headers
x-api-keystring · requiredAPI key for authentication
Responses
messagestring · requiredStatus message
Example: Authorization successfulintegrationobject · requiredIntegration information
messagestring · requiredIf the integration is disabled in LocalProf app, response with status 200 and message
Example: Integration is not active
Create a new contact
Creates a new contact for the tenant associated with the provided API key. At least one of email or phone is required.
Headers
x-api-keystring · requiredAPI key for authentication
Request Body
namestring · requiredFull name of the contact
Example: John Doe
emailstring · emailEmail address of the contact
Example: john.doe@example.comphonestringPhone number of the contact
Example: +15551234567externalIdstringExternal identifier for the contact
Example: cust_12345addressstringStreet address of the contact
Example: 123 Main StcitystringCity of the contact
Example: San FranciscostatestringState or province of the contact
Example: CAzipstringZIP or postal code of the contact
Example: 94105countrystringCountry of the contact
Example: United StatesbirthdaystringBirthday of the contact
Example: 1990-01-15
Responses
idstring · requiredUnique identifier of the created contact
Example: e0c77ed0-48a1-4b3d-a0fe-f0b1e3984089namestring · requiredName of the contact
Example: John DoeemailstringEmail of the contact
Example: john.doe@example.comphonestringPhone number of the contact
Example: +15551234567externalIdstringExternal ID of the contact
Example: cust_12345addressstringStreet address of the contact
Example: 123 Main StcitystringCity of the contact
Example: San FranciscostatestringState or province of the contact
Example: CAzipstringZIP or postal code of the contact
Example: 94105countrystringCountry of the contact
Example: United Statesbirthdaystring · dateBirthday of the contact
Example: 1990-01-15
Create a review request
Creates a review request for an existing contact identified by email, phone or externalId. Requires API authentication via x-api-key header.
Headers
x-api-keystring · requiredAPI key for authentication
Request Body
emailstringEmail address of the existing contact
Example: john.doe@example.comphonestringPhone number of the existing contact
Example: +15551234567externalIdstringExternal identifier for the existing contact
Example: cust_12345
Responses
messagestringSuccess message
Example: Review request created for John Doecontactobject