LidmeoDevelopers

Scopes

What each scope allows, and the operations that need it.

An API key or an OAuth connection carries scopes. An operation that needs one it lacks answers 403 insufficient_scope, with required_scopes. Scopes marked "commits" send something, spend credits or change a campaign. A new key gets the scopes marked "given by default"; you tick sends:write deliberately. When an application connects, each requested scope is shown and can be unticked.

account:read

Read your activity and statistics

Given by default to a new key.

Operations: GET /v1/accounts, GET /v1/overview, GET /v1/activity, GET /v1/credits, GET /v1/onboarding, GET /v1/onboarding/review, POST /v1/onboarding/preview_prospects, GET /v1/campaigns, POST /v1/campaigns/preview_target, GET /v1/campaigns/{id}, GET /v1/campaigns/{id}/stats, GET /v1/campaigns/{id}/health, GET /v1/campaigns/{id}/sequence, GET /v1/sequence_templates, POST /v1/campaigns/{id}/preview_message, GET /v1/closer/agent, POST /v1/closer/agent/test, GET /v1/closer/knowledge, GET /v1/closer/goals, GET /v1/closer/goals/{id}, GET /v1/closer/agenda, GET /v1/settings/connections, GET /v1/settings/sending, GET /v1/settings/email_preferences, GET /v1/settings/prospecting, GET /v1/support/messages, POST /v1/support/messages

prospects:read

Read your prospects and CRM

Given by default to a new key.

Operations: GET /v1/prospects, POST /v1/prospects/search, GET /v1/prospects/{id}, GET /v1/prospects/{id}/timeline, GET /v1/prospects/{id}/notes, POST /v1/exports, POST /v1/people/search, GET /v1/agents, GET /v1/agents/{agent}, GET /v1/closer/goals/{id}, GET /v1/stages, GET /v1/lists, GET /v1/suppressions, GET /v1/imports/{id}, GET /v1/sequence_steps, GET /v1/enrichment_jobs/{id}, GET /v1/events, GET /v1/events/{id}

contacts:read

See the emails and phone numbers found

Given by default to a new key.

Operations: POST /v1/exports

conversations:read

Read your conversations

Given by default to a new key.

Operations: GET /v1/conversations, GET /v1/conversations/search, GET /v1/conversations/{id}, PATCH /v1/conversations/{id}, GET /v1/conversations/{id}/messages, GET /v1/closer/replies, GET /v1/closer/replies/{id}, PATCH /v1/closer/replies/{id}, POST /v1/closer/replies/{id}/send, GET /v1/conversations/{id}/closer, PUT /v1/conversations/{id}/closer_mode

prospects:write

Update your CRM (stages, lists, reminders, notes)

Given by default to a new key.

Operations: PUT /v1/prospects, PATCH /v1/prospects/{id}, DELETE /v1/prospects/{id}, POST /v1/prospects/{id}/notes, PATCH /v1/prospects/{id}/notes/{note_id}, DELETE /v1/prospects/{id}/notes/{note_id}, PUT /v1/prospects/{id}/external_ids, PATCH /v1/conversations/{id}, PATCH /v1/closer/replies/{id}, PUT /v1/conversations/{id}/closer_mode, POST /v1/closer/conversions, DELETE /v1/closer/conversions/{id}, POST /v1/closer/conversions/{id}/called, DELETE /v1/closer/conversions/{id}/called, POST /v1/closer/meetings, PATCH /v1/closer/meetings/{id}, POST /v1/closer/meetings/{id}/cancel, POST /v1/stages, PATCH /v1/stages/{id}, DELETE /v1/stages/{id}, POST /v1/lists, PATCH /v1/lists/{id}, DELETE /v1/lists/{id}, POST /v1/lists/{id}/members, DELETE /v1/lists/{id}/members/{prospect_id}, POST /v1/suppressions, DELETE /v1/suppressions/{id}, POST /v1/imports, POST /v1/test/reset, POST /v1/test/simulate

sends:write

Send invitations and messages on your behalf, within your sending limits (commits your account)

Operations: POST /v1/campaigns/{id}/launch, POST /v1/campaigns/{id}/add_prospects, POST /v1/agents/{agent}/add_people, POST /v1/closer/replies/{id}/send, POST /v1/closer/meetings/{id}/cancel, POST /v1/prospects/{id}/approve_invitation, POST /v1/prospects/{id}/approve_message, POST /v1/prospects/{id}/messages, POST /v1/prospects/{id}/drafts, POST /v1/prospects/{id}/cancel_follow_up, POST /v1/sequence_steps/approve

enrichment:write

Use your enrichment credits (commits your account)

Given by default to a new key.

Operations: POST /v1/people/add, POST /v1/enrichment_jobs, POST /v1/prospects/{id}/enrich

campaigns:write

Update your campaigns (commits your account)

Given by default to a new key.

Operations: PATCH /v1/onboarding, POST /v1/onboarding/analyze_website, POST /v1/onboarding/finish, POST /v1/campaigns, PATCH /v1/campaigns/{id}, DELETE /v1/campaigns/{id}, PATCH /v1/campaigns/{id}/settings, PUT /v1/campaigns/{id}/sequence, POST /v1/campaigns/{id}/sequence/apply_template, POST /v1/campaigns/{id}/reanalyze_website, POST /v1/campaigns/{id}/launch, POST /v1/campaigns/{id}/remove_prospects, POST /v1/people/add, PATCH /v1/agents/{agent}, PATCH /v1/closer/agent, POST /v1/closer/knowledge, PATCH /v1/closer/knowledge/{id}, DELETE /v1/closer/knowledge/{id}, POST /v1/closer/goals, PATCH /v1/closer/goals/{id}, DELETE /v1/closer/goals/{id}, POST /v1/closer/goals/{id}/resources, PATCH /v1/closer/goal_resources/{id}, DELETE /v1/closer/goal_resources/{id}, PATCH /v1/settings/sending, PATCH /v1/settings/email_preferences, PUT /v1/settings/prospecting, PUT /v1/settings/quota_split

webhooks:manage

Manage webhooks

Given by default to a new key.

Operations: GET /v1/webhook_endpoints, POST /v1/webhook_endpoints, GET /v1/webhook_endpoints/{id}, PATCH /v1/webhook_endpoints/{id}, DELETE /v1/webhook_endpoints/{id}, POST /v1/webhook_endpoints/{id}/rotate_secret, POST /v1/webhook_endpoints/{id}/test, GET /v1/webhook_endpoints/{id}/deliveries, POST /v1/webhook_endpoints/{id}/deliveries/{delivery_id}/retry

On this page