--- title: "Clients.create" method: POST path: "/entities/Clients" tags: ["Client"] --- # Clients.create `POST /entities/Clients` ## Request - Base URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id` - URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id/entities/Clients` - Auth: HTTP basic - TypeScript: (a function with typed inputs; its response is checked against the schema) Creates a Client record. ## Query parameters - `validation-level` integer ## Request body - CreateClientInput: Field values of a new Client record. - `modified` string, date-time: Last modification time. - `created` string, date-time: Creation time. - `default_unit_id` string, uuid, required: Id of the default sales unit. - `email` string, required: Email. Readonly information from UserProfile. - `first_name` string: First name. Readonly information from UserProfile. - `last_active` string, date-time: Timestamp of the user's most recent login or API request. - `last_name` string: Last name. Readonly information from UserProfile. - `master_right_id` string, uuid, required: Id of the assigned user role. - `middle_name` string: Middle name. Readonly information from UserProfile. - `phone` string: Phone number. Readonly information from UserProfile. - `position` string: Job title or position of the user. - `region` string: Region. Readonly information from UserProfile. - `timezone` string: Deprecated time zone offset of the user, copied from the user profile; read-only. Use timezone_name instead. - `type` 0 | 1 | 2: Kind of user: a regular Customer user, a Coevera Support user, or a Placeholder demo user that becomes a Customer when reassigned to a real person. Integer enum value: 0 - Customer, 1 - Support, 2 - Placeholder - `revision` integer: Revision when entity was lastly changed. - `unit_membership` object[], required: Sales units the user belongs to (as member or manager). - `id` string, uuid: Id of the related SalesUnitClientRelation record. - `appointment_favorite` object[]: Appointments marked as favorite by the user. - `id` string, uuid: Id of the related ClientFavorite record. - `task_favorite` object[]: Tasks marked as favorite by the user. - `id` string, uuid: Id of the related ClientFavorite record. - `account_favorite` object[]: Accounts marked as favorite by the user. - `id` string, uuid: Id of the related ClientFavorite record. - `contact_favorite` object[]: Contacts marked as favorite by the user. - `id` string, uuid: Id of the related ClientFavorite record. - `profile_favorite` object[]: Screen profiles marked as favorite by the user. - `id` string, uuid: Id of the related ClientFavorite record. - `report_favorite` object[]: Reports marked as favorite by the user. - `id` string, uuid: Id of the related ClientFavorite record. - `lead_favorite` object[]: Leads marked as favorite by the user. - `id` string, uuid: Id of the related ClientFavorite record. - `opportunity_favorite` object[]: Opportunities marked as favorite by the user. - `id` string, uuid: Id of the related ClientFavorite record. ## Response `201` The created Client record. - object - `success` boolean: True when the request succeeded; false on error. - `data` Client: User of the space; owns records, belongs to sales units and has a user role that determines what they can do. - `is_delete_protected` boolean, required: True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. - `id` string, uuid, required: Unique identifier of entity. - `is_deleted` boolean: Specifies if the entity is considered deleted. - `modified` string, date-time: Last modification time. - `created` string, date-time: Creation time. - `default_unit` string, uri, required: Default sales unit for the user. New records the user creates are assigned to this unit by default. Related SalesUnit record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'SalesUnit' for its fields. - `master_right` string, uri, required: User role assigned to the user. Determines what features and entities the user can access. Related MasterRight record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'MasterRight' for its fields. - `default_unit_id` string, uuid, required: Id of the default sales unit. - `email` string, required: Email. Readonly information from UserProfile. - `first_name` string: First name. Readonly information from UserProfile. - `last_active` string, date-time: Timestamp of the user's most recent login or API request. - `last_name` string: Last name. Readonly information from UserProfile. - `master_right_id` string, uuid, required: Id of the assigned user role. - `middle_name` string: Middle name. Readonly information from UserProfile. - `phone` string: Phone number. Readonly information from UserProfile. - `picture_url` string: Picture name. Readonly information from UserProfile. - `position` string: Job title or position of the user. - `region` string: Region. Readonly information from UserProfile. - `timezone` string: Deprecated time zone offset of the user, copied from the user profile; read-only. Use timezone_name instead. - `type` 0 | 1 | 2: Kind of user: a regular Customer user, a Coevera Support user, or a Placeholder demo user that becomes a Customer when reassigned to a real person. Integer enum value: 0 - Customer, 1 - Support, 2 - Placeholder - `revision` integer: Revision when entity was lastly changed. - `default_idp` integer: Id of the identity provider the user signs in with by default. Empty when none is set or it is disabled. - `user_profile_id` integer: Id of the user account (login identity) this user belongs to. - `unit_membership` string[], required: Sales units the user belongs to (as member or manager). - `appointment_favorite` string[]: Appointments marked as favorite by the user. - `task_favorite` string[]: Tasks marked as favorite by the user. - `account_favorite` string[]: Accounts marked as favorite by the user. - `contact_favorite` string[]: Contacts marked as favorite by the user. - `profile_favorite` string[]: Screen profiles marked as favorite by the user. - `report_favorite` string[]: Reports marked as favorite by the user. - `lead_favorite` string[]: Leads marked as favorite by the user. - `opportunity_favorite` string[]: Opportunities marked as favorite by the user. - `timezone_name` string: IANA time zone name of the user (e.g. Europe/Prague), or empty when the time zone is set automatically from the user's operating system. Read-only. - `name` string: Display name of the user, formatted according to the user's name format preference. - `formatted_name` string, required: Display name of the user (alias of name). - `unit_manager_ids` string[], required: Ids of all sales units the user manages, expanded to include all descendant units in each managed subtree. - `unit_member_ids` string[], required: Ids of sales units the user belongs to as a member only (not as a manager). - `user_recalculation_state` 'InProgress' | 'NoRecalculation' | 'Pending': State of the user's row-level access recalculation: NoRecalculation (up to date), Pending (queued), or InProgress. ## Other responses - `400`: Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`. - `401`: Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED). - `422`: Validation failed (code 40000, with the failing fields) or a required parameter is missing (code 119). By default one failed item fails a whole batch and nothing is written. - `429`: Too many requests (code 182). Wait for the seconds in Retry-After, then retry. - `500`: Unexpected server error (code 1000, ERROR_UNKNOWN). --- [API](https://skmtc.dev/coevera/apis/coevera-crm-api.md) - [All operations](https://skmtc.dev/coevera/apis/coevera-crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/coevera/apis/coevera-crm-api/revisions/40ebbc83f179?raw)