---
updatedAt: 2026-06-03T14:46:37.000Z
agentTools:
  projectIndex: https://developers.fieldwire.com/llms.txt
---

# Transfers the form template to the specified account

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Fieldwire Regional API",
    "version": "v3"
  },
  "servers": [
    {
      "url": "https://client-api.{region}.fieldwire.com",
      "variables": {
        "region": {
          "default": "us",
          "enum": [
            "ca",
            "eu",
            "us"
          ]
        }
      }
    }
  ],
  "components": {
    "headers": {
      "current_user_id": {
        "description": "Current user's id",
        "schema": {
          "type": "integer"
        }
      }
    },
    "parameters": {
      "api_version": {
        "name": "Fieldwire-Version",
        "in": "header",
        "description": "Specifies the version of the API to talk to",
        "required": true,
        "schema": {
          "type": "string",
          "format": "date"
        }
      },
      "id": {
        "name": "id",
        "in": "path",
        "description": "ID of the entity",
        "required": true,
        "schema": {
          "type": "string",
          "format": "uuid"
        }
      },
      "project_id": {
        "name": "project_id",
        "in": "path",
        "description": "ID of the project this entity belongs to",
        "required": true,
        "schema": {
          "type": "string",
          "format": "uuid"
        }
      }
    },
    "schemas": {
      "job_id_response": {
        "type": "object",
        "description": "Schema for the response containing a Job ID",
        "nullable": false,
        "required": [
          "jid"
        ],
        "properties": {
          "jid": {
            "type": "string",
            "nullable": false,
            "description": "A unique ID to poll with until the job finishes"
          }
        },
        "additionalProperties": false
      },
      "form_template": {
        "type": "object",
        "description": "Entity that denotes a template from which forms can be built",
        "required": [
          "id",
          "creator_user_id",
          "last_editor_user_id",
          "project_id",
          "is_generated",
          "name",
          "kind",
          "version",
          "created_at",
          "device_created_at",
          "device_updated_at",
          "resolved_conflict",
          "updated_at",
          "form_type",
          "docusign_automation"
        ],
        "nullable": false,
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "nullable": false,
            "description": "ID of the entity"
          },
          "creator_user_id": {
            "type": "integer",
            "format": "int32",
            "nullable": false,
            "description": "ID of the user who created this entity"
          },
          "last_editor_user_id": {
            "type": "integer",
            "format": "int32",
            "nullable": false,
            "description": "ID of the user who most recently edited this entity"
          },
          "project_id": {
            "type": "string",
            "format": "uuid",
            "nullable": false,
            "description": "ID of the project this entity belongs to"
          },
          "is_generated": {
            "type": "boolean",
            "nullable": false,
            "description": "Whether this template is fully generated (in case cloning from another template)"
          },
          "checksum": {
            "type": "string",
            "nullable": true,
            "description": "Checksum used for verifying whether all relevant information for a form template is at hand"
          },
          "name": {
            "type": "string",
            "nullable": false,
            "description": "Name of the template"
          },
          "kind": {
            "type": "string",
            "enum": [
              "default",
              "time_range",
              "single_day"
            ],
            "nullable": false,
            "description": "Kind of the template"
          },
          "version": {
            "type": "integer",
            "format": "int32",
            "nullable": false,
            "description": "Version number of the Form Template. Publishing increases version. Starts at 0."
          },
          "content_changed_at": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "Time at which this entity was changed across any of its child entities (contents)"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "nullable": false,
            "description": "Time when the server created the entity"
          },
          "deleted_at": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "Time the server deleted the entity"
          },
          "device_created_at": {
            "type": "string",
            "format": "date-time",
            "nullable": false,
            "description": "Time when the device created the entity"
          },
          "device_updated_at": {
            "type": "string",
            "format": "date-time",
            "nullable": false,
            "description": "Time when the device last updated the entity"
          },
          "resolved_conflict": {
            "type": "boolean",
            "nullable": true,
            "description": "Specifies if PUT/PATCH request was rejected - do not store this field!"
          },
          "published_at": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "Time when the Form Template is published"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "nullable": false,
            "description": "Time when the server last updated the entity"
          },
          "view_edit_permissions": {
            "type": "string",
            "enum": [
              "assignee",
              "all_users",
              null
            ],
            "nullable": true,
            "deprecated": true,
            "description": "View/edit permissions for the template, e.g. assignee, all_users. Consider using form_template_permissions instead."
          },
          "form_type": {
            "type": "string",
            "enum": [
              "default",
              "fillable_pdf"
            ],
            "nullable": false,
            "description": "The type of form either custom fieldwire or a fillable_pdf"
          },
          "status_change_recipient_emails": {
            "type": "array",
            "nullable": true,
            "description": "Receivers of email notification when form changes its status",
            "items": {
              "type": "string",
              "nullable": true,
              "description": "Email of receiver"
            }
          },
          "docusign_automation": {
            "type": "object",
            "nullable": true,
            "description": "Active Docusign metadata",
            "properties": {
              "automation_instance_id": {
                "type": "integer",
                "nullable": false,
                "description": "Automation instance id"
              }
            },
            "additionalProperties": false
          },
          "process_state": {
            "type": "string",
            "enum": [
              "deleting",
              "restoring",
              null
            ],
            "nullable": true,
            "description": "State of an async deletion or restoration of this form template"
          },
          "is_ai_fillable": {
            "type": "boolean",
            "nullable": true,
            "description": "Whether this template is eligible for AI autofill"
          }
        },
        "additionalProperties": false
      },
      "form_template_transfer_input": {
        "type": "object",
        "description": "Schema for transferring a form template to account.",
        "nullable": false,
        "required": [
          "account_id"
        ],
        "properties": {
          "account_id": {
            "type": "integer",
            "format": "int32",
            "nullable": false,
            "description": "The ID of the account to transfer this form template to."
          }
        },
        "additionalProperties": false
      },
      "form_template_transfer_response": {
        "type": "object",
        "nullable": false,
        "description": "Schema for form template transfer response",
        "oneOf": [
          {
            "$ref": "#/components/schemas/form_template"
          },
          {
            "$ref": "#/components/schemas/job_id_response"
          }
        ]
      }
    },
    "securitySchemes": {
      "jwt": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "description": "Access token (JWT) generated using the acquired refresh token (API token). Our [authentication](https://developers.fieldwire.com/docs/authentication) guide covers the steps to generate a valid token"
      }
    }
  },
  "paths": {
    "/api/v3/projects/{project_id}/form_templates/{id}/transfer": {
      "post": {
        "summary": "Transfers the form template to the specified account",
        "operationId": "transfer_form_template",
        "tags": [
          "form templates"
        ],
        "security": [
          {
            "jwt": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/project_id"
          },
          {
            "$ref": "#/components/parameters/id"
          },
          {
            "$ref": "#/components/parameters/api_version"
          }
        ],
        "responses": {
          "202": {
            "description": "Successful jid response",
            "headers": {
              "X-Current-User-Id": {
                "$ref": "#/components/headers/current_user_id"
              }
            },
            "content": {
              "application/json": {
                "example": {
                  "jid": "bf21bad3-2e22-42f1-bd62-859b486427e2"
                },
                "schema": {
                  "$ref": "#/components/schemas/form_template_transfer_response"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/form_template_transfer_input"
              }
            }
          },
          "required": true
        }
      }
    }
  }
}
```