馃尶
Laurel APIs
  • Introduction
  • Guides
    • Authentication
    • Building A Connector
    • Public Api Endpoints
  • Services
    • Identity
      • Oauth
      • Users
    • Ingestion
      • Clients
      • Codes
      • Initiatives
      • Validation Rules
    • Time
      • Clients
      • Code Types
      • Codes
      • Entries
      • Initiatives
      • Validation Rules
Powered by GitBook
On this page
  1. Services
  2. Ingestion

Initiatives

PreviousCodesNextValidation Rules

Last updated 11 months ago

delete
Authorizations
Path parameters
customerIdstring 路 objectidrequired
initiativeExternalIdstringrequired
Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request DELETE \
  --url '/api/v1/customers/{customerId}/initiatives/{initiativeExternalId}/codes' \
  --header 'Authorization: Bearer JWT'
200
No body
  • POST/api/v2/customers/{customerId}/initiatives/consolidated-batch
  • POST/api/v1/customers/{customerId}/initiatives/{initiativeExternalId}/access
  • POST/api/v1/customers/{customerId}/initiatives/{initiativeExternalId}/codes
  • DELETE/api/v1/customers/{customerId}/initiatives/{initiativeExternalId}/codes
post
Authorizations
Path parameters
customerIdstring 路 objectidrequired
Query parameters
isInitialbooleanoptional
Body
initiativesobject[]required

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/api/v2/customers/{customerId}/initiatives/consolidated-batch' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
          ]
        }
      }
    ]
  }'
201
No body
post
Authorizations
Path parameters
customerIdstring 路 objectidrequired
initiativeExternalIdstringrequired
Body
typestring 路 enumrequired

type of access.

Available options:
userIdsstring 路 objectid[]optional

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

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/api/v1/customers/{customerId}/initiatives/{initiativeExternalId}/access' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "allow",
    "userIds": [
      "text"
    ]
  }'
201
No body
post
Authorizations
Path parameters
customerIdstring 路 objectidrequired
initiativeExternalIdstringrequired
Body
codeExternalIdsstring[] 路 min: 1 路 max: 2500required
Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/api/v1/customers/{customerId}/initiatives/{initiativeExternalId}/codes' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "codeExternalIds": [
      "text"
    ]
  }'
201
No body