Skip to main content
POST
/
admin
/
system-dm-jobs
Create system DM job
curl --request POST \
  --url https://api.fluxer.app/v1/admin/system-dm-jobs \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": "<string>",
  "registration_start": "<string>",
  "registration_end": "<string>",
  "excluded_guild_ids": [
    "<string>"
  ]
}
'
{
  "job_id": "<string>",
  "status": "pending",
  "content": "<string>",
  "target_count": 1073741823,
  "sent_count": 1073741823,
  "failed_count": 1073741823,
  "created_at": "<string>",
  "excluded_guild_ids": [
    "<string>"
  ],
  "approved_at": "<string>",
  "registration_start": "<string>",
  "registration_end": "<string>",
  "last_error": "<string>"
}

Authorizations

​
Authorization
string
header
required

Admin API key: Authorization: Admin <token>. Only valid for /admin/* endpoints.

Body

application/json
​
content
string
required

Message content to send to users

Required string length: 1 - 4000
​
registration_start
string | null

Only target users registered after this date

​
registration_end
string | null

Only target users registered before this date

​
excluded_guild_ids
string<snowflake>[]

Guild IDs whose members should be excluded

Maximum array length: 100

Response

Success

​
job_id
string
required

Unique identifier for the job

​
status
enum<string>
required

Current status of the system DM job

Available options:
pending,
approved,
running,
completed,
failed
​
content
string
required

Message content being sent

​
target_count
integer<int32>
required

Total number of users targeted

Required range: 0 <= x <= 2147483647
​
sent_count
integer<int32>
required

Number of messages successfully sent

Required range: 0 <= x <= 2147483647
​
failed_count
integer<int32>
required

Number of messages that failed to send

Required range: 0 <= x <= 2147483647
​
created_at
string
required

ISO 8601 timestamp when the job was created

​
excluded_guild_ids
string[]
required

List of excluded guild IDs

Maximum array length: 100
​
approved_at
string | null

ISO 8601 timestamp when the job was approved

​
registration_start
string | null

Registration date filter start

​
registration_end
string | null

Registration date filter end

​
last_error
string | null

Last error message if the job failed