POST /api/v2/submissions/add-user/{factFindSession_uuid}
Personal access token & O auth2

Creates a prospect account with the provided email address and attaches them to the specified fact-find session.

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • factFindSession_uuid string Required

Responses

  • 201 application/json
    Hide response attributes Show response attributes 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.

    • type string

      Account type

    • role string

      Account role

    • first_name string

      First name

    • last_name string

      Last name

    • name string

      Name

    • email string

      (Deprecated - Please use the primary email of the account instead). The email of the account.

    • photo_url string

      The photo URL of the client

    • external_references array[object]

      The external references that have been added to the client.

      Hide external_references attributes Show external_references attributes object
      • uuid string
      • created_at string
      • updated_at string
      • third_party string
      • reference string
POST /api/v2/submissions/add-user/{factFindSession_uuid} 
curl \
 --request POST 'https://api.plannrcrm.com/api/v2/submissions/add-user/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (201) 
{
  "uuid": "994ba34e-3a2c-48b6-aed0-cb6a60d9197b",
  "created_at": "2026-05-08T14:41:56+01:00",
  "updated_at": "2026-05-08T14:41:56+01:00",
  "type": "client",
  "role": "client",
  "first_name": "Gareth",
  "last_name": "Thompson",
  "name": "Gareth Thompson",
  "email": "gareth@codepotato.co.uk",
  "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
  "external_references": [
    {
      "uuid": "9a7cb428-dcce-45f0-819e-656f084c8809",
      "created_at": "2026-05-08T14:41:56+01:00",
      "updated_at": "2026-05-08T14:41:56+01:00",
      "third_party": "nucleus",
      "reference": "AB123456"
    }
  ]
}