Scopes de la API (permisos) · Documentación SuperLeads

Los nombres de los scopes y las rutas de endpoints/webhooks se dejan en su forma técnica original (en ingles), ya que son valores exactos que debes usar tal cual al configurar tu integración — traducirlos los volveria inutilizables. La columna Tipo de acceso si esta en español.

Scopes

Esta es la lista de scopes que necesitas para acceder a los endpoints de la API y a los eventos de webhook.

Scope	Endpoints de la API	Eventos de Webhook	Tipo de acceso
businesses.readonly	GET /businesses		Sub-cuenta
	GET /businesses/:businessId		Sub-cuenta
businesses.write	POST /businesses		Sub-cuenta
	PUT /businesses/:businessId		Sub-cuenta
	DELETE /businesses/:businessId		Sub-cuenta
calendars.write	POST /calendars/		Sub-cuenta
	PUT /calendars/:calendarId		Sub-cuenta
	DELETE /calendars/:calendarId		Sub-cuenta
calendars.readonly	GET /calendars/		Sub-cuenta
	GET /calendars/:calendarId		Sub-cuenta
	GET /calendars/:calendarId/free-slots		Sub-cuenta
calendars/groups.readonly	GET /calendars/groups		Sub-cuenta
calendars/groups.write	POST /calendars/groups		Sub-cuenta
	POST /calendars/groups/validate-slug		Sub-cuenta
	DELETE /calendars/groups/:groupId		Sub-cuenta
	PUT /calendars/groups/:groupId		Sub-cuenta
	PUT /calendars/groups/:groupId/status		Sub-cuenta
calendars/resources.readonly	GET /calendars/resources/:resourceType		Sub-cuenta
	GET /calendars/resources/:resourceType/:id		Sub-cuenta
calendars/resources.write	POST /calendars/resources		Sub-cuenta
	PUT /calendars/resources/:resourceType/:id		Sub-cuenta
	DELETE /calendars/resources/:resourceType/:id		Sub-cuenta
calendars/events.readonly	GET /calendars/events/appointments/:eventId		Sub-cuenta
	GET /calendars/events		Sub-cuenta
	GET /calendars/blocked-slots		Sub-cuenta
	GET /calendars/appointments/:appointmentId/notes		Sub-cuenta
	GET /calendars/:calendarId/notifications/:notificationId		Sub-cuenta
	GET /calendars/:calendarId/notifications		Sub-cuenta
calendars/events.write	DELETE /calendars/events/:eventId		Sub-cuenta
	POST /calendars/events/block-slots		Sub-cuenta
	PUT /calendars/events/block-slots/:eventId		Sub-cuenta
	POST /calendars/events/appointments		Sub-cuenta
	PUT /calendars/events/appointments/:eventId		Sub-cuenta
	POST /calendars/appointments/:appointmentId/notes		Sub-cuenta
	PUT /calendars/appointments/:appointmentId/notes/:noteId		Sub-cuenta
	DELETE /calendars/appointments/:appointmentId/notes/:noteId		Sub-cuenta
	POST /calendars/:calendarId/notifications		Sub-cuenta
	PUT /calendars/:calendarId/notifications/:notificationId		Sub-cuenta
	DELETE /calendars/:calendarId/notifications/:notificationId		Sub-cuenta
campaigns.readonly	GET /campaigns/	CampaignStatusUpdate	Sub-cuenta
contacts.readonly	GET /contacts/:contactId	ContactCreate	Sub-cuenta
	GET /contacts/:contactId/tasks	ContactDelete	Sub-cuenta
	GET /contacts/:contactId/tasks/:taskId	ContactDndUpdate	Sub-cuenta
	GET /contacts/:contactId/notes	ContactTagUpdate	Sub-cuenta
	GET /contacts/:contactId/notes/:id	NoteCreate	Sub-cuenta
	GET /contacts/:contactId/appointments	NoteDelete	Sub-cuenta
	GET /contacts/	TaskCreate	Sub-cuenta
	GET /contacts/business/:businessId	TaskDelete	Sub-cuenta
contacts.write	POST /contacts/		Sub-cuenta
	PUT /contacts/:contactId		Sub-cuenta
	DELETE /contacts/:contactId		Sub-cuenta
	POST /contacts/:contactId/tasks		Sub-cuenta
	PUT /contacts/:contactId/tasks/:taskId		Sub-cuenta
	PUT /contacts/:contactId/tasks/:taskId/completed		Sub-cuenta
	DELETE /contacts/:contactId/tasks/:taskId		Sub-cuenta
	POST /contacts/:contactId/tags		Sub-cuenta
	DELETE /contacts/:contactId/tags		Sub-cuenta
	POST /contacts/:contactId/notes		Sub-cuenta
	PUT /contacts/:contactId/notes/:id		Sub-cuenta
	DELETE /contacts/:contactId/notes/:id		Sub-cuenta
	POST /contacts/:contactId/campaigns/:campaignId		Sub-cuenta
	DELETE /contacts/:contactId/campaigns/removeAll		Sub-cuenta
	DELETE /contacts/:contactId/campaigns/:campaignId		Sub-cuenta
	POST /contacts/:contactId/workflow/:workflowId		Sub-cuenta
	DELETE /contacts/:contactId/workflow/:workflowId		Sub-cuenta
objects/schema.readonly	GET /objects/:key		Sub-cuenta
	GET /objects		Sub-cuenta
objects/schema.write			Sub-cuenta
objects/record.readonly	GET /objects/:schemaKey/records/:id		Sub-cuenta
objects/record.write	POST /objects/:schemaKey/records		Sub-cuenta
	PUT /objects/:schemaKey/records/:id		Sub-cuenta
	DELETE /objects/:schemaKey/records/:id		Sub-cuenta
conversations.readonly	GET /conversations/:conversationsId	ConversationUnreadWebhook	Sub-cuenta
	GET /conversations/search		Sub-cuenta
conversations.write	POST /conversations/		Sub-cuenta
	PUT /conversations/:conversationsId		Sub-cuenta
	DELETE /conversations/:conversationsId		Sub-cuenta
conversations/message.readonly	GET conversations/messages/:messageId/locations/:locationId/recording	InboundMessage	Sub-cuenta
		OutboundMessage	Sub-cuenta
	GET conversations/locations/:locationId/messages/:messageId/transcription	InboundMessage	Sub-cuenta
		OutboundMessage	Sub-cuenta
	GET conversations/locations/:locationId/messages/:messageId/transcription/download	InboundMessage	Sub-cuenta
		OutboundMessage
conversations/message.write	POST /conversations/messages	ConversationProviderOutboundMessage	Sub-cuenta
	POST /conversations/messages/inbound		Sub-cuenta
	POST /conversations/messages/upload		Sub-cuenta
	PUT /conversations/messages/:messageId/status		Sub-cuenta
	DELETE /conversations/messages/:messageId/schedule		Sub-cuenta
	DELETE /conversations/messages/email/:emailMessageId/schedule		Sub-cuenta
conversations/livechat.write	POST /conversations/providers/live-chat/typing		Sub-cuenta
forms.readonly	GET /forms/		Sub-cuenta
	GET /forms/submissions		Sub-cuenta
invoices.readonly	GET /invoices/		Sub-cuenta
	GET /invoices/:invoiceId		Sub-cuenta
	GET /invoices/generate-invoice-number		Sub-cuenta
invoices.write	POST /invoices		Sub-cuenta
	PUT /invoices/:invoiceId		Sub-cuenta
	DELETE /invoices/:invoiceId		Sub-cuenta
	POST /invoices/:invoiceId/send		Sub-cuenta
	POST /invoices/:invoiceId/void		Sub-cuenta
	POST /invoices/:invoiceId/record-payment		Sub-cuenta
	POST /invoices/text2pay		Sub-cuenta
invoices/schedule.readonly	GET /invoices/schedule/		Sub-cuenta
	GET /invoices/schedule/:scheduleId		Sub-cuenta
invoices/schedule.write	POST /invoices/schedule		Sub-cuenta
	PUT /invoices/schedule/:scheduleId		Sub-cuenta
	DELETE /invoices/schedule/:scheduleId		Sub-cuenta
	POST /invoices/schedule/:scheduleId/schedule		Sub-cuenta
	POST /invoices/schedule/:scheduleId/auto-payment		Sub-cuenta
	POST /invoices/schedule/:scheduleId/cancel		Sub-cuenta
invoices/template.readonly	GET /invoices/template/		Sub-cuenta
	GET /invoices/template/:templateId		Sub-cuenta
invoices/template.write	POST /invoices/template/		Sub-cuenta
	PUT /invoices/template/:templateId		Sub-cuenta
	DELETE /invoices/template/:templateId		Sub-cuenta
links.readonly	GET /links/		Sub-cuenta
links.write	POST /links/		Sub-cuenta
	PUT /links/:linkId		Sub-cuenta
	DELETE /links/:linkId		Sub-cuenta
locations.readonly	GET /locations/:locationId	LocationCreate	Sub-Account, Agency
		LocationUpdate	Sub-Account, Agency
	GET /locations/search		Sub-Account, Agency
	GET /locations/timeZones		Sub-cuenta
locations.write	POST /locations/		Agencia
	PUT /locations/:locationId		Agencia
	DELETE /locations/:locationId		Agencia
locations/customValues.readonly	GET /locations/:locationId/customValues		Sub-cuenta
	GET /locations/:locationId/customValues/:id		Sub-cuenta
locations/customValues.write	POST /locations/:locationId/customValues		Sub-cuenta
	PUT /locations/:locationId/customValues/:id		Sub-cuenta
	DELETE /locations/:locationId/customValues/:id		Sub-cuenta
locations/customFields.readonly	GET /locations/:locationId/customFields		Sub-cuenta
	GET /locations/:locationId/customFields/:id		Sub-cuenta
	GET /custom-fields/:id		Sub-cuenta
	GET /custom-field/object-key/:key		Sub-cuenta
locations/customFields.write	POST /locations/:locationId/customFields		Sub-cuenta
	PUT /locations/:locationId/customFields/:id		Sub-cuenta
	DELETE /locations/:locationId/customFields/:id		Sub-cuenta
locations/tags.readonly	GET /locations/:locationId/tags		Sub-cuenta
	GET /locations/:locationId/tags/:tagId		Sub-cuenta
locations/tags.write	POST /locations/:locationId/tags/		Sub-cuenta
	PUT /locations/:locationId/tags/:tagId		Sub-cuenta
	DELETE /locations/:locationId/tags/:tagId		Sub-cuenta
locations/templates.readonly	GET /locations/:locationId/templates		Sub-cuenta
locations/tasks.readonly	POST /locations/:locationId/tasks/search		Sub-cuenta
medias.readonly	GET /medias/files		Sub-cuenta
medias.write	POST /medias/upload-file		Sub-cuenta
funnels/redirect.readonly	GET /funnels/lookup/redirect/list		Sub-cuenta
funnels/redirect.write	POST /funnels/lookup/redirect		Sub-cuenta
funnels/page.readonly	GET /funnels/page		Sub-cuenta
funnels/funnel.readonly	GET /funnels/funnel/list		Sub-cuenta
funnels/pagecount.readonly	GET /funnels/page/count		Sub-cuenta
	DELETE /funnels/lookup/redirect/:id		Sub-cuenta
	PATCH /funnels/lookup/redirect/:id		Sub-cuenta
	DELETE /medias/:fileId		Sub-cuenta
opportunities.readonly	GET /opportunities/search	OpportunityCreate	Sub-cuenta
	GET /opportunities/:id	OpportunityDelete	Sub-cuenta
	GET /opportunities/pipelines	OpportunityStageUpdate	Sub-cuenta
		OpportunityStatusUpdate	Sub-cuenta
		OpportunityMonetaryValueUpdate	Sub-cuenta
opportunities.write	DELETE /opportunities/:id		Sub-cuenta
	PUT /opportunities/:id/status		Sub-cuenta
	POST /opportunities		Sub-cuenta
	PUT /opportunities/:id		Sub-cuenta
payments/integration.readonly	GET /payments/integrations/provider/whitelabel		Sub-cuenta
payments/integration.write	POST /payments/integrations/provider/whitelabel		Sub-cuenta
payments/orders.readonly	GET /payments/orders/		Sub-cuenta
	GET /payments/orders/:orderId		Sub-cuenta
	GET /payments/orders/:orderId/fulfillments		Sub-cuenta
payments/orders.write	POST /payments/orders/:orderId/fulfillments		Sub-cuenta
payments/transactions.readonly	GET /payments/transactions/		Sub-cuenta
	GET /payments/transactions/:transactionId		Sub-cuenta
payments/subscriptions.readonly	GET /payments/subscriptions/		Sub-cuenta
	GET /payments/subscriptions/:subscriptionId		Sub-cuenta
products.readonly	GET /products/		Sub-cuenta
	GET /products/:productId		Sub-cuenta
products.write	POST /products/		Sub-cuenta
	PUT /products/:productId		Sub-cuenta
	DELETE /products/:productId		Sub-cuenta
products/prices.readonly	GET /products/:productId/price/		Sub-cuenta
	GET /products/:productId/price/:priceId		Sub-cuenta
products/prices.write	POST /products/:productId/price/		Sub-cuenta
	PUT /products/:productId/price/:priceId		Sub-cuenta
	DELETE /products/:productId/price/:priceId		Sub-cuenta
oauth.readonly	GET /oauth/installedLocations		Agencia
oauth.write	POST /oauth/locationToken		Agencia
saas/location.write	PUT /update-saas-subscription/:locationId		Agencia
	POST /enable-saas/:locationId		Sub-Account, Agency
saas/location.read	GET /locations		Sub-Account, Agency
saas/company.write	POST /bulk-disable-saas/:companyId		Sub-Account, Agency
snapshots.readonly	GET /snapshots		Agencia
socialplanner/account.readonly	GET /social-media-posting/:locationId/accounts		Sub-cuenta
socialplanner/account.write	DELETE /social-media-posting/:locationId/accounts/:id		Sub-cuenta
socialplanner/csv.readonly	GET /social-media-posting/:locationId/csv		Sub-cuenta
	GET /social-media-posting/:locationId/csv/:id		Sub-cuenta
socialplanner/csv.write	POST /social-media-posting/:locationId/csv		Sub-cuenta
	POST /social-media-posting/:locationId/set-accounts		Sub-cuenta
	DELETE /social-media-posting/:locationId/csv/:id		Sub-cuenta
	PATCH /social-media-posting/:locationId/csv/:id		Sub-cuenta
	POST /social-media-posting/:locationId/posts/bulk-delete		Sub-cuenta
	DELETE /social-media-posting/:locationId/csv/:csvId/post/:postId		Sub-cuenta
socialplanner/category.readonly	GET /social-media-posting/:locationId/categories		Sub-cuenta
	GET /social-media-posting/:locationId/categories/:id		Sub-cuenta
socialplanner/oauth.readonly	GET /social-media-posting/oauth/facebook/start		Sub-cuenta
	GET /social-media-posting/oauth/:locationId/facebook/accounts/:accountId		Sub-cuenta
	GET /social-media-posting/oauth/google/start		Sub-cuenta
	GET /social-media-posting/oauth/:locationId/google/locations/:accountId		Sub-cuenta
	GET /social-media-posting/oauth/instagram/start		Sub-cuenta
	GET /social-media-posting/oauth/:locationId/instagram/accounts/:accountId		Sub-cuenta
	GET /social-media-posting/oauth/linkedin/start		Sub-cuenta
	GET /social-media-posting/oauth/:locationId/linkedin/accounts/:accountId		Sub-cuenta
	GET /social-media-posting/oauth/tiktok/start		Sub-cuenta
	GET /social-media-posting/oauth/:locationId/tiktok/accounts/:accountId		Sub-cuenta
	GET /social-media-posting/oauth/tiktok-business/start		Sub-cuenta
	GET /social-media-posting/oauth/:locationId/tiktok-business/accounts/:accountId		Sub-cuenta
	GET /social-media-posting/oauth/twitter/start		Sub-cuenta
	GET /social-media-posting/oauth/:locationId/twitter/accounts/:accountId		Sub-cuenta
socialplanner/oauth.write	POST /social-media-posting/oauth/:locationId/facebook/accounts/:accountId		Sub-cuenta
	POST /social-media-posting/oauth/:locationId/google/locations/:accountId		Sub-cuenta
	POST /social-media-posting/oauth/:locationId/instagram/accounts/:accountId		Sub-cuenta
	POST /social-media-posting/oauth/:locationId/linkedin/accounts/:accountId		Sub-cuenta
	POST /social-media-posting/oauth/:locationId/tiktok/accounts/:accountId		Sub-cuenta
	POST /social-media-posting/oauth/:locationId/twitter/accounts/:accountId		Sub-cuenta
socialplanner/post.readonly	GET /social-media-posting/:locationId/posts/:id		Sub-cuenta
	POST /social-media-posting/:locationId/posts/list		Sub-cuenta
socialplanner/post.write	POST /social-media-posting/:locationId/posts		Sub-cuenta
	PUT /social-media-posting/:locationId/posts/:id		Sub-cuenta
	DELETE /social-media-posting/:locationId/posts/:id		Sub-cuenta
	PATCH /social-media-posting/:locationId/posts/:id		Sub-cuenta
socialplanner/tag.readonly	GET /social-media-posting/:locationId/tags		Sub-cuenta
	POST /social-media-posting/:locationId/tags/details		Sub-cuenta
surveys.readonly	GET /surveys/		Sub-cuenta
	GET /surveys/submissions		Sub-cuenta
users.readonly	GET /users/		Sub-Account, Agency
	GET /users/:userId		Sub-Account, Agency
users.write	POST /users/		Sub-Account, Agency
	DELETE /users/:userId		Sub-Account, Agency
	PUT /users/:userId		Sub-Account, Agency
workflows.readonly	GET /workflows/		Sub-cuenta
courses.write	POST courses/courses-exporter/public/import		Sub-cuenta
emails/builder.readonly	GET emails/builder		Sub-cuenta
emails/builder.write	POST emails/builder		Sub-cuenta
	POST /emails/builder/data		Sub-cuenta
	DELETE /emails/builder/:locationId/:templateId		Sub-cuenta
emails/schedule.readonly	GET emails/schedule		Sub-Account, Agency
blogs/post.write	POST /blogs/posts		Sub-cuenta
blogs/post-update.write	PUT /blogs/posts/:postId		Sub-cuenta
blogs/check-slug.readonly	GET /blogs/posts/url-slug-exists		Sub-cuenta
blogs/category.readonly	GET /blogs/categories		Sub-cuenta
blogs/author.readonly	GET /blogs/authors		Sub-cuenta
blogs/posts.readonly	GET /blogs/posts/all		Sub-cuenta
blogs/list.readonly	GET /blogs/site/all		Sub-cuenta