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

# Update Credential

> Changes the optional data types synced for an existing connection; see [the configuration example](https://rollout.com/docs/advanced-guides/controlling-which-records-sync-with-rollout#through-the-api).

The `entitiesToSync` object replaces your app's optional selection for this credential. Include all optional types you still need. Saving resets the connection's sync; allow the data to sync before expecting complete results.



## OpenAPI

````yaml /openapi/rollout.json put /credentials/{credentialId}
openapi: 3.0.3
info:
  title: Universal API Documentation
  description: Development documentation
  version: '1.0'
servers:
  - url: https://universal.rollout.com/api
security: []
paths:
  /credentials/{credentialId}:
    put:
      tags:
        - Credentials
      summary: Update Credential
      description: >-
        Changes the optional data types synced for an existing connection; see
        [the configuration
        example](https://rollout.com/docs/advanced-guides/controlling-which-records-sync-with-rollout#through-the-api).


        The `entitiesToSync` object replaces your app's optional selection for
        this credential. Include all optional types you still need. Saving
        resets the connection's sync; allow the data to sync before expecting
        complete results.
      operationId: putCredentialsByCredentialId
      parameters:
        - name: credentialId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                entitiesToSync:
                  type: object
                  properties:
                    actionPlanPeople:
                      type: boolean
                    actionPlans:
                      type: boolean
                    appointments:
                      type: boolean
                    assets:
                      type: boolean
                    borrowers:
                      type: boolean
                    calls:
                      type: boolean
                    calendars:
                      type: boolean
                    calendarEvents:
                      type: boolean
                    customFields:
                      type: boolean
                    events:
                      type: boolean
                    liabilities:
                      type: boolean
                    lists:
                      type: boolean
                    loans:
                      type: boolean
                    notes:
                      type: boolean
                    offices:
                      type: boolean
                    personAssignments:
                      type: boolean
                    properties:
                      type: boolean
                    realEstateOwned:
                      type: boolean
                    smartLists:
                      type: boolean
                    tasks:
                      type: boolean
                    taskTemplates:
                      type: boolean
                    teams:
                      type: boolean
                    textMessages:
                      type: boolean
                    emailMarketingCampaigns:
                      type: boolean
                    emailMarketingEvents:
                      type: boolean
                    emailMessages:
                      type: boolean
                    appointmentOutcomes:
                      type: boolean
                    appointmentTypes:
                      type: boolean
                    stages:
                      type: boolean
                    emailThreads:
                      type: boolean
                    documents:
                      type: boolean
                    sources:
                      type: boolean
                    tags:
                      type: boolean
                    timeframes:
                      type: boolean
                    peopleRelationships:
                      type: boolean
                    pipelines:
                      type: boolean
                    ponds:
                      type: boolean
                    transactionNotes:
                      type: boolean
                    transactionStageHistory:
                      type: boolean
              required:
                - entitiesToSync
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                entitiesToSync:
                  type: object
                  properties:
                    actionPlanPeople:
                      type: boolean
                    actionPlans:
                      type: boolean
                    appointments:
                      type: boolean
                    assets:
                      type: boolean
                    borrowers:
                      type: boolean
                    calls:
                      type: boolean
                    calendars:
                      type: boolean
                    calendarEvents:
                      type: boolean
                    customFields:
                      type: boolean
                    events:
                      type: boolean
                    liabilities:
                      type: boolean
                    lists:
                      type: boolean
                    loans:
                      type: boolean
                    notes:
                      type: boolean
                    offices:
                      type: boolean
                    personAssignments:
                      type: boolean
                    properties:
                      type: boolean
                    realEstateOwned:
                      type: boolean
                    smartLists:
                      type: boolean
                    tasks:
                      type: boolean
                    taskTemplates:
                      type: boolean
                    teams:
                      type: boolean
                    textMessages:
                      type: boolean
                    emailMarketingCampaigns:
                      type: boolean
                    emailMarketingEvents:
                      type: boolean
                    emailMessages:
                      type: boolean
                    appointmentOutcomes:
                      type: boolean
                    appointmentTypes:
                      type: boolean
                    stages:
                      type: boolean
                    emailThreads:
                      type: boolean
                    documents:
                      type: boolean
                    sources:
                      type: boolean
                    tags:
                      type: boolean
                    timeframes:
                      type: boolean
                    peopleRelationships:
                      type: boolean
                    pipelines:
                      type: boolean
                    ponds:
                      type: boolean
                    transactionNotes:
                      type: boolean
                    transactionStageHistory:
                      type: boolean
              required:
                - entitiesToSync
          multipart/form-data:
            schema:
              type: object
              properties:
                entitiesToSync:
                  type: object
                  properties:
                    actionPlanPeople:
                      type: boolean
                    actionPlans:
                      type: boolean
                    appointments:
                      type: boolean
                    assets:
                      type: boolean
                    borrowers:
                      type: boolean
                    calls:
                      type: boolean
                    calendars:
                      type: boolean
                    calendarEvents:
                      type: boolean
                    customFields:
                      type: boolean
                    events:
                      type: boolean
                    liabilities:
                      type: boolean
                    lists:
                      type: boolean
                    loans:
                      type: boolean
                    notes:
                      type: boolean
                    offices:
                      type: boolean
                    personAssignments:
                      type: boolean
                    properties:
                      type: boolean
                    realEstateOwned:
                      type: boolean
                    smartLists:
                      type: boolean
                    tasks:
                      type: boolean
                    taskTemplates:
                      type: boolean
                    teams:
                      type: boolean
                    textMessages:
                      type: boolean
                    emailMarketingCampaigns:
                      type: boolean
                    emailMarketingEvents:
                      type: boolean
                    emailMessages:
                      type: boolean
                    appointmentOutcomes:
                      type: boolean
                    appointmentTypes:
                      type: boolean
                    stages:
                      type: boolean
                    emailThreads:
                      type: boolean
                    documents:
                      type: boolean
                    sources:
                      type: boolean
                    tags:
                      type: boolean
                    timeframes:
                      type: boolean
                    peopleRelationships:
                      type: boolean
                    pipelines:
                      type: boolean
                    ponds:
                      type: boolean
                    transactionNotes:
                      type: boolean
                    transactionStageHistory:
                      type: boolean
              required:
                - entitiesToSync
      responses:
        '200':
          description: Response for status 200
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  createdAt:
                    type: string
                  appKey:
                    type: string
                  credentialKey:
                    type: string
                  plan:
                    type: string
                  invalidatedAt:
                    nullable: true
                    type: string
                  lastInboundSyncCompletedAt:
                    nullable: true
                    type: string
                  numInboundSyncFailedAttempts:
                    type: number
                  entitiesToSync:
                    type: object
                    additionalProperties:
                      type: object
                      properties:
                        enabled:
                          type: boolean
                      required:
                        - enabled
                  label:
                    type: string
                  avatar:
                    type: string
                  permissions:
                    type: object
                    additionalProperties:
                      type: object
                      properties:
                        list:
                          type: boolean
                        create:
                          type: boolean
                        update:
                          type: boolean
                        delete:
                          type: boolean
                        addTag:
                          description: Apply Tags to Person. Present on people only.
                          type: boolean
                        deleteTag:
                          description: Remove Tags from Person. Present on people only.
                          type: boolean
                      required:
                        - list
                        - create
                        - update
                        - delete
                    description: >-
                      What this credential can do, per entity and operation.
                      Omitted when the connector checks the credential's
                      permissions but no result is available yet.
                  requirements:
                    type: object
                    additionalProperties:
                      type: object
                      properties:
                        create:
                          type: object
                          properties:
                            required:
                              description: >-
                                Fields that must be present: not missing, null,
                                empty or [].
                              type: array
                              items:
                                type: string
                            anyOf:
                              description: >-
                                Groups of fields; each group needs at least one
                                present.
                              type: array
                              items:
                                type: array
                                items:
                                  type: string
                            values:
                              description: >-
                                The values accepted for a field (each element,
                                for an array field), matched case-insensitively.
                              type: object
                              additionalProperties:
                                type: array
                                items:
                                  type: string
                            unsupported:
                              description: >-
                                Fields the connector can't act on, which must be
                                absent: missing, null, empty or [].
                              type: array
                              items:
                                type: string
                        update:
                          type: object
                          properties:
                            values:
                              description: >-
                                The values accepted for a field (each element,
                                for an array field), matched case-insensitively.
                              type: object
                              additionalProperties:
                                type: array
                                items:
                                  type: string
                            unsupported:
                              description: >-
                                Fields the connector can't act on, which must be
                                absent: missing, null, empty or [].
                              type: array
                              items:
                                type: string
                    description: >-
                      What writing each entity needs beyond the request schema,
                      per operation. Entities without such rules are left out.
                  data:
                    type: object
                    additionalProperties: {}
                required:
                  - id
                  - createdAt
                  - appKey
        '400':
          description: Response for status 400
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorMessage:
                    type: string
                required:
                  - errorMessage
      security:
        - jwt: []
components:
  securitySchemes:
    jwt:
      type: http
      scheme: bearer
      description: Consumer JWT minted by the tenant's backend

````

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