# Store an illustration

**POST /api/v1/illustration**




## 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)

- **name** (string)
  The name of the illustration.
- **client_uuid** (string)
  The client UUID to associate the illustration with. (deprecated: use accounts instead)
- **accounts** (array[string])
  An array of client account UUIDs to associate the illustration with.
- **requested_by_uuid** (string)
  The requested by account UUID to associate the illustration with. If not passed, this will default to the assigned adviser on the client account.
- **plan_uuid** (string)
  The plan UUID to associate the illustration with. If not provided and is_draft is false, a new proposed plan will be created using the request_data.
- **request_data** (array[string])
  The request data used to generate the illustration.
- **is_draft** (boolean)
  Whether the illustration is a draft or not. If draft, it will not be sent to the platform.
- **platform** (string)
  The platform used to generate the illustration.
- **generate** (boolean)
  Whether to generate the illustration. Defaults to true.


## Responses
### 200


#### 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.
- **generated_at** (string)
  The timestamp of when the illustration was generated with the platform.
- **status** (string)
  The status of the illustration. Available values: created, generating_illustration and generated_illustration
- **client** (object)
  The lead account that the illustration belongs to.
- **accounts** (array[object])
  The list of accounts that the illustration belongs to. This will include the lead account.
- **application** (object)
  If the illustration is linked to an application, this will be the application resource.
- **plan** (object)
  The plan that the illustration belongs to.
- **requested_by** (object)
  The account (adviser) that requested the illustration.
- **name** (string)
  The name of the illustration.
- **request_data** (array)
  The request data used to generate the illustration.
- **platform** (string)
  The platform used to generate the illustration.
- **platform_illustration_id** (string)
  The platform specific illustration id.
- **account_opening_allowed** (boolean)
  Whether the account opening is allowed for the illustration.
- **is_draft** (boolean)
  Whether the illustration is in the created/draft state.


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