PermuteDocs
Go to Permute

Write syncs · writeSyncsDestinations

Discover writable destinations

Lists connectors the key can read and write, supported destination objects, and their field contracts. Quo currently supports creating contacts only.

GET/v1/write-syncs/destinations
betaapiKeyworkspace

When to use

Discover destinations and their supported field contracts.

For agents

Quo creates contacts only. Matching uses its last read sync, so refresh that connector before previewing if newer contacts may exist. Unchanged matches are skipped; changed linked records and ambiguous matches are blocked.

Example

typescript
import { PermuteClient } from '@permute/sdk';

const orgClient = new PermuteClient({
  apiKey: process.env.PERMUTE_API_KEY!,
});

const client = orgClient.withWorkspace(process.env.PERMUTE_WORKSPACE_ID!);

const result = await client.writeSyncs.destinations();

Response

json
{
  "data": {
    "items": [
      {
        "id": "conn_quo123",
        "name": "Quo",
        "provider": "quo",
        "objects": [
          {
            "object": "contacts",
            "scope": "",
            "label": "Contacts (create only)",
            "fields": [
              {
                "name": "firstName",
                "label": "First name",
                "type": "string"
              },
              {
                "name": "lastName",
                "label": "Last name",
                "type": "string"
              },
              {
                "name": "company",
                "label": "Company",
                "type": "string"
              },
              {
                "name": "role",
                "label": "Role",
                "type": "string"
              },
              {
                "name": "emails",
                "label": "Email addresses",
                "type": "array"
              },
              {
                "name": "phoneNumbers",
                "label": "Phone numbers",
                "type": "array"
              }
            ]
          }
        ]
      }
    ]
  }
}