Skip to main content
POST
Create a file

Authorizations

x-conveyour-token
string
header
required

Your API key token. Contacts endpoints require a Server-only — Full API key — see Authentication.

Query Parameters

teams[]
string[]

Team scope for the request, as one or more team ObjectIds. The brackets are required: PHP keeps only the last value for a repeated plain key, so teams=A&teams=B silently resolves to B alone. On requests with a JSON body you may send teams (no brackets) in the body instead.

Values that are not valid ObjectIds are silently ignored — a mistyped team ID behaves as if no team was sent. See the teams section of the API conventions guide.

Body

application/json
filename
string
required

The file's display name.

url
string
required

The Filestack CDN URL for the uploaded file. ConveYour extracts the file hash from this URL, so it must be a Filestack/CDN URL containing a 20+ character hash segment — an arbitrary external URL is rejected with The url field is required. even when you supplied one.

mimetype
string
required

The file's MIME type (e.g. application/pdf, image/png).

folder_id
string

ID of the folder to place this file in. Omit for no folder.

Response

Success.

The common response envelope shared by all ConveYour endpoints.

status
enum<string>

ok on success, failed on error.

Available options:
ok,
failed
message
string

Human-readable description of the result.

data
object

A file record. Returns the stored attributes and adds url, user_name, contact_name, folder_id and folder_name.