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

# Create contact follow-up

> Schedules a new follow-up reminder for a contact. Requires `crm:write` scope.

Schedules a new follow-up reminder or action task associated with a contact.

### Request attributes

* `contact_id` (string, required): Identifier of the target contact.
* `title` (string, required): Short summary of the scheduled task.
* `due_date` (string, required): ISO 8601 timestamp for when the task is due.
* `reminder_at` (string, optional): ISO 8601 timestamp for notification alert.
* `notes` (string, optional): Detailed guidance or meeting preparation notes.
* `assigned_to` (string, optional): Team member responsible for the follow-up.

### Required permissions

Requires an API key with the `crm:write` scope.


## OpenAPI

````yaml POST /contact-followups
openapi: 3.1.0
info:
  title: Automate CRM API
  description: >-
    External integration API for Automate CRM. Manage leads, contacts, products,
    follow-ups, custom fields, and real-time inbox lookups.
  version: 1.0.0
servers:
  - url: https://crm-api.automatebusiness.com/api/v1/integrations-public
    description: Production Integration Server
security:
  - apiKeyAuth: []
paths:
  /contact-followups:
    post:
      summary: Create Contact Follow-up
      description: >-
        Schedules a new follow-up reminder for a contact. Requires `crm:write`
        scope.
      operationId: createContactFollowup
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateContactFollowupInput'
      responses:
        '201':
          description: Contact follow-up created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FollowupMutationResponse'
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      security:
        - apiKeyAuth:
            - crm:write
components:
  schemas:
    CreateContactFollowupInput:
      type: object
      required:
        - contact_id
        - title
        - due_date
      properties:
        contact_id:
          type: string
          example: cnt_941a7bc2
        title:
          type: string
          example: Quarterly Check-in
        notes:
          type: string
          example: Ensure onboarded users are active.
        due_date:
          type: string
          format: date-time
          example: '2026-11-05T11:00:00.000Z'
        reminder_at:
          type: string
          format: date-time
          example: '2026-11-05T10:30:00.000Z'
        assigned_to:
          type: string
          example: user_michael
    FollowupMutationResponse:
      allOf:
        - $ref: '#/components/schemas/MutationSuccessEnvelope'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/Followup'
    MutationSuccessEnvelope:
      type: object
      description: >-
        Standard envelope returned by POST, PATCH, PUT, and DELETE (mutation)
        endpoints
      properties:
        success:
          type: boolean
          example: true
        data:
          description: The created or updated entity
        error:
          type: 'null'
          example: null
      required:
        - success
        - data
        - error
    Followup:
      type: object
      properties:
        id:
          type: string
          example: fol_7721a9
        entity_id:
          type: string
          description: Target lead or contact ID
          example: lead_890ef12a
        entity_type:
          type: string
          enum:
            - lead
            - contact
          example: lead
        title:
          type: string
          example: Contract Review Call
        notes:
          type: string
          example: Review updated pricing terms with CFO
        due_date:
          type: string
          format: date-time
          example: '2026-10-30T15:00:00.000Z'
        reminder_at:
          type: string
          format: date-time
          example: '2026-10-30T14:45:00.000Z'
        status:
          type: string
          enum:
            - pending
            - completed
            - cancelled
          example: pending
        assigned_to:
          type: string
          example: user_sarah
        created_at:
          type: string
          format: date-time
          example: '2026-10-26T10:00:00.000Z'
    ErrorEnvelope:
      type: object
      description: Standard error envelope returned when a request fails
      properties:
        success:
          type: boolean
          example: false
        data:
          type: 'null'
          example: null
        error:
          type: object
          properties:
            message:
              type: string
              example: Validation failed
            details:
              type: array
              items:
                type: object
                properties:
                  message:
                    type: string
                    example: Required
                  field:
                    type: string
                    example: email
                  code:
                    type: string
                    example: invalid_type
          required:
            - message
      required:
        - success
        - data
        - error
  responses:
    ValidationError:
      description: Validation failed (e.g., missing required fields, invalid format)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            success: false
            data: null
            error:
              message: Validation failed
              details:
                - message: Required
                  field: email
                  code: invalid_type
    UnauthorizedError:
      description: Unauthorized (invalid or missing x-api-key)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            success: false
            data: null
            error:
              message: Invalid or missing API key.
    ForbiddenError:
      description: Forbidden (API key lacks required crm:read or crm:write scope)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            success: false
            data: null
            error:
              message: 'Forbidden: insufficient permissions for this operation.'
    NotFoundError:
      description: The requested entity or resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            success: false
            data: null
            error:
              message: Resource not found
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Workspace API key header. The key implicitly determines your workspace
        isolation. Scopes: `crm:read` for GET/HEAD/OPTIONS, `crm:write` for
        POST/PATCH/PUT/DELETE.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.