S2S Contacts

Upsert contact

Create or update a contact. Returns the full contact including its unread conversation count.

PUT

https://api.gleap.io/v3/s2s/contacts/{userId}

Authorizations

Authorizationstring · headerrequired

Bearer authentication header of the form Bearer <token>.

Path parameters

userIdstringrequired

Headers

Gleap-Versionstring

Pin a specific API version; defaults to the current version.

Example: 2026-08-01

Bodyapplication/jsonrequired

namestring

emailstring

phonestring

languagestring

ISO language code, e.g. "en", "az".

companyIdstring

companyNamestring

Show 3 more attributes

planstring

valuenumber<double>

customDataany

Arbitrary custom contact data (flat key→value object).

Response

application/json

userIdstringrequired

namestring

emailstring

phonestring

languagestring

companyIdstring

Show 7 more attributes

companyNamestring

planstring

valuenumber<double>

customDataobject

Construct a type with a set of properties K of type T

unreadnumber<double>

createdAtstring<date-time>

lastActivityAtstring<date-time>

application/problem+json

Missing, invalid or revoked service account token.

typestringrequired

Example: https://docs.gleap.io/s2s/problems/conversation_closed

titlestringrequired

statusnumberrequired

codestringrequired

Example: conversation_closed

detailstring

request_idstring

Example: req_66c0ffee0000000000000001

application/problem+json

The addressed resource does not exist in this project.

typestringrequired

Example: https://docs.gleap.io/s2s/problems/conversation_closed

titlestringrequired

statusnumberrequired

codestringrequired

Example: conversation_closed

detailstring

request_idstring

Example: req_66c0ffee0000000000000001

application/problem+json

Idempotency-Key reuse with a different request body.

typestringrequired

Example: https://docs.gleap.io/s2s/problems/conversation_closed

titlestringrequired

statusnumberrequired

codestringrequired

Example: conversation_closed

detailstring

request_idstring

Example: req_66c0ffee0000000000000001

application/problem+json

Rate limit exceeded — honor the Retry-After header.

typestringrequired

Example: https://docs.gleap.io/s2s/problems/conversation_closed

titlestringrequired

statusnumberrequired

codestringrequired

Example: conversation_closed

detailstring

request_idstring

Example: req_66c0ffee0000000000000001

application/problem+json

Any other error, including validation_failed (400) and internal_error (500).

typestringrequired

Example: https://docs.gleap.io/s2s/problems/conversation_closed

titlestringrequired

statusnumberrequired

codestringrequired

Example: conversation_closed

detailstring

request_idstring

Example: req_66c0ffee0000000000000001

Updated November 1, 2026

curl --request PUT \
  --url 'https://api.gleap.io/v3/s2s/contacts/{userId}' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<name>",
  "email": "<email>",
  "phone": "<phone>",
  "language": "<language>"
}'

{
  "userId": "string",
  "name": "string",
  "email": "string",
  "phone": "string",
  "language": "string",
  "companyId": "string",
  "companyName": "string",
  "plan": "string",
  "value": 0,
  "customData": {},
  "unread": 0,
  "createdAt": "2026-01-01T12:00:00Z",
  "lastActivityAt": "2026-01-01T12:00:00Z"
}

{
  "type": "https://docs.gleap.io/s2s/problems/conversation_closed",
  "title": "string",
  "status": 0,
  "code": "conversation_closed",
  "detail": "string",
  "request_id": "req_66c0ffee0000000000000001"
}

{
  "type": "https://docs.gleap.io/s2s/problems/conversation_closed",
  "title": "string",
  "status": 0,
  "code": "conversation_closed",
  "detail": "string",
  "request_id": "req_66c0ffee0000000000000001"
}

{
  "type": "https://docs.gleap.io/s2s/problems/conversation_closed",
  "title": "string",
  "status": 0,
  "code": "conversation_closed",
  "detail": "string",
  "request_id": "req_66c0ffee0000000000000001"
}

{
  "type": "https://docs.gleap.io/s2s/problems/conversation_closed",
  "title": "string",
  "status": 0,
  "code": "conversation_closed",
  "detail": "string",
  "request_id": "req_66c0ffee0000000000000001"
}

{
  "type": "https://docs.gleap.io/s2s/problems/conversation_closed",
  "title": "string",
  "status": 0,
  "code": "conversation_closed",
  "detail": "string",
  "request_id": "req_66c0ffee0000000000000001"
}

Response

application/json

userIdstringrequired

namestring

emailstring

phonestring

languagestring

companyIdstring

Show 7 more attributes

companyNamestring

planstring

valuenumber<double>

customDataobject

Construct a type with a set of properties K of type T

unreadnumber<double>

createdAtstring<date-time>

lastActivityAtstring<date-time>

application/problem+json

Missing, invalid or revoked service account token.

typestringrequired

Example: https://docs.gleap.io/s2s/problems/conversation_closed

titlestringrequired

statusnumberrequired

codestringrequired

Example: conversation_closed

detailstring

request_idstring

Example: req_66c0ffee0000000000000001

application/problem+json

The addressed resource does not exist in this project.

typestringrequired

Example: https://docs.gleap.io/s2s/problems/conversation_closed

titlestringrequired

statusnumberrequired

codestringrequired

Example: conversation_closed

detailstring

request_idstring

Example: req_66c0ffee0000000000000001

application/problem+json

Idempotency-Key reuse with a different request body.

typestringrequired

Example: https://docs.gleap.io/s2s/problems/conversation_closed

titlestringrequired

statusnumberrequired

codestringrequired

Example: conversation_closed

detailstring

request_idstring

Example: req_66c0ffee0000000000000001

application/problem+json

Rate limit exceeded — honor the Retry-After header.

typestringrequired

Example: https://docs.gleap.io/s2s/problems/conversation_closed

titlestringrequired

statusnumberrequired

codestringrequired

Example: conversation_closed

detailstring

request_idstring

Example: req_66c0ffee0000000000000001

application/problem+json

Any other error, including validation_failed (400) and internal_error (500).

typestringrequired

Example: https://docs.gleap.io/s2s/problems/conversation_closed

titlestringrequired

statusnumberrequired

codestringrequired

Example: conversation_closed

detailstring

request_idstring

Example: req_66c0ffee0000000000000001

curl --request PUT \ --url 'https://api.gleap.io/v3/s2s/contacts/{userId}' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "<name>", "email": "<email>", "phone": "<phone>", "language": "<language>" }'

{ "userId": "string", "name": "string", "email": "string", "phone": "string", "language": "string", "companyId": "string", "companyName": "string", "plan": "string", "value": 0, "customData": {}, "unread": 0, "createdAt": "2026-01-01T12:00:00Z", "lastActivityAt": "2026-01-01T12:00:00Z" }

{ "type": "https://docs.gleap.io/s2s/problems/conversation_closed", "title": "string", "status": 0, "code": "conversation_closed", "detail": "string", "request_id": "req_66c0ffee0000000000000001" }