Announce

Personas in this Story: Default, Member, Client.

ActiveCollab lets owners and technical administrators send out announcements to users. This feature is useful when you need to announce maintenance periods, some important achievements etc.

In order to see how this feature works, we have invited two users - one regular member and one technical administrator (owner has been automatically created when we installed ActiveCollab):

Response: HTTP 200, application/json (Hide)
GET /users

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
[
    {
        "id": 1,
        "class": "Owner",
        "url_path": "\/users\/1",
        "is_archived": false,
        "is_trashed": false,
        "trashed_on": null,
        "trashed_by_id": 0,
        "created_on": 1430164878,
        "created_by_id": 1,
        "updated_on": 1430164878,
        "updated_by_id": 1,
        "language_id": 0,
        "first_name": "Ilija.studen",
        "last_name": null,
        "display_name": "ilija.studen",
        "short_display_name": "ilija.studen",
        "email": "ilija.studen@activecollab.com",
        "additional_email_addresses": [],
        "is_pending_activation": false,
        "avatar_url": "http:\/\/feather.dev\/proxy.php?proxy=avatar&module=system&v=current&b=DEV&user_id=1&size=--SIZE--&timestamp=1430164878",
        "custom_permissions": [],
        "company_id": 1,
        "title": null,
        "phone": null,
        "im_type": null,
        "im_handle": null,
        "note": null
    },
    {
        "id": 2,
        "class": "Member",
        "url_path": "\/users\/2",
        "is_archived": false,
        "is_trashed": false,
        "trashed_on": null,
        "trashed_by_id": 0,
        "created_on": 1430164880,
        "created_by_id": 1,
        "updated_on": 1430164880,
        "updated_by_id": 1,
        "language_id": 0,
        "first_name": "Member",
        "last_name": null,
        "display_name": "member",
        "short_display_name": "member",
        "email": "member@activecollab.com",
        "additional_email_addresses": [],
        "is_pending_activation": false,
        "avatar_url": "http:\/\/feather.dev\/proxy.php?proxy=avatar&module=system&v=current&b=DEV&user_id=2&size=--SIZE--&timestamp=1430164880",
        "custom_permissions": [],
        "company_id": 1,
        "title": null,
        "phone": null,
        "im_type": null,
        "im_handle": null,
        "note": null
    },
    {
        "id": 3,
        "class": "Client",
        "url_path": "\/users\/3",
        "is_archived": false,
        "is_trashed": false,
        "trashed_on": null,
        "trashed_by_id": 0,
        "created_on": 1430164881,
        "created_by_id": 1,
        "updated_on": 1430164881,
        "updated_by_id": 1,
        "language_id": 0,
        "first_name": "Client",
        "last_name": null,
        "display_name": "client",
        "short_display_name": "client",
        "email": "client@activecollab.com",
        "additional_email_addresses": [],
        "is_pending_activation": false,
        "avatar_url": "http:\/\/feather.dev\/proxy.php?proxy=avatar&module=system&v=current&b=DEV&user_id=3&size=--SIZE--&timestamp=1430164881",
        "custom_permissions": [],
        "company_id": 0,
        "title": null,
        "phone": null,
        "im_type": null,
        "im_handle": null,
        "note": null
    },
    {
        "id": 4,
        "class": "Member",
        "url_path": "\/users\/4",
        "is_archived": false,
        "is_trashed": false,
        "trashed_on": null,
        "trashed_by_id": 0,
        "created_on": 1430164884,
        "created_by_id": 1,
        "updated_on": 1430164884,
        "updated_by_id": 1,
        "language_id": 0,
        "first_name": "Tech-administrator",
        "last_name": null,
        "display_name": "tech-administrator",
        "short_display_name": "tech-administrator",
        "email": "tech-administrator@activecollab.com",
        "additional_email_addresses": [],
        "is_pending_activation": false,
        "avatar_url": "http:\/\/feather.dev\/proxy.php?proxy=avatar&module=system&v=current&b=DEV&user_id=4&size=--SIZE--&timestamp=1430164884",
        "custom_permissions": [
            "can_manage_settings"
        ],
        "company_id": 1,
        "title": null,
        "phone": null,
        "im_type": null,
        "im_handle": null,
        "note": null
    },
    {
        "id": 5,
        "class": "Member",
        "url_path": "\/users\/5",
        "is_archived": false,
        "is_trashed": false,
        "trashed_on": null,
        "trashed_by_id": 0,
        "created_on": 1430164884,
        "created_by_id": 1,
        "updated_on": 1430164884,
        "updated_by_id": 1,
        "language_id": 0,
        "first_name": "Member2",
        "last_name": null,
        "display_name": "member2",
        "short_display_name": "member2",
        "email": "member2@activecollab.com",
        "additional_email_addresses": [],
        "is_pending_activation": false,
        "avatar_url": "http:\/\/feather.dev\/proxy.php?proxy=avatar&module=system&v=current&b=DEV&user_id=5&size=--SIZE--&timestamp=1430164884",
        "custom_permissions": [],
        "company_id": 1,
        "title": null,
        "phone": null,
        "im_type": null,
        "im_handle": null,
        "note": null
    }
]

When we try to send out an announcement as a member, system will reject our request:

Response: HTTP 404, text/html
POST /announce (as Member)

Payload:

1
2
3
4
5
{
    "subject": "Hohoho!",
    "announcement": "We wish you a merry christmas",
    "recipients": "user1@activecollab.com, user2@activecollab.com"
}

If we try to make the same request as technical administrator, or as an owner, system will make no objection and it will send out the announcement to the listed people:

Response: HTTP 500, text/html
POST /announce (as TechAdministrator)

Payload:

1
2
3
4
5
{
    "subject": "Hohoho!",
    "announcement": "We wish you a Merry Christmas",
    "recipients": "user1@activecollab.com, user2@activecollab.com"
}
Response: HTTP 200, text/html
POST /announce

Payload:

1
2
3
4
5
{
    "subject": "Hohoho!",
    "announcement": "We wish you a Merry Christmas",
    "recipients": "user1@activecollab.com, user2@activecollab.com"
}

Note about recipients: you should send them in standard RFC 822 format. You can send an announcement to up to 100 recipients per request. If you need more than that, please email support@activecollab.com for details.