Skip to main content
PUT
Update submitter

Authorizations

X-Auth-Token
string
header
required

API token generated at Settings > API

Path Parameters

id
integer
required

Body

application/json
email
string<email>
name
string
phone
string
role
string
external_id
string
values
object

Field values keyed by field UUID, field key, or normalized field name. Supports repeated-name fan-out and the same type-coercion rules as submission creation.

metadata
object
completed_redirect_url
string<uri>

Where to send this signer after they complete; wins over the submission's and the template's. Must be an absolute http/https URL (422 invalid_redirect_url otherwise).

require_phone_2fa
boolean
fields
object

Field-level overrides

send_email
boolean

Send invitation email

send_sms
boolean

Text this signer their signing link now, through the account's own SMS sender (requires phone)

completed
boolean

Set to true to mark submitter as completed via API

Response

Updated submitter

id
integer
uuid
string<uuid>
slug
string
signing_url
string<uri>

Absolute signing link, minted on the submission's chosen host (preferences.custom_domain, then the template's, then the account's primary custom domain, then spitshake.io).

Example:

"https://sign.yourcompany.com/s/OGZGoWBpoM8nN8"

email
string<email> | null
name
string | null
role
string
status
enum<string>
Available options:
waiting,
sent,
opened,
completed,
declined,
expired
submission_id
integer
opened_at
string<date-time> | null
sent_at
string<date-time> | null
completed_at
string<date-time> | null
phone
string | null
external_id
string | null
values
object
metadata
object
preferences
object | null
declined_at
string<date-time> | null
documents
object[]
submission_events
object[]
template
object
submission
object