LEleadmagic
Batch

Create a Batch Client

Changed on

Create an organization-scoped client for segmenting downstream batch work.

post/v1/batch/clients

Request

  • Base URL
    https://api.leadmagic.io
  • Auth
    API key in header X-API-Key

Request body

namestring required

Unique client identifier (slug). Lowercase, alphanumeric with hyphens.

display_namestring

Human-readable display name.

contact_emailstring email

Contact email for notifications.

billing_ratenumber

Optional billing rate applied to this client.

notesstring

Internal notes.

industrystring

Industry classification.

websitestring

Client website.

phonestring

Phone number.

addressobject

Physical address object.

custom_fieldsobject

Arbitrary custom fields stored with the client.

Example request

{
  "name": "acme-corp",
  "display_name": "Acme Corporation"
}

Response

Client created.

object required

Changes

  • 1f289eff3a26Revision changes
    • breaking

      the ////// response's property format changed from uri to uri-reference for status

    • breaking

      the ////////// response's property format changed from uri to uri-reference for status

    • breaking

      the ////////// response's property format changed from uri to uri-reference for status

  • 08b59585eeb7Revision changes
    • breaking

      added the new required request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property