Scopes de la API (version anterior)
Nota: esta es la versión anterior (v1) de la tabla de scopes, conservada como referencia. Para integraciones nuevas usa la versión vigente en Scopes de la API.
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/groups | Sub-cuenta | ||
| GET /calendars/:calendarId | Sub-cuenta | ||
| GET /calendars/:calendarId/free-slots | Sub-cuenta | ||
| calendars/events.readonly | GET /calendars/events/appointments/:eventId | 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 | ||
| 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 | ||
| 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 | InboundMessage | Sub-cuenta | |
| OutboundMessage | Sub-cuenta | ||
| 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 | ||
| forms.readonly | GET /forms/ | Sub-cuenta | |
| GET /forms/submissions | 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 | Sub-Account, Company | |
| GET /locations/search | Sub-Account, Company | ||
| locations.write | POST /locations/ | Company | |
| PUT /locations/:locationId | Company | ||
| DELETE /locations/:locationId | Company | ||
| 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 | ||
| 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 | |
| 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 | ||
| snapshots.readonly | GET /snapshots | Company | |
| surveys.readonly | GET /surveys/ | Sub-cuenta | |
| GET /surveys/submissions | Sub-cuenta | ||
| users.readonly | GET /users/ | Sub-Account, Company | |
| GET /users/:userId | Sub-Account, Company | ||
| users.write | POST /users/ | Sub-Account, Company | |
| DELETE /users/:userId | Sub-Account, Company | ||
| PUT /users/:userId | Sub-Account, Company | ||
| workflows.readonly | GET /workflows/ | Sub-cuenta |
¿Te sirvio este artículo?
✨ Gracias por darte el tiempo de calificarla — nos ayuda a mejorar esta documentación para todo el equipo.
