civis (version 3.1.3)

usage_limits_list_matching: List Matching Usage Limits

Description

List Matching Usage Limits

Usage

usage_limits_list_matching(task = NULL)

Value

An array containing the following fields:

id

integer, The ID for the limit.

organizationId

integer, The ID of the organization to which this limit belongs.

createdAt

string, The time this limit was created.

updatedAt

string, The time the limit was last updated.

hardLimit

integer, The limit value. One of 50000000, 200000000, 500000000, 1000000000, and 2000000000.

task

string, The category of this limit. One of 'IDR' or 'CDM'.

notificationEmails

array, Addresses to notify by e-mail when the limit is reached.

Arguments

task

string optional. If specified, return limits for this task type only. One of 'IDR' or 'CDM'.