Skip to content

Broadcast Messages

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/broadcast-messages/ List Broadcast Messages
GET /api/broadcast-messages/{uuid}/ Retrieve
POST /api/broadcast-messages/ Create
PUT /api/broadcast-messages/{uuid}/ Update
PATCH /api/broadcast-messages/{uuid}/ Partial Update
DELETE /api/broadcast-messages/{uuid}/ Delete
Other Actions
GET /api/broadcast-messages/recipients/ Recipients
POST /api/broadcast-messages/{uuid}/schedule/ Schedule
POST /api/broadcast-messages/{uuid}/send/ Send

Core CRUD

List Broadcast Messages

1
2
3
4
http \
  GET \
  https://api.example.com/api/broadcast-messages/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.broadcast_messages import broadcast_messages_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = broadcast_messages_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: broadcast_messages_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { broadcastMessagesList } from 'waldur-js-client';

try {
  const response = await broadcastMessagesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
field array
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
state string Enum: DRAFT, SCHEDULED, SENT
subject string

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
created string (date-time)
subject string
body string
query any
author_full_name string
emails any
state any
send_at string (date)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/broadcast-messages/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.broadcast_messages import broadcast_messages_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = broadcast_messages_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: broadcast_messages_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { broadcastMessagesRetrieve } from 'waldur-js-client';

try {
  const response = await broadcastMessagesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type
uuid string (uuid)
created string (date-time)
subject string
body string
query any
author_full_name string
emails any
state any
send_at string (date)

Create

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/broadcast-messages/ \
  Authorization:"Token YOUR_API_TOKEN" \
  subject="string-value" \
  body="string-value" \
  query=null

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.broadcast_message_request import BroadcastMessageRequest # (1)
from waldur_api_client.api.broadcast_messages import broadcast_messages_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = BroadcastMessageRequest(
    subject="string-value",
    body="string-value",
    query=null
)
response = broadcast_messages_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: BroadcastMessageRequest
  2. API Source: broadcast_messages_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { broadcastMessagesCreate } from 'waldur-js-client';

try {
  const response = await broadcastMessagesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "subject": "string-value",
    "body": "string-value",
    "query": null
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
subject string ✓
body string ✓
query any ✓
send_at string (date)

201 -

Field Type
uuid string (uuid)
created string (date-time)
subject string
body string
query any
author_full_name string
emails any
state any
send_at string (date)

Update

1
2
3
4
5
6
7
http \
  PUT \
  https://api.example.com/api/broadcast-messages/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  subject="string-value" \
  body="string-value" \
  query=null

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.broadcast_message_request import BroadcastMessageRequest # (1)
from waldur_api_client.api.broadcast_messages import broadcast_messages_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = BroadcastMessageRequest(
    subject="string-value",
    body="string-value",
    query=null
)
response = broadcast_messages_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: BroadcastMessageRequest
  2. API Source: broadcast_messages_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { broadcastMessagesUpdate } from 'waldur-js-client';

try {
  const response = await broadcastMessagesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "subject": "string-value",
    "body": "string-value",
    "query": null
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
subject string ✓
body string ✓
query any ✓
send_at string (date)

200 -

Field Type
uuid string (uuid)
created string (date-time)
subject string
body string
query any
author_full_name string
emails any
state any
send_at string (date)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/broadcast-messages/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_broadcast_message_request import PatchedBroadcastMessageRequest # (1)
from waldur_api_client.api.broadcast_messages import broadcast_messages_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedBroadcastMessageRequest()
response = broadcast_messages_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedBroadcastMessageRequest
  2. API Source: broadcast_messages_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { broadcastMessagesPartialUpdate } from 'waldur-js-client';

try {
  const response = await broadcastMessagesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
subject string
body string
query any
send_at string (date)

200 -

Field Type
uuid string (uuid)
created string (date-time)
subject string
body string
query any
author_full_name string
emails any
state any
send_at string (date)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/broadcast-messages/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.broadcast_messages import broadcast_messages_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = broadcast_messages_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: broadcast_messages_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { broadcastMessagesDestroy } from 'waldur-js-client';

try {
  const response = await broadcastMessagesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Recipients

1
2
3
4
http \
  GET \
  https://api.example.com/api/broadcast-messages/recipients/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.broadcast_messages import broadcast_messages_recipients_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = broadcast_messages_recipients_retrieve.sync(client=client)

print(response)
  1. API Source: broadcast_messages_recipients_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { broadcastMessagesRecipientsRetrieve } from 'waldur-js-client';

try {
  const response = await broadcastMessagesRecipientsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type
field array

200 -

Field Type
uuid string (uuid)
created string (date-time)
subject string
body string
query any
author_full_name string
emails any
state any
send_at string (date)

Schedule

1
2
3
4
http \
  POST \
  https://api.example.com/api/broadcast-messages/a1b2c3d4-e5f6-7890-abcd-ef1234567890/schedule/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.broadcast_messages import broadcast_messages_schedule # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = broadcast_messages_schedule.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: broadcast_messages_schedule
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { broadcastMessagesSchedule } from 'waldur-js-client';

try {
  const response = await broadcastMessagesSchedule({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Send

1
2
3
4
http \
  POST \
  https://api.example.com/api/broadcast-messages/a1b2c3d4-e5f6-7890-abcd-ef1234567890/send/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.broadcast_messages import broadcast_messages_send # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = broadcast_messages_send.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: broadcast_messages_send
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { broadcastMessagesSend } from 'waldur-js-client';

try {
  const response = await broadcastMessagesSend({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body