- Print
- PDF
Member
- Print
- PDF
Description
This section introduces APIs for creating, editing, and deleting member information.
Get member API
You can search all of your member information.
Request URL
Request headers
Header | Description |
---|---|
x-project-id | - Dashboard > Settings > General > Project ID |
x-api-key | - Dashboard > Settings > General > API key |
Request path parameter
Parameter | Type | Required | Description |
---|---|---|---|
channelId | String | O | Channel ID |
Request query parameter
Parameter | Type | Required | Description |
---|---|---|---|
filter | String | O | Enter {} by default. Filters allow you to search for some fields |
sort | String | X | Define the filter for the fields you want to sort |
option | String | X | See the below when there are options |
Request example
Response example (normal)
Response
It is returned as an HTTP status code and forwarded as body information.
HTTP status code | Response Message | Description |
---|---|---|
200 | OK | General successful request |
400 | Bad Request | Used for general request failure (usually used to respond to a request format that the server can't understand) |
500 | Internal Server Error | - Response code for general server errors - While 4XX error codes represent client-side errors - 5xx error codes represent server-side errors |
Get individual member information API
You can get specific individual member information.
Request URL
Request headers
Header | Description |
---|---|
x-project-id | - Dashboard > Settings > General > Project ID |
x-api-key | - Dashboard > Settings > General > API key |
Request path parameter
Parameter | Type | Required | Description |
---|---|---|---|
userId | String | Y | Member ID |
Request example
Response example (normal)
Response
It is returned as an HTTP status code and forwarded as body information.
HTTP status code | Response Message | Description |
---|---|---|
200 | OK | General successful request |
400 | Bad Request | Used for general request failure (usually used to respond to a request format that the server can't understand) |
500 | Internal Server Error | - Response code for general server errors - While 4XX error codes represent client-side errors - 5xx error codes represent server-side errors |
Create member API
You can send the Create member API.
Request URL
Request headers
Header | Description |
---|---|
x-project-id | - Dashboard > Settings > General > Project ID |
x-api-key | - Dashboard > Settings > General > API key |
Request body parameter
Parameter | Type | Required | Description |
---|---|---|---|
userId | String | Y | ID to create (4 - 128 characters allowed) |
name | String | Y | Nickname or name |
customField | String | N | customField |
Request example
Response example (normal)
Response
It is returned as an HTTP status code and forwarded as body information.
HTTP status code | Response Message | Description |
---|---|---|
200 | OK | General successful request |
400 | Bad Request | Used for general request failure (usually used to respond to a request format that the server can't understand) |
500 | Internal Server Error | - Response code for general server errors - While 4XX error codes represent client-side errors - 5xx error codes represent server-side errors |
Delete member API
Delete specific member information.
Request URL
Request headers
Header | Description |
---|---|
x-project-id | - Dashboard > Settings > General > Project ID |
x-api-key | - Dashboard > Settings > General > API key |
Request path parameter
Parameter | Type | Required | Description |
---|---|---|---|
userId | String | Y | Member ID |
Request example
Response example (normal)
Response
It is returned as an HTTP status code and forwarded as body information.
HTTP status code | Response Message | Description |
---|---|---|
200 | OK | General successful request |
400 | Bad Request | Used for general request failure (usually used to respond to a request format that the server can't understand) |
500 | Internal Server Error | - Response code for general server errors - While 4XX error codes represent client-side errors - 5xx error codes represent server-side errors |
Restore member API
Restore information of a deleted member.
Request URL
Request headers
Header | Description |
---|---|
x-project-id | - Dashboard > Settings > General > Project ID |
x-api-key | - Dashboard > Settings > General > API key |
Request path parameter
Parameter | Type | Required | Description |
---|---|---|---|
userId | String | Y | Member ID |
Request example
Response example (normal)
Response
It is returned as an HTTP status code and forwarded as body information.
HTTP status code | Response Message | Description |
---|---|---|
200 | OK | General successful request |
400 | Bad Request | Used for general request failure (usually used to respond to a request format that the server can't understand) |
500 | Internal Server Error | - Response code for general server errors - While 4XX error codes represent client-side errors - 5xx error codes represent server-side errors |
Register user token
Register the user's push token and change the listening status.
Request URL
Request headers
Header | Description |
---|---|
x-project-id | Dashboard > Settings > General > Project ID |
x-api-key | Dashboard > Settings > General > API key |
Request path parameters
Parameter | Type | Required | Description |
---|---|---|---|
userId | String | Y | Member ID |
Request body parameter
Parameter | Type | Required | Description |
---|---|---|---|
token | String | N | Push token |
device | String | N | Device push type (FCM , APNS ) |
os | String | N | Operating system type |
push | Boolean | N | Whether to receive push messages (true : receive all messages) |
ad | Boolean | N | Whether to receive ad messages (true : receive all messages) |
night | Boolean | N | Whether to receive night messages |
timezone | String | N | Time zone |
Request example
Response example (normal)
Response
It is returned as an HTTP status code and forwarded as body information.
HTTP status code | Response Message | Description |
---|---|---|
200 | OK | General successful request |
400 | Bad Request | Used for general request failure (usually used to respond to a request format that the server can't understand) |
500 | Internal Server Error | - Response code for general server errors - 4XX error codes used to represent client-side errors - 5xx error codes represent server-side errors |
Get user token
Get the user's push token and the push receipt status.
Request URL
Request headers
Header | Description |
---|---|
x-project-id | - Dashboard > Settings > General > Project ID |
x-api-key | - Dashboard > Settings > General > API key |
Request path parameter
Parameter | Type | Required | Description |
---|---|---|---|
userId | String | Y | Member ID |
Request example
Response example (normal)
Response
It is returned as an HTTP status code and forwarded as body information.
HTTP status code | Response Message | Description |
---|---|---|
200 | OK | General successful request |
400 | Bad Request | Used for general request failure (usually used to respond to a request format that the server can't understand) |
500 | Internal Server Error | - Response code for general server errors - 4XX error codes used to represent client-side errors - 5xx error codes represent server-side errors |