# Create a fact-find request

**POST /api/v1/fact-find/request**




## Servers
- https://api.plannrcrm.com: https://api.plannrcrm.com ()


## Authentication methods
- Personal access token & O auth2


## Parameters
### Headers
- **X-PLANNR-ACCOUNT-UUID** (string)




### Body: application/json (object)

- **fact_find_schema_uuid** (string)
  The UUID of the fact-find schema that you would like the client to use.
- **client_uuid** (string)
  The UUID of the client account to send the fact-find request. This must only be individual clients. Cannot be used with circle_uuid.
- **circle_uuid** (string)
  The UUID of the circle to send the fact-find request to. Cannot be used with client_uuid.
- **send_invitation_email** (boolean)
  This controls if an email to the client is sent to invite them to complete a fact-find. Set this to false if you are going to send your own invitation.
- **invitation_text** (string)
  The text that will appear in the invitation email sent to the client (if enabled)


## Responses
### 201


#### Body: application/json (object)
- **uuid** (string)
  The UUID of the resource.
- **created_at** (string)
  The timestamp of when the resource was created.
- **updated_at** (string)
  The timestamp of when the resource was updated.
- **status** (string)
  The status of the fact-find request. Available options: in_progress,complete
- **completed_at** (string)
  The datetime when the fact-find request has been completed
- **invitation_text** (string)
  The text that is used in the notification/email sent out to the client.
- **schema** (object)
  The fact-find schema used for the fact-find request.
- **latest_file** (object)
  The latest file that has been generated for the fact-find request.
- **account** (object)
  The account that the fact-find request was sent to. Only visible when listing fact-find requests for a circle.
- **invitation_url** (string)
  The invitation URL sent to the client.
- **fact_find_passes** (object)
  The fact find passes added to the fact-find request.


[Powered by Bump.sh](https://bump.sh)