Skip to main content
POST
Create maintenance request

Authorizations

Authorization
string
header
default:PHONEFARM_API_KEY
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
request_id
string
required
Minimum string length: 1
account_id
string
required
Minimum string length: 1
inputs
object
required
callback
object
required
requested_by
object
required
platform
enum<string>
default:tiktok
Available options:
tiktok,
instagram

Response

Duplicate request; existing process returned.

status
string
required
Allowed value: "accepted"
process_id
string<uuid>
required
request_id
string
required
process_type
string
required
platform
enum<string>
required
Available options:
tiktok,
instagram
duplicate
boolean
required
process_status
enum<string>
required
Available options:
queued,
executing,
retrying,
completed,
failed_terminal,
cancelled