Organization
Get the organization
The name and slug of the organization or subaccount the key acts on.
Required scope: organization:read.
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.
Get the organization › Responses
objectidnameslugRename the organization
Changes the name, with the same rule as the panel. Only a key issued by the owner can use it. Idempotent: the same body leaves the same name.
Required scope: organization: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.
Rename the organization › Responses
objectidnameslugGet the organization settings
Business hours, inactivity closing, presence, trace storage and branding of the organization or subaccount the key acts on.
Required scope: organization:read.
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.
Get the organization settings › Responses
objectWhen the human team attends. Null until it is set. An agent in a stage set to answer outside business hours answers only outside this window.
cerrarTrasDiasSinActividadDays of silence after which a conversation closes by itself. Null means it never closes by inactivity. Until it is set, the house default applies.
presenceEnabledWhether presence shows. Same setting as /v2/presence/settings.
noPersistTracesWhile true, the traces of the agent turns are not stored.
Public branding of the organization: logo, color and links.
Change the organization settings
Merges the fields you send into the settings, with the same validation as the panel: business hours need a timezone, start and end hour from 0 to 23, and Saturday and Sunday flags. Send cerrarTrasDiasSinActividad null to turn the inactivity closing off. Idempotent: the same body leaves the same settings.
Required scope: settings: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.
Change the organization settings › Responses
objectWhen the human team attends. Null until it is set. An agent in a stage set to answer outside business hours answers only outside this window.
cerrarTrasDiasSinActividadDays of silence after which a conversation closes by itself. Null means it never closes by inactivity. Until it is set, the house default applies.
presenceEnabledWhether presence shows. Same setting as /v2/presence/settings.
noPersistTracesWhile true, the traces of the agent turns are not stored.
Public branding of the organization: logo, color and links.
Get the company profile
What the agents know about the business: name, description, contact, schedule, services, FAQ and custom instructions.
Required scope: organization:read.
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.
Get the company profile › Responses
objectbusinessNamebusinessDescriptionaddressphoneemailwebsiteschedulecustomInstructionsChange the company profile
Merges the fields you send into the profile; services and faq are replaced whole. Same validation as the panel. Idempotent: the same body leaves the same profile.
Required scope: settings: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.
Change the company profile › Responses
objectbusinessNamebusinessDescriptionaddressphoneemailwebsiteschedulecustomInstructions