> ## 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. > Queues a push of a user's lemlist profile picture onto the mailboxes they bought through lemlist. # Sync Sender Picture export const SnippetObjectReference = ({objectName, objectPath = null}) => { const lowerCaseObjectName = objectName.toLowerCase(); if (lowerCaseObjectName === 'lead' || lowerCaseObjectName === 'leads') { return This endpoint uses the {objectName} object. Make sure to also check the {lowerCaseObjectName === 'lead' ? 'Contact' : 'Lead'} object to understand the distinction between the two. ; } return This endpoint uses the {objectName} object. ; }; ## Choosing a scope | scope | Mailboxes pushed | Target | | - | - | - | | `not_synced` (default) | Every mailbox of the user that is not up to date. Synced ones are left alone. | The API key owner, or `userId` | | `all` | Every mailbox of the user, synced ones pushed again. | The API key owner, or `userId` | | `mailbox` | One mailbox, pushed again even when it is already synced. | `mailboxId` or `email` (required). `userId` is ignored: the mailbox's own owner's picture is pushed. | Pushing a synced mailbox again is useful when its picture was changed by hand on Google or Microsoft: lemlist cannot see that change, so the mailbox still reads `synced`. Mailboxes already `queued` or `syncing` are never queued twice. `enqueued` is `0` when every mailbox in scope is already up to date or already being pushed. The call only queues the push; there is no confirmation step. A background job processes the queue about every minute, and a Google Workspace mailbox takes a few tens of seconds more. Follow the progress with [Get Sender Picture Status](/api-reference/endpoints/sender-picture/get-sender-picture-status). This endpoint is in closed beta. It answers `403` with the code `BETA_NOT_ENABLED` unless the sender picture beta is enabled for your team. ## OpenAPI ````yaml post /sender-picture/sync 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: /sender-picture/sync: post: tags: - Sender picture summary: Sync Sender Picture description: >- Queues a push of a user's lemlist profile picture onto the Google Workspace and Microsoft 365 mailboxes they bought through lemlist, so recipients see it next to their emails. The push is asynchronous: the call only queues it. A background job processes the queue about every minute, and a Google Workspace mailbox takes a few tens of seconds more. Follow the progress with [Get Sender Picture Status](/api-reference/endpoints/sender-picture/get-sender-picture-status). There is no confirmation step: the mailboxes are queued as soon as the call succeeds. This endpoint is in closed beta and answers `403` unless the beta is enabled for your team. operationId: syncSenderPicture requestBody: required: false content: application/json: schema: type: object additionalProperties: false properties: scope: type: string enum: - not_synced - all - mailbox default: not_synced description: >- `not_synced`: every mailbox of the user that is not up to date; synced ones are left alone. `all`: every mailbox of the user, synced ones pushed again. `mailbox`: one mailbox, pushed again even when already synced. mailboxId: type: string description: >- `scope=mailbox` only: the mailbox to push, as returned by Get Sender Picture Status. Either `mailboxId` or `email` is required with `scope=mailbox`. example: dem_Xq7Lm2Pz9Rt4Vb8Nc email: type: string format: email description: >- `scope=mailbox` only: the address of the mailbox to push, instead of `mailboxId`. example: john@example.com userId: type: string description: >- `scope=not_synced` or `scope=all` only: a teammate whose mailboxes to push. Omit to push the API key owner's. Ignored with `scope=mailbox`, which always pushes the picture of the mailbox's own owner. example: usr_Tn8Bv2Mc4Xz6Lq1Pw examples: notSynced: summary: Push every mailbox not up to date value: {} oneMailbox: summary: Push one mailbox again value: scope: mailbox mailboxId: dem_Xq7Lm2Pz9Rt4Vb8Nc responses: '200': description: Mailboxes queued content: application/json: schema: $ref: '#/components/schemas/SenderPictureSyncResponse' example: data: enqueued: 1 mailboxes: - mailboxId: dem_Hw3Jk6Ds1Fy5Gu0Ea email: john@acme.com provider: m365 '400': description: >- Validation error - unknown field, invalid `scope`, or `scope=mailbox` without `mailboxId` or `email` content: application/json: schema: $ref: '#/components/schemas/SenderPictureError' example: error: Invalid sender picture request. code: SENDER_PICTURE_INVALID_INPUT '401': description: Unauthorized - invalid or missing API key content: application/json: schema: $ref: '#/components/schemas/SenderPictureError' example: error: Route unauthorized code: ROUTE_UNAUTHORIZED '403': description: >- The beta is not enabled for your team, or `userId` is not a member of your team content: application/json: schema: $ref: '#/components/schemas/SenderPictureError' examples: betaNotEnabled: value: error: Beta is not enabled code: BETA_NOT_ENABLED userNotInTeam: value: error: This user is not a member of your team. code: SENDER_PICTURE_USER_NOT_IN_TEAM '404': description: >- `scope=mailbox`: your team has no active mailbox with this `mailboxId` or `email` content: application/json: schema: $ref: '#/components/schemas/SenderPictureError' example: error: This mailbox no longer exists. code: SENDER_PICTURE_MAILBOX_NOT_FOUND '422': description: >- Nothing can be pushed: no mailbox in scope was bought through lemlist on Google Workspace or Microsoft 365, or the user has no lemlist profile picture content: application/json: schema: $ref: '#/components/schemas/SenderPictureError' examples: notSupported: value: error: >- Only Google Workspace and Microsoft 365 mailboxes bought through lemlist can have their picture synced. code: SENDER_PICTURE_NOT_SUPPORTED noSource: value: error: >- Upload a profile picture before syncing it to your mailboxes. code: SENDER_PICTURE_NO_SOURCE '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/SenderPictureError' example: error: Internal error code: INTERNAL_ERROR components: schemas: SenderPictureSyncResponse: type: object properties: data: type: object properties: enqueued: type: integer description: >- How many mailboxes were queued. `0` when every mailbox in scope is already synced or already being pushed. mailboxes: type: array description: The mailboxes targeted by the sync items: type: object properties: mailboxId: type: string email: type: string format: email provider: type: string enum: - google - m365 SenderPictureError: type: object description: Error envelope returned by the sender picture endpoints. properties: error: type: string description: Human-readable explanation of the failure code: type: string description: Machine-readable error code, stable across releases securitySchemes: basicAuth: type: http scheme: basic ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.