create

Production

https://api.checkandplace.com

POST

/v1/customers

Request

Authorization

API Key

Add parameter in header

CheckandPlace-Access-Token

Example:

CheckandPlace-Access-Token: ********************

Body Params application/json

Examples

Responses

🟢200

application/json

successful

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.checkandplace.com/v1/customers' \
--header 'CheckandPlace-Access-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "first_name": "string",
    "last_name": "string",
    "customer_type_id": "17f23787-378b-4416-8520-1bc89c43d022",
    "primary_phone_number": "905553332211",
    "gender": 0,
    "country": "TR",
    "guest_language": "tr",
    "email": "example@mail.com",
    "note": "Example note",
    "blacklist": true,
    "allow_sms": true,
    "allow_email": true,
    "permits": {
        "sms": {
            "permit": true,
            "value": "string",
            "source": "string",
            "change_date": "2019-08-24T14:15:22.123Z",
            "verified": true
        },
        "email": {
            "permit": true,
            "value": "string",
            "source": "string",
            "change_date": "2019-08-24T14:15:22.123Z",
            "verified": true
        },
        "call": {
            "permit": true,
            "value": "string",
            "source": "string",
            "change_date": "2019-08-24T14:15:22.123Z",
            "verified": true
        },
        "whatsapp": {
            "permit": true,
            "value": "string",
            "source": "string",
            "change_date": "2019-08-24T14:15:22.123Z",
            "verified": true
        }
    }
}'

Response Example

{
    "customer": {
        "id": "fbb6c72b-802b-4cbf-9b2f-948a5de4854b",
        "first_name": "John",
        "last_name": "Doe",
        "primary_phone_number": "905553331122",
        "type_name": "normal",
        "allow_sms": true,
        "allow_email": true,
        "permission_informations": [],
        "organization": {
            "id": "547d7c63-18c7-40f0-bf2a-a29737c312a9",
            "name": "Example Organization",
            "slug": "example-organization"
        }
    }
}

Modified at 2026-05-06 13:06:45

Introduction

index