curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.edi.stateset.com/v1/hosted-sftp/mailboxes/{partner_id}' \
--header "Authorization: Bearer $EDI_API_TOKEN" \
--header 'Content-Type: application/json' \
--data '{
"enabled": true,
"max_file_bytes": 1,
"max_files": 1,
"public_keys": [
"string"
],
"quota_bytes": 1,
"route_outbound_documents": true
}'
Provision
Mailbox created or key/quota policy replaced; username remains stable
POST
/
v1
/
hosted-sftp
/
mailboxes
/
{partner_id}
curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.edi.stateset.com/v1/hosted-sftp/mailboxes/{partner_id}' \
--header "Authorization: Bearer $EDI_API_TOKEN" \
--header 'Content-Type: application/json' \
--data '{
"enabled": true,
"max_file_bytes": 1,
"max_files": 1,
"public_keys": [
"string"
],
"quota_bytes": 1,
"route_outbound_documents": true
}'
Path parameters
string
required
Resource identifier
Request body
HostedSftpMailboxInput
boolean
required
integer (int64)
required
integer (int32)
required
string[]
required
Complete OpenSSH public keys; never private keys or authorized_keys options.
integer (int64)
required
boolean
Use this mailbox as the primary route for new outbound business documents. Suspension blocks partner access but preserves queued outbound documents.
Response
No response body. Mailbox created or key/quota policy replaced; username remains stable.Status codes
| Code | Meaning |
|---|---|
200 | Mailbox created or key/quota policy replaced; username remains stable |
Using this contract
Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.edi.stateset.com/v1/hosted-sftp/mailboxes/{partner_id}' \
--header "Authorization: Bearer $EDI_API_TOKEN" \
--header 'Content-Type: application/json' \
--data '{
"enabled": true,
"max_file_bytes": 1,
"max_files": 1,
"public_keys": [
"string"
],
"quota_bytes": 1,
"route_outbound_documents": true
}'
Last modified on October 20, 2026