interface RequestData

export interface RequestData

Represents possible data to be given to an endpoint

appendToFormData
auth
body
dispatcher
files
headers
passThroughBody
query
reason
signal
versioned

optional
appendToFormData? : boolean

Whether to append JSON data to form data instead of payload_json when sending files

optional
auth? : AuthData | boolean | undefined = true

Alternate authorization data to use for this request only, or false to disable the Authorization header. When making a request to a route that includes a token (such as interactions or webhooks), set to false to avoid accidentally unsetting the instance token if a 401 is encountered.

optional
body? : BodyInit | unknown

The body to send to this request. If providing as BodyInit, set passThroughBody: true

optional
dispatcher? : Agent

The Agent to use for the request.

optional
files? : RawFile[] | undefined

Files to be attached to this request

optional
headers? : Record<string, string>

Additional headers to add to this request

optional
passThroughBody? : boolean

Whether to pass-through the body property directly to fetch(). This only applies when files is NOT present

optional
query? : URLSearchParams

Query string parameters to append to the called endpoint

optional
reason? : string | undefined

Reason to show in the audit logs

optional
signal? : AbortSignal | undefined

The signal to abort the queue entry or the REST call, where applicable

optional
versioned? : boolean = true

If this request should be versioned