Upnify CRM
← Back to product

CRM · Integrations

How to connect an external system through the Upnify API

Create a secure integration, exchange the token for a session, and choose the CRM routes that fit your workflow.

Illustration of credential exchange for connecting a system to the Upnify CRM API.

Published on October 27, 2026

The Upnify API connects CRM to your own or third-party systems so information does not have to be entered twice. It can help an internal app query prospects, send records from a sales platform, or coordinate a process with your development team.

Keep the flows separate: External systems integration provides credentials for an authorized application to use API routes. Prospect integration provides a receiving route for sending contacts. To embed a form on your website, see How to generate and install an Upnify HTML form.
Conceptual authentication diagram: integration token, session token, and CRM API routes.
The integration token is exchanged for a session; the session token accompanies authenticated requests.

Before you begin

  • Agree on what information the systems will exchange, in which direction, and how often.
  • Ask a CRM administrator to create the integration and a developer to implement the workflow.
  • Review the official CRM API documentation. Each operation describes its parameters, fields, and response.

1. Create an external systems integration

  1. In CRM, open Settings > Integrations > API and select Add integration.
  2. Choose Upnify in the catalog and select External systems integration.
  3. Name the project and configure any initial values CRM requests, such as owner, stage, source, or tags.
  4. Save. The details display its credentials. Share them with the technical team through a secure channel—not in shared documents or public code.
Current CRM form for configuring an external systems integration through the API.
Select External systems to set up access for your own application or a connected system.
Official Upnify API documentation showing the POST /prospectos endpoint and prospect creation parameters.
Check the current documentation to confirm the endpoint and fields required for each request.

2. Exchange the integration token for a session

The current guide recommends requesting a session with POST /integraciones/sesion, sending the integration token in the token header. Check that the response returns code: 0; its token field is the session token for authenticated routes.

POST https://api.upnify.com/integraciones/sesion
Accept: application/json
 token: INTEGRATION_TOKEN

A new session lasts two days. The documentation says to repeat the exchange to renew it when fewer than five hours remain. Keep both tokens and the expiration in secure server configuration.

3. Implement only the required operations

  1. Choose CRM routes for each task and verify required fields before coding.
  2. Use HTTPS and send the session token in the token header whenever a route requires authentication.
  3. Validate each response's code, message, and details; a completed connection does not always mean a record was processed as expected.
  4. Handle expired sessions, rejected data, and request limits. The documentation lists a general limit of 100 requests per minute; for HTTP 429, wait and retry gradually.
  5. Log only what is needed to diagnose; never store tokens or passwords in logs.

The documented authentication exchanges the integration token for a session token. If CRM also displays an authentication code, do not use it instead of the token in the guide; ask the technical team whether a particular integration needs it.

Example

A company wants its internal sales portal to query prospects registered in CRM. The administrator creates the integration; the developer obtains a session, queries documented routes, and displays only authorized data. If the portal must also create records, agree on fields and duplicate-handling rules before enabling submissions.

Security practice: keep credentials on the server, restrict access, use HTTPS, and rotate the token if it may have been exposed. Do not include it in public JavaScript where any visitor can read it.

See Getting started: authentication and first request and the CRM API documentation. If you only need to receive prospects through a URL, see How to receive prospects through an Upnify integration.