Bulk Load Directory Members

Load Directory Members: records with an id update that member, records without create.

Updates only touch fields the record carries: omitting extensions, contact_tags, or comments leaves the stored values unchanged, while an explicit empty value clears them. The whole payload is applied in one transaction. A record whose id matches no existing member in the caller's organization, or an id appearing twice in the payload, fails the upload with a 400 naming the offending record(s); nothing is written.

PUT/api/v1/directory_members/upload/

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

This endpoint has no declared parameters.

Request body

multipart/form-data

body Body_directory_member_bulk_load required

1 field

filestring (binary)required

Request example

{
  "file": "string"
}

Responses

200Successful Response

application/json

response unspecified required

Response example

string

400Bad Request

No response body is declared.

404Not Found

No response body is declared.

412Precondition Failed

No response body is declared.

422Validation Error

application/json

response HTTPValidationError required

1 field

detailValidationError[]optional

Item schema

itemsValidationErrorrequired

3 fields

locstring | integer[]required

Item schema

itemsstring | integerrequired

2 options

Option 1stringrequired

Option 2integerrequired

msgstringrequired

typestringrequired

Response example

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

500Internal Server Error

No response body is declared.

Code examples

import { openAsBlob } from "node:fs";
import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLE_API_KEY"] ?? "",
});

async function run() {
  const result = await syllableSDK.directory.directoryMemberBulkLoad({
    file: await openAsBlob("example.file"),
  });

  console.log(result);
}

run();

import os
from syllable_sdk import SyllableSDK


with SyllableSDK(
    api_key_header=os.getenv("SYLLABLE_API_KEY", ""),
) as ss_client:

    res = ss_client.directory.directory_member_bulk_load(request={
        "file": {
            "file_name": "example.file",
            "content": open("example.file", "rb"),
        },
    })

    # Handle response
    print(res)

curl --request PUT \
  --url 'https://api.syllable.cloud/api/v1/directory_members/upload/' \
  --header 'content-type: multipart/form-data' \
  --data '{
  "file": "string"
}'