All API categories

    Broadcasts API

    11 endpoints

    Broadcast messaging and campaigns.

    GET
    Auth Required

    broadcasts.list

    broadcasts.list

    Endpoint

    /admin/collection/{collectionId}/broadcasts

    Parameters

    collectionId
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "BroadcastList"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    broadcasts.create

    broadcasts.create

    Endpoint

    /admin/collection/{collectionId}/broadcasts

    Parameters

    collectionId
    path
    string
    Required
    body
    body
    BroadcastRecord
    Required

    See BroadcastRecord schema

    Responses

    200
    Success
    {
  "schema": "BroadcastRecord"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    broadcasts.append

    broadcasts.append

    Endpoint

    /admin/collection/{collectionId}/broadcasts/append

    Parameters

    collectionId
    path
    string
    Required
    body
    body
    BroadcastAppendEventBody
    Required

    See BroadcastAppendEventBody schema

    Responses

    200
    Success
    {
  "schema": "AppendResult"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    broadcasts.appendBulk

    broadcasts.appendBulk

    Endpoint

    /admin/collection/{collectionId}/broadcasts/append/bulk

    Parameters

    collectionId
    path
    string
    Required
    body
    body
    BroadcastAppendBulkBody
    Required

    See BroadcastAppendBulkBody schema

    Responses

    200
    Success
    {
  "schema": "AppendBulkResult"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    GET
    Auth Required

    broadcasts.get

    broadcasts.get

    Endpoint

    /admin/collection/{collectionId}/broadcasts/{id}

    Parameters

    collectionId
    path
    string
    Required
    id
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "BroadcastRecord"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    PATCH
    Auth Required

    broadcasts.update

    broadcasts.update

    Endpoint

    /admin/collection/{collectionId}/broadcasts/{id}

    Parameters

    collectionId
    path
    string
    Required
    id
    path
    string
    Required
    body
    body
    object
    Required

    Request body

    Responses

    200
    Success
    {
  "schema": "BroadcastRecord"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    DELETE
    Auth Required

    broadcasts.remove

    broadcasts.remove

    Endpoint

    /admin/collection/{collectionId}/broadcasts/{id}

    Parameters

    collectionId
    path
    string
    Required
    id
    path
    string
    Required

    Responses

    200
    Success
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    broadcasts.preview

    broadcasts.preview

    Endpoint

    /admin/collection/{collectionId}/broadcasts/{id}/preview

    Parameters

    collectionId
    path
    string
    Required
    id
    path
    string
    Required
    body
    body
    BroadcastPreviewRequest
    Required

    See BroadcastPreviewRequest schema

    Responses

    200
    Success
    {
  "schema": "BroadcastPreviewResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    GET
    Auth Required

    broadcasts.recipients

    broadcasts.recipients

    Endpoint

    /admin/collection/{collectionId}/broadcasts/{id}/recipients{qs}

    Parameters

    collectionId
    path
    string
    Required
    id
    path
    string
    Required
    qs
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "BroadcastRecipientsResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    broadcasts.sendManual

    broadcasts.sendManual

    Endpoint

    /admin/collection/{collectionId}/broadcasts/{id}/send/manual

    Parameters

    collectionId
    path
    string
    Required
    id
    path
    string
    Required
    body
    body
    BroadcastSendManualRequest
    Required

    See BroadcastSendManualRequest schema

    Responses

    200
    Success
    {
  "schema": "BroadcastSendManualResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    broadcasts.sendTest

    broadcasts.sendTest

    Endpoint

    /admin/collection/{collectionId}/broadcasts/{id}/send/test

    Parameters

    collectionId
    path
    string
    Required
    id
    path
    string
    Required
    body
    body
    BroadcastSendTestRequest
    Required

    See BroadcastSendTestRequest schema

    Responses

    200
    Success
    {
  "schema": "BroadcastSendTestResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found