Label Resource (since 1.1.7)

A label is a unique identifier for one or more groups. Labels can be used to customly categorize a network’s groups, for example cross-organization or location-based. News items can be sent to these labels, meaning that all underlying groups will receive the message.

Since

1.1.7

Representations

JSON

Properties

Name Type Description
EID EID Unique entity identifier
name string Unique label name
type string “label”

Example

{
    "_links": {
        "self": {
            "href": "https://api.speakap.io/networks/FEDCBA0987654321/labels/1234567890ABCDEF/"
        },
        "groups": {
            "href": "https://api.speakap.io/networks/FEDCBA0987654321/groups/?label=1234567890ABCDEF"
        }
    },
    "EID": "1234567890ABCDEF",
    "type": "label",
    "name": "Franchisees"
}