Create client

Staging

https://apis.hellotech.com

POST

/api/partners/clients

Creates client account and associate it with the partner. If external_id is provided and the client already exists it will be updated.

Request

Authorization

Add parameter in header

Api-Key

Example:

Api-Key: ********************

Body Params application/json

Example

{
    "external_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "full_address": "string",
    "phone": "string"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://apis.hellotech.com/api/partners/clients' \
--header 'Content-Type: application/json' \
--header 'Api-Key;' \
--data-raw '{
    "external_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "full_address": "string",
    "phone": "string"
}'

Responses

🟢200Client created successfully

application/json

Body

Example

{
    "id": 0,
    "external_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "phone": "string",
    "full_address": "string",
    "address": {
        "city": "string",
        "state": "string",
        "zip": "string",
        "street": "string"
    },
    "authentication_token": "string"
}

🟠400Error response

🟠404Error response

Modified at 2024-08-21 12:38:02

Create order

Retrieve client