Create a CRM Lead

post

https://{tenant}.latner.app/api/external/v1/crm/lead/

Create a lead in Latner's CRM pipeline from an enquiry captured in your own system.

branch and source are required and take Latner ids, which your Latner contact provides during onboarding; call_type is optional and likewise an id, and defaults to the tenant's default call type. The lead is created against the branch you name, so the token's account must hold EXTERNAL_API_CRM_LEAD_CREATE for that branch or the request returns 403.

name must be unique across every lead in the tenant, cancelled ones included. A second request with the same name is refused with 400, so an accidental resubmission is safe. Store the id from the 201 response if you need to reconcile later.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The request body for POST /crm/lead/.

name, description, branch and source are required; everything else is optional.
name must be unique across the tenant's leads - a repeat is refused with 400, not stored
twice. branch, source and call_type take Latner ids, which your Latner contact provides
during onboarding. start_date and end_date are YYYY-MM-DD.

name

string

required

description

string

required

notes

string | null

contact_name

string | null

contact_phone

string | null

contact_email

string | null

branch

integer

required

source

integer

required

address

object

start_date

date | null

end_date

date | null

call_type

integer

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

201

400The request body or query parameters failed validation. Body failures are keyed by field name, query-string failures by parameter name.

401The token is missing, malformed, expired, or not signed for this environment. Obtain a new access token - see Get Access Token via Kinde - rather than retrying.

403The token is valid, but the account behind it does not hold the permission this endpoint requires, or the record is outside the branches it can act in. Ask your Latner contact to grant the permission; retrying will not help.

429Rate limit exceeded: 60 requests per minute per account. The limit is shared by every token issued to the same service account or user, not counted per token. The response carries a Retry-After header with the number of seconds to wait.