Lead forms
List lead forms
Lists the lead forms of the organization. It never returns their keys. Read only. It is safe to repeat.
Required scope: lead-forms:read.
query Parameters
limitcursorThe nextCursor of the previous page, with the same filters.
Headers
Lelemon-Subaccount^sub_[0-9A-Za-z]{22}…The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.
List lead forms › Responses
objecthasMorenextCursorCreate a lead form
Creates the form active, with the key the website sends with each lead. The key is returned in secret only here and cannot be read again. A pipeline that does not exist in the organization is a 400 with param pipelineId.
Required scope: lead-forms:write.
Headers
Lelemon-Subaccount^sub_[0-9A-Za-z]{22}…The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.
Idempotency-KeyMakes the request safe to retry. Once it starts running, its final response (2xx, 4xx or 5xx) is kept for 24 hours and the same key gets it back, without repeating the effect. A request rejected before it runs leaves the key free. A replayed create omits the secret. The same key with a different request is rejected with 409 idempotency_key_reused.
Create a lead form › Request Body
nameForm name
pipelineIdThe pipeline where the leads of this form start. A pipeline that does not exist in the organization is a 400 with param pipelineId.
tagsTags auto-applied to leads
source^[a-z0-9_-]+$Source label for the entity
Create a lead form › Responses
objectidnamepipelineIdThe pipeline where the leads of this form start.
tagssourcestatusAn inactive form does not accept leads.
keyPrefixThe first characters of the key, to tell which key a website has. It is not the key.
createdAtupdatedAtsecretThe key the website sends with each lead. It is shown only here; keep it.
Retrieve a lead form
Returns one lead form by id. Use it to refresh a single record you already know; to find records, use the list route. Read only. 404 not_found when the id does not exist or belongs to another organization. You can repeat it safely: it has no side effects.
Required scope: lead-forms:read.
path Parameters
id^lfm_[0-9A-Za-z]{22}… · requiredThe id of the lead form (lfm_…).
Headers
Lelemon-Subaccount^sub_[0-9A-Za-z]{22}…The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.
Retrieve a lead form › Responses
objectidnamepipelineIdThe pipeline where the leads of this form start.
tagssourcestatusAn inactive form does not accept leads.
keyPrefixThe first characters of the key, to tell which key a website has. It is not the key.
createdAtupdatedAtDelete a lead form
The key of the form stops working. The leads it already brought are not deleted. 404 not_found when the id does not exist or belongs to another organization.
Required scope: lead-forms:write.
path Parameters
id^lfm_[0-9A-Za-z]{22}… · requiredThe id of the lead form (lfm_…).
Headers
Lelemon-Subaccount^sub_[0-9A-Za-z]{22}…The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.
Delete a lead form › Responses
Update a lead form
Only the fields you send change. tags replaces the whole list. Set status to inactive to stop accepting leads without deleting the form. A pipeline that does not exist in the organization is a 400 with param pipelineId.
Required scope: lead-forms:write.
path Parameters
id^lfm_[0-9A-Za-z]{22}… · requiredThe id of the lead form (lfm_…).
Headers
Lelemon-Subaccount^sub_[0-9A-Za-z]{22}…The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.
Update a lead form › Request Body optional
nameForm name
tagsTags auto-applied to leads
source^[a-z0-9_-]+$Source label
statuspipelineIdMoves the form to another pipeline. A pipeline that does not exist in the organization is a 400 with param pipelineId.
Update a lead form › Responses
objectidnamepipelineIdThe pipeline where the leads of this form start.
tagssourcestatusAn inactive form does not accept leads.
keyPrefixThe first characters of the key, to tell which key a website has. It is not the key.
createdAtupdatedAt