Initiatives

post
Authorizations
Path parameters
customerIdstring · objectidRequired
Query parameters
isInitialbooleanOptional
Body
Responses
201Success
post
POST /api/v2/customers/{customerId}/initiatives/consolidated-batch HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 395

{
  "initiatives": [
    {
      "initiative": {
        "billingType": "billable",
        "externalId": "text",
        "name": "text",
        "description": "text",
        "callSign": "text",
        "clientExternalId": "text",
        "unitIncrements": 1,
        "status": "active"
      },
      "codes": {
        "isCodesEmpty": true,
        "codes": [
          {
            "codeExternalId": "text",
            "codeTypeExternalId": "text"
          }
        ]
      },
      "entryValidationRules": {
        "isRequiredCodeTypeExternalIdsEmpty": true,
        "requiredCodeTypeExternalIds": [
          "text"
        ]
      }
    }
  ]
}
201Success
No content
post
Authorizations
Path parameters
customerIdstring · objectidRequired
initiativeExternalIdstringRequired
Body
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
POST /api/v1/customers/{customerId}/initiatives/{initiativeExternalId}/access HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "type": "allow",
  "userIds": [
    "text"
  ]
}
201Success
No content
post
Authorizations
Path parameters
customerIdstring · objectidRequired
initiativeExternalIdstringRequired
Body
codeExternalIdsstring[] · min: 1 · max: 2500Required
Responses
201Success
post
POST /api/v1/customers/{customerId}/initiatives/{initiativeExternalId}/codes HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "codeExternalIds": [
    "text"
  ]
}
201Success
No content
delete
Authorizations
Path parameters
customerIdstring · objectidRequired
initiativeExternalIdstringRequired
Responses
200Success
delete
DELETE /api/v1/customers/{customerId}/initiatives/{initiativeExternalId}/codes HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200Success
No content
PreviousCodesNextValidation Rules

Last updated