> ## Documentation Index
> Fetch the complete documentation index at: https://br.developers.hubspot.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Enroll a contact into a sequence

> Inscreva um contato em uma sequência usando o ID do usuário e os detalhes da sequência especificados.

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/legacy/v4/automation-sequences-v4.json POST /automation/v4/sequences/enrollments
openapi: 3.0.1
info:
  title: Sequências
  description: Basepom for all HubSpot Projects
  version: v4
  x-hubspot-product-tier-requirements:
    marketing: FREE
    sales: PROFESSIONAL
    service: PROFESSIONAL
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
  x-hubspot-api-use-case: >-
    Você precisa inscrevê-los em uma sequência do HubSpot usando um aplicativo
    que você projetou para manter uma lista de contatos.
  x-hubspot-related-documentation:
    - name: Sequences Guide
      url: https://developers.hubspot.com/docs/guides/api/automation/sequences
  x-hubspot-introduction: >-
    Use a API de sequências para obter uma lista de sequências, obter uma
    sequência específica, inscrever um contato em uma sequência e ver o status
    de inscrição de um contato.
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Basic
  - name: Básico
paths:
  /automation/v4/sequences/enrollments:
    post:
      tags:
        - Basic
        - Básico
      summary: Inscrever um contato em uma sequência
      description: >-
        Inscreva um contato em uma sequência usando o ID do usuário e os
        detalhes da sequência especificados.
      operationId: post-/automation/v4/sequences/enrollments
      parameters:
        - name: userId
          in: query
          description: ''
          required: true
          style: form
          explode: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicSequenceEnrollmentRequest'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicSequenceEnrollmentLiteResponse'
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - automation.sequences.enrollments.write
components:
  schemas:
    PublicSequenceEnrollmentRequest:
      required:
        - contactId
        - senderEmail
        - sequenceId
      type: object
      properties:
        contactId:
          type: string
          description: O identificador exclusivo do contato a ser inscrito na sequência.
        senderAliasAddress:
          type: string
          description: >-
            O endereço de e-mail alternativo usado pelo remetente ao inscrever o
            contato.
        senderEmail:
          type: string
          description: >-
            O endereço de e-mail do remetente que inscreveu o contato na
            sequência.
        sequenceId:
          type: string
          description: >-
            O identificador exclusivo da sequência na qual o contato será
            inscrito.
    PublicSequenceEnrollmentLiteResponse:
      required:
        - enrolledAt
        - id
        - toEmail
        - updatedAt
      type: object
      properties:
        enrolledAt:
          type: string
          description: A data e a hora em que o contato foi inscrito na sequência.
          format: date-time
        id:
          type: string
          description: O identificador exclusivo para a inscrição na sequência.
        toEmail:
          type: string
          description: O endereço de e-mail do contato inscrito na sequência.
        updatedAt:
          type: string
          description: >-
            A data e a hora em que a inscrição na sequência foi atualizado pela
            última vez.
          format: date-time
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: A categoria de erro
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexto sobre a condição do erro
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            Um identificador exclusivo para a solicitação. Inclua este valor em
            relatórios de erro ou tickets de suporte
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: mais informações sobre o erro
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Um mapa de nomes de links para URIs associados que contêm
            documentação sobre o erro ou as etapas de correção recomendadas
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado
          example: An error occurred
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém mais detalhes específicos sobre
            o erro
      description: >-
        Representa uma resposta de erro retornada pela API quando uma operação
        falha. Este componente é usado em vários endpoints para fornecer
        informações detalhadas sobre o erro encontrado.
      example:
        message: Invalid input (details will vary based on the error)
        correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
        category: VALIDATION_ERROR
        links:
          knowledge-base: https://www.hubspot.com/products/service/knowledge-base
    ErrorDetail:
      required:
        - message
      type: object
      properties:
        code:
          type: string
          description: O código de status associado ao detalhe do erro
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexto sobre a condição do erro
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: O nome do campo ou parâmetro no qual o erro foi encontrado.
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém mais detalhes específicos sobre
            o erro
      description: >-
        Representa informações detalhadas sobre um erro ocorrido na API. Este
        componente é usado para fornecer contexto e detalhes adicionais sobre os
        erros, geralmente como parte de uma resposta de erro.
  responses:
    Error:
      description: An error occurred.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.hubspot.com/oauth/authorize
          tokenUrl: https://api.hubapi.com/oauth/v1/token
          scopes:
            automation.sequences.enrollments.write: ''
            automation.sequences.read: ''

````