update

Production

https://api.checkandplace.com

PATCH

/api/v1/customers/{id}/nickname

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

API Key

Add parameter in header

EMPLOYEE_TOKEN

Example:

EMPLOYEE_TOKEN: ********************

API Key

Add parameter in header

STORE_PIN_CODE

Example:

STORE_PIN_CODE: ********************

API Key

Add parameter in header

SLUG_NAME

Example:

SLUG_NAME: ********************

Path Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

successful

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://api.checkandplace.com/api/v1/customers//nickname' \
--header 'Authorization: <api-key>' \
--header 'EMPLOYEE_TOKEN: <api-key>' \
--header 'STORE_PIN_CODE: <api-key>' \
--header 'SLUG_NAME: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "nickname": "string",
    "note": "string"
}'

Response Example

{
    "customer": {
        "id": "00d8c9d8-5a70-4f1a-bd92-416921912d4e",
        "first_name": "Unknown",
        "last_name": "Customer 1",
        "name": "Example Nickname",
        "country_code": null,
        "primary_phone_number": null,
        "small_image_url": null,
        "medium_image_url": null,
        "large_image_url": null,
        "type_id": null,
        "type_name": null,
        "is_default_type": false,
        "is_anonym": true,
        "email": null,
        "blacklist": false,
        "gender": "unknown",
        "gender_as_integer": 0,
        "country": null,
        "guest_language": "en",
        "nickname": "Example Nickname",
        "allow_sms": true,
        "allow_email": false,
        "is_active": true,
        "note": "Example Note",
        "created_at": "24.03.2025 14:11",
        "updated_at": "24.03.2025 14:11",
        "permits": {
            "sms": {
                "permit": null,
                "value": null,
                "source": null,
                "change_date": null,
                "verified": null
            },
            "email": {
                "permit": null,
                "value": null,
                "source": null,
                "change_date": null,
                "verified": null
            },
            "call": {
                "permit": null,
                "value": null,
                "source": null,
                "change_date": null,
                "verified": null
            },
            "whatsapp": {
                "permit": null,
                "value": null,
                "source": null,
                "change_date": null,
                "verified": null
            }
        },
        "tags": [],
        "reviews_average_score": 0
    }
}

Modified at 2026-03-09 18:33:58

create

calendar