Initiatives

post
Authorizations
Path parameters
customerIdstring · objectidRequired

customer id

Body
billingTypestring · enumRequired

the billing type for this initiative

Possible values:
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

Possible values:
Responses
201Success
post
POST /api/v1/customers/{customerId}/initiatives/import HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 162

{
  "billingType": "billable",
  "externalId": "text",
  "name": "text",
  "description": "text",
  "callSign": "text",
  "clientExternalId": "text",
  "unitIncrements": 1,
  "status": "active"
}
201Success
No content
post
Authorizations
Path parameters
customerIdstring · objectidRequired

customer id

initiativeExternalIdstringRequired

initiative's external id

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
Deprecated
delete
Authorizations
Path parameters
customerIdstring · objectidRequired

customer id

initiativeExternalIdstringRequired

initiative's external id

Responses
200Success
delete
DELETE /api/v1/customers/{customerId}/initiatives/{initiativeExternalId}/codes HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200Success
No content
Deprecated
post
Authorizations
Path parameters
customerIdstring · objectidRequired

customer id

initiativeExternalIdstringRequired

initiative's external id

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
Deprecated
post
Authorizations
Path parameters
customerIdstring · objectidRequired

customer id

initiativeExternalIdstringRequired

initiative's external id

Body
codeExternalIdsstring[] · min: 1 · max: 2500Required
Responses
201Success
post
POST /api/v2/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
post
Authorizations
Path parameters
customerIdstring · objectidRequired

customer id

initiativeExternalIdstringRequired
codeTypeExternalIdstringRequired
Body
codeExternalIdsstring[] · min: 1 · max: 2500Required
Responses
201Success
post
POST /api/v1/customers/{customerId}/initiatives/{initiativeExternalId}/code-types/{codeTypeExternalId}/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

customer id

initiativeExternalIdstringRequired
codeTypeExternalIdstringRequired
Responses
200Success
delete
DELETE /api/v1/customers/{customerId}/initiatives/{initiativeExternalId}/code-types/{codeTypeExternalId}/codes HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200Success
No content
PreviousEntriesNextValidation Rules

Last updated