website logo
Documentation
Guides
Navigate through spaces
Documentation
Guides
⌘K
Overview
Important Concepts
Family Systems
Fields
Products
Calls
Paginated Requests
Basic Authentication
Users
create
create_child
login
get_user_list
get_info
add_product
update
add_email
set_status
Status
create
Webhooks
JavaScript Customization
Docs powered by archbee 
5min

Status

The status endpoint

HTTP
|

The status endpoint allows you to create statuses, which can then be applied to users with the user api actions.

Basic structure

Each call to the API requires action and a group_id.

Name

Type

Required

Description

action

string

true

This describes what you would like to do with the api. For status, the only action is create.

group_id

integer

true

This designates which project the change should be applied to. API-id in the header must be part of the organization that owns the group.

doc

JSON

true

This is the status data you would like to include in the request, formatted as JSON.



Example call

This would be an example cURL which creates a status.

Curl
|

Example response

JSON
|



Updated 20 Apr 2022
Did this page help you?
Yes
No
UP NEXT
create
Docs powered by archbee 
TABLE OF CONTENTS
The status endpoint
Basic structure
Example call
Example response