馃尶
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. Time

Initiatives

PreviousEntriesNextValidation Rules

Last updated 1 year ago

Deprecated
delete
Authorizations
Path parameters
customerIdstring 路 objectidrequired

customer id

initiativeExternalIdstringrequired

initiative's external id

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request DELETE \
  --url '/api/v1/customers/{customerId}/initiatives/{initiativeExternalId}/codes' \
  --header 'Authorization: Bearer JWT'
200
No body
delete
Authorizations
Path parameters
customerIdstring 路 objectidrequired

customer id

initiativeExternalIdstringrequired
codeTypeExternalIdstringrequired
Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request DELETE \
  --url '/api/v1/customers/{customerId}/initiatives/{initiativeExternalId}/code-types/{codeTypeExternalId}/codes' \
  --header 'Authorization: Bearer JWT'
200
No body
  • POST/api/v1/customers/{customerId}/initiatives/import
  • POST/api/v1/customers/{customerId}/initiatives/{initiativeExternalId}/access
  • DELETE/api/v1/customers/{customerId}/initiatives/{initiativeExternalId}/codes
  • POST/api/v1/customers/{customerId}/initiatives/{initiativeExternalId}/codes
  • POST/api/v2/customers/{customerId}/initiatives/{initiativeExternalId}/codes
  • POST/api/v1/customers/{customerId}/initiatives/{initiativeExternalId}/code-types/{codeTypeExternalId}/codes
  • DELETE/api/v1/customers/{customerId}/initiatives/{initiativeExternalId}/code-types/{codeTypeExternalId}/codes
post
Authorizations
Path parameters
customerIdstring 路 objectidrequired

customer id

Body
billingTypestring 路 enumrequired

the billing type for this initiative

Available options:
externalIdstringrequired

initiative's external id

namestringrequired

a name that identifies this initiative

descriptionstringrequired

the description of the initiative

callSignstringrequired

a short name or abbreviation that identifies this initiative

clientExternalIdstringrequired

external id of client this initiative belongs to

unitIncrementsnumber 路 doublerequired

unit of billing increments for this initiative in seconds. 36 = 0.01, 360 = 0.1 and 900 = 0.25

statusstring 路 enumoptional

initiative's status

Available options:
Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/api/v1/customers/{customerId}/initiatives/import' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "billingType": "billable",
    "externalId": "text",
    "name": "text",
    "description": "text",
    "callSign": "text",
    "clientExternalId": "text",
    "unitIncrements": 1,
    "status": "active"
  }'
201
No body
post
Authorizations
Path parameters
customerIdstring 路 objectidrequired

customer id

initiativeExternalIdstringrequired

initiative's external id

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
Deprecated
post
Authorizations
Path parameters
customerIdstring 路 objectidrequired

customer id

initiativeExternalIdstringrequired

initiative's external id

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
Deprecated
post
Authorizations
Path parameters
customerIdstring 路 objectidrequired

customer id

initiativeExternalIdstringrequired

initiative's external id

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

customer id

initiativeExternalIdstringrequired
codeTypeExternalIdstringrequired
Body
codeExternalIdsstring[] 路 min: 1 路 max: 2500required
Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/api/v1/customers/{customerId}/initiatives/{initiativeExternalId}/code-types/{codeTypeExternalId}/codes' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "codeExternalIds": [
      "text"
    ]
  }'
201
No body