🌿
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

Clients

PreviousIngestionNextCodes

Last updated 1 year ago

  • POST/api/v1/customers/{customerId}/clients/import
  • POST/api/v1/customers/{customerId}/clients/batch
post
Authorizations
Path parameters
customerIdstring · objectidRequired
Body
externalIdstringRequired

client's external id

namestringRequired

a name that identifies this client

callSignstringRequired

a short name or abbreviation that identifies this client

descriptionstringRequired

client's description

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

{
  "externalId": "text",
  "name": "text",
  "callSign": "text",
  "description": "text"
}
201Success
No content
post
Authorizations
Path parameters
customerIdstring · objectidRequired
Query parameters
isInitialbooleanOptional
Body
Responses
201Success
post
POST /api/v1/customers/{customerId}/clients/batch HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "clients": [
    {
      "externalId": "text",
      "name": "text",
      "callSign": "text",
      "description": "text"
    }
  ]
}
201Success
No content