Create a draft certificate request

Creates a Draft request with one item per customer/state pair. Nothing is
emailed until POST /certificates/requests/{id}/send.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
items
array of objects
required
length ≥ 1

At least one item is required. Each needs customerId, stateId, and either contactId or email.

items*
integer
required
≥ 1
integer

Customer contact to email. Takes precedence over email.

integer
required
≥ 1
integer
string

Free-text recipient when no contactId is given. One of the two is required.

integer

Email template (1-3). Defaults to the seeded default template (1) when omitted.

string
boolean

Attach a blank form copy to the email.

integer

Required and positive when attachCopy is true.

integer
required
≥ 1

Portal user creating the request (created_by).

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json