POST /link_delivery/create

Use the /link_delivery/create endpoint to create a Hosted Link session.

Servers

https://production.plaid.com
https://sandbox.plaid.com

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`client_id`	String	No	Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
`link_token`	String	Yes	A `link_token` from a previous invocation of `/link/token/create`.
`options`	Object	No	Optional metadata related to the Hosted Link session
`options.recipient`	Object	No	Metadata related to the recipient. If the information required to populate this field is not available, leave it blank.
`options.recipient.first_name`	String	No	First name of the recipient. Will be used in the body of the email / text (if configured). If this information is not available, leave this field blank.
`options.recipient.communication_methods[]`	Array	No	The list of communication methods to send the Hosted Link session URL to. If delivery is not required, leave this field blank.
`options.recipient.communication_methods[].method`	String	No	The delivery method to be used to deliver the Hosted Link session URL. `SMS`: The URL will be delivered through SMS `EMAIL`: The URL will be delivered through email Possible values: `"EMAIL"` `"SMS"`
`options.recipient.communication_methods[].address`	String	No	The phone number / email address that Hosted Link sessions are delivered to. Phone numbers must be in E.164 format.
`secret`	String	No	Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.