> ## Documentation Index > Fetch the complete documentation index at: https://developer.lemlist.com/llms.txt > Use this file to discover all available pages before exploring further. > Deletes a custom field on contacts or companies, as the app does, with the same permission and the same campaign guard. # Delete Field ## OpenAPI ````yaml delete /fields/{entity}/{name} openapi: 3.0.0 info: title: lemlist API version: 1.0.0 description: >- Welcome to the lemlist Developer Documentation. lemlist is very customizable and open. You'll find on this page all the API and integration you can do with lemlist. # Rate Limit lemlist's API rate limits requests in order to prevent abuse and overload of our services. Rate limits are applied on all routes and per API key performing the request. The rate limits are **20** requests per **2** seconds. The response provides any information you may need about it: | Header | Description | | --- | --- | | Retry-After | The number of seconds in which you can retry | | X-RateLimit-Limit | The maximum requests in that time | | X-RateLimit-Remaining | The number of remaining requests you can make | | X-RateLimit-Reset | The date when the rate limit will reset | _Example of values for the rate limit headers_ ``` json { "Retry-After": 2, "X-RateLimit-Limit": 20, "X-RateLimit-Remaining": 7, "X-RateLimit-Reset" : "Tue Feb 16 2021 09:02:42 GMT+0100 (Central European Standard Time)" } ``` # Definitions ## Team A team is the entity of lemlist that can handle users and billing. ## Credits Credits are the coins a team uses to enrich emails, LinkedIn URLs, etc. via the enrich route. Each enrichment feature needs a certain amount of credits to run. ## User You use a user account to connect to lemlist and send messages via the connected emails or LinkedIn account. ## Campaign A campaign is the entity to automate outreach. A campaign has multiple sequences composed of steps. ## Lead A lead is a person that you try to contact via a campaign. ## Activity An activity is the history of all the steps. ## Unsubscribe An unsubscribe occurs when a person decides they don't want to receive emails from you anymore. # Authentication All API routes use the dedicated subdomain `api.lemlist.com`. lemlist uses API keys to allow access to the API. You can get your lemlist API key at our [integration page](https://app.lemlist.com/settings/integrations). You need to add the `Authorization` header using the `Basic` authentication type. `login:password` **where the login is always empty and the password is the API key**. ⚠️ **Don't forget to add the semicolon (**`:`**) before your API key in curl command.** > To authorize, use this code: ``` shell curl https://api.lemlist.com/api/team \ --user ":YourApiKey" ``` **Make sure to replace** **`YourApiKey`** **with your API key.** # Give feedback If you want to report a bug, ask for data, or share with us a use case, please fill this [form](https://lemlist.typeform.com/to/mfVlkyGf). It will help us centralize your needs! servers: - url: https://api.lemlist.com/api security: - basicAuth: [] tags: - name: Enrichment Providers description: >- The data providers lemlist can call to find an email or a phone. Internal providers are paid with lemlist credits and always available. External providers run on your own account: connect one by saving its API key, and it becomes available to your waterfalls. `GET /enrichments/providers` is the catalog of provider ids accepted by the waterfall endpoints. - name: Enrichment Waterfalls description: >- Control which data providers lemlist calls when enriching a contact, and in which order. A waterfall is an ordered list of providers for one enrichment `type` (`email` or `phone`). Providers are tried one after the other until one returns a result. Every team has exactly one default waterfall per type (`isDefault: true`). While its `editor` is `lemlist` it follows the lemlist behaviour: providers you connected with your own API key are tried first, then internal providers in a random order. Once a team member edits its provider list, `editor` becomes that user's id and the list is followed as is; resetting it hands it back to `lemlist`. Custom waterfalls (`isDefault: false`) carry `conditions` on the contact being enriched, keyed by contact property; every key present must match. When a contact is enriched, lemlist runs a single waterfall: the custom waterfall of the requested type whose conditions match the contact, or the default waterfall when none does. If several match, the one with the most condition keys wins, then the most recently updated. Only that waterfall runs; when it finds nothing, the enrichment ends without falling back to another one. paths: /fields/{entity}/{name}: delete: tags: - Fields summary: Delete Field description: >- Deletes a custom field, as the app does: the API key user needs the **Update contact & companies fields** permission; a contact field a campaign still picks its sender through is refused (`409`); then the field is removed from every contact or company of the team and from your CRM field mapping, and the deletion is logged in the team activity feed. The `name` is any stored field name, URL-encoded (a field created in the app may hold characters the API pattern refuses). parameters: - name: entity in: path required: true description: Entity the field belongs to schema: type: string enum: - contact - company - name: name in: path required: true description: The field `name`, URL-encoded schema: type: string responses: '200': description: Field deleted content: application/json: schema: type: object properties: success: type: boolean data: type: object properties: entity: type: string enum: - contact - company name: type: string deleted: type: boolean enum: - true required: - entity - name - deleted example: success: true data: entity: contact name: tier deleted: true '400': description: 'Bad request: `entity` not contact / company, or a malformed `name`.' content: application/json: schema: type: object properties: success: type: boolean error: type: object properties: code: type: string description: 'Error code: `INVALID_ENTITY_PARAM`, `INVALID_NAME`.' message: type: string examples: invalid-entity-param: summary: '`entity` missing or not contact / company' value: success: false error: code: INVALID_ENTITY_PARAM message: Invalid entity parameter. Must be "contact" or "company" invalid-name: summary: '`name` missing or off the pattern' value: success: false error: code: INVALID_NAME message: >- Invalid name. Must start with a lowercase letter followed by letters and digits only, at most 400 characters '401': description: Unauthorized content: application/json: schema: type: object properties: error: type: string example: error: Unauthorized '403': description: >- The API key user lacks the "Update contact & companies fields" permission, needed to update or delete a field (creating one needs none, as in the app). content: application/json: schema: type: object properties: success: type: boolean error: type: object properties: code: type: string description: 'Error code: `FIELD_PERMISSION_DENIED`.' message: type: string example: success: false error: code: FIELD_PERMISSION_DENIED message: >- The API key user is not allowed to update or delete custom fields (permission "Update contact & companies fields") '404': description: No custom field of that name on that entity content: application/json: schema: type: object properties: success: type: boolean error: type: object properties: code: type: string description: 'Error code: `FIELD_NOT_FOUND`.' message: type: string example: success: false error: code: FIELD_NOT_FOUND message: No custom field with this name on this entity '409': description: >- A campaign picks its sender through this contact field; `error.message` names the campaigns. content: application/json: schema: type: object properties: success: type: boolean error: type: object properties: code: type: string description: 'Error code: `FIELD_USED_AS_CAMPAIGN_SENDER`.' message: type: string example: success: false error: code: FIELD_USED_AS_CAMPAIGN_SENDER message: 'This field picks the sender of 1 campaign: Q4 outbound' components: securitySchemes: basicAuth: type: http scheme: basic ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.