Initiatives

post

Authorizations

ApiBearerAuth

AuthorizationstringRequired

Enter access token

Path parameters

customerIdstring · objectidRequired

Query parameters

isInitialbooleanOptional

Body

application/json

Responses

201Success

post

/api/v2/customers/{customerId}/initiatives/consolidated-batch

HTTPcURLJavaScriptPython

POST /api/v2/customers/{customerId}/initiatives/consolidated-batch HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 423

{
  "initiatives": [
    {
      "initiative": {
        "billingType": "billable",
        "externalId": "text",
        "name": "text",
        "description": "text",
        "callSign": "text",
        "clientExternalId": "text",
        "externalGroupIds": [
          "text"
        ],
        "unitIncrements": 1,
        "status": "active"
      },
      "codes": {
        "isCodesEmpty": true,
        "codes": [
          {
            "codeExternalId": "text",
            "codeTypeExternalId": "text"
          }
        ]
      },
      "entryValidationRules": {
        "isRequiredCodeTypeExternalIdsEmpty": true,
        "requiredCodeTypeExternalIds": [
          "text"
        ]
      }
    }
  ]
}

201Success

No content

post

Authorizations

ApiBearerAuth

AuthorizationstringRequired

Enter access token

Path parameters

customerIdstring · objectidRequired

initiativeExternalIdstringRequired

Body

application/json

typestring · enumRequired

type of access.

Possible values:

userIdsstring · objectid[]Optional

list of users whose access is either allowed or denied for an initiative.

Responses

201Success

post

/api/v1/customers/{customerId}/initiatives/{initiativeExternalId}/access

HTTPcURLJavaScriptPython

POST /api/v1/customers/{customerId}/initiatives/{initiativeExternalId}/access HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "type": "allow",
  "userIds": [
    "text"
  ]
}

201Success

No content

post

Authorizations

ApiBearerAuth

AuthorizationstringRequired

Enter access token

Path parameters

customerIdstring · objectidRequired

initiativeExternalIdstringRequired

Body

application/json

codeExternalIdsstring[] · min: 1 · max: 2500Required

Responses

201Success

post

/api/v1/customers/{customerId}/initiatives/{initiativeExternalId}/codes

HTTPcURLJavaScriptPython

POST /api/v1/customers/{customerId}/initiatives/{initiativeExternalId}/codes HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "codeExternalIds": [
    "text"
  ]
}

201Success

No content

delete

Authorizations

ApiBearerAuth

AuthorizationstringRequired

Enter access token

Path parameters

customerIdstring · objectidRequired

initiativeExternalIdstringRequired

Responses

200Success

No content

delete

/api/v1/customers/{customerId}/initiatives/{initiativeExternalId}/codes

HTTPcURLJavaScriptPython

DELETE /api/v1/customers/{customerId}/initiatives/{initiativeExternalId}/codes HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

No content