SOsoraban
Clients

Create a client

Changed on

Creates a client and their first entity in one call. When entity_type is omitted it defaults to Individual, and the entity is named "Lastname, Firstname" unless you pass company_name.

Whether assigned_advisor_id is required depends on the firm: firms on the newer contact management model reject the parameter outright, and firms on the older model require it.

post/clients

Request

Request body

fnamestring required
lnamestring required
emailstring email required
assigned_advisor_idinteger

Required for firms on the older contact management model; rejected for firms on the newer one.

entity_typestring

Type of the entity created alongside the client.

company_namestring

Name for that entity. Defaults to "Lastname, Firstname" for an Individual.

external_user_idstring

Your own identifier for the client.

external_entity_idstring

Your own identifier for the entity.

phone_numberstring
work_phone_numberstring
work_phone_extensionstring
work_emailstring email
preferred_contact_methodstring
time_zonestring
streetstring
citystring
statestring
zipstring
countrystring
business_emailstring email
other_emailstring email

Response

The client and the entity created alongside them.

Changes

  • 1c230fa547adRevision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the response property became optional for the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      deleted the header request parameter ngrok-skip-browser-warning

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      api operation id createClient was added

    • info

      the endpoint scheme security bearerAuth was removed from the API

    • info

      api tag Clients added

    • 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

    • 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

      the request property became optional

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status