🌿
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 11 months 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
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/api/v1/customers/{customerId}/clients/import' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "externalId": "text",
    "name": "text",
    "callSign": "text",
    "description": "text"
  }'
201
No body
post
Authorizations
Path parameters
customerIdstring · objectidrequired
Query parameters
isInitialbooleanoptional
Body
clientsobject[]required

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/api/v1/customers/{customerId}/clients/batch' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "clients": [
      {
        "externalId": "text",
        "name": "text",
        "callSign": "text",
        "description": "text"
      }
    ]
  }'
201
No body