API Reference
  1. Recruiter API

Upload a document

post
https://api.app.franchiselab.com/api/contact//documents
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of a candidate contact on your account.

Body Params
string

File name, including the extension (e.g. passport.pdf). It must not contain / \ : * ? " < > \| or line breaks, and must not be . or ...

string

File contents as a plain base64 string. Data URLs (data:...;base64,) and base64url are rejected.

string

MIME type stored with the file (e.g. application/pdf). Defaults to application/octet-stream.

string

ID of the person on your account who uploaded the document. Defaults to the contact.

string

An application for this contact. If you send it, an "uploaded a document" entry is added to that application's activity history. If you leave it out, no activity entry is created.

Responses

Updated about 9 hours ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 9 hours ago

Did this page help you?