Update contact by external ID | Paid

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.contacts.updateContactByExternalId("externalId", {
        body: {},
    });
}
main();

{
  "id": "c3f1a9d2-8b4e-4f7a-9d3e-2a1b5f6c7d8e",
  "customerId": "cust-789456123",
  "firstName": "Emily",
  "lastName": "Johnson",
  "email": "emily.johnson@example.com",
  "phone": "+1-555-123-4567",
  "externalId": "ext-456789123",
  "roles": [
    "BILLING"
  ],
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "billingAddress": {
    "street": "123 Maple Street",
    "city": "Springfield",
    "state": "IL",
    "country": "USA",
    "zipCode": "62704"
  }
}

Update a contact by its external ID

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Path parameters

externalIdstringRequired

Request

Body

customerIdstringOptional

firstNamestringOptional

lastNamestringOptional

emailstringOptionalformat: "email"

phonestring or nullOptional

billingAddressobjectOptional

externalIdstring or nullOptional

roleslist of enumsOptional

Allowed values:

Response

200

idstring

customerIdstring

firstNamestring

lastNamestring

emailstring

phonestring or null

externalIdstring or null

roleslist of enums

Allowed values:

createdAtdatetime

updatedAtdatetime

billingAddressobject

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error