--- title: "OnlineFormRelations.create" method: POST path: "/entities/OnlineFormRelations" tags: ["Online Form"] --- # OnlineFormRelations.create `POST /entities/OnlineFormRelations` ## 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/OnlineFormRelations` - Auth: HTTP basic - TypeScript: (a function with typed inputs; its response is checked against the schema) Creates a OnlineFormRelation record. ## Query parameters - `validation-level` integer ## Request body - CreateOnlineFormRelationInput: Field values of a new OnlineFormRelation record. - `modified` string, date-time: Last modification time. - `created` string, date-time: Creation time. - `account_id` string, uuid: Id of the linked account. - `contact_id` string, uuid: Id of the linked contact. - `custom_entity_id` string, uuid: Id of the linked custom entity record. - `is_primary` boolean, required: True for the row that points to the submission's primary record. There is at most one primary relation per submission and its entity must match the form's entity_type. - `lead_oppty_id` string, uuid: Id of the linked lead or opportunity, or empty when not linked. - `online_form_id` string, uuid, required: Id of the submission. - `project_id` string, uuid: Id of the linked project. - `quote_id` string, uuid: Id of the linked quote. - `revision` integer: Revision when entity was lastly changed. ## Response `201` The created OnlineFormRelation record. - object - `success` boolean: True when the request succeeded; false on error. - `data` OnlineFormRelation: Link between an online form submission and a record it created or updated. - `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. - `account` string, uri: Account the submission is linked to, when applicable. Related Account record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Account' for its fields. - `contact` string, uri: Contact the submission is linked to, when applicable. Related Contact record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Contact' for its fields. - `custom_entity` string, uri: Custom entity record the submission is linked to, when applicable. Related CustomEntity record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'CustomEntity' for its fields. - `lead` string, uri: Lead the submission is linked to. Set when lead_oppty_id resolves to a Lead. Related Lead record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Lead' for its fields. - `oppty` string, uri: Opportunity the submission is linked to. Set when lead_oppty_id resolves to an Opportunity. Related Opportunity record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Opportunity' for its fields. - `online_form` string, uri: Online form submission being linked. Related OnlineForm record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'OnlineForm' for its fields. - `project` string, uri: Project the submission is linked to, when applicable. Related Project record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Project' for its fields. - `quote` string, uri: Quote the submission is linked to, when applicable. Related Quote record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Quote' for its fields. - `account_id` string, uuid: Id of the linked account. - `contact_id` string, uuid: Id of the linked contact. - `custom_entity_id` string, uuid: Id of the linked custom entity record. - `is_primary` boolean, required: True for the row that points to the submission's primary record. There is at most one primary relation per submission and its entity must match the form's entity_type. - `lead_oppty_id` string, uuid: Id of the linked lead or opportunity, or empty when not linked. - `online_form_id` string, uuid, required: Id of the submission. - `project_id` string, uuid: Id of the linked project. - `quote_id` string, uuid: Id of the linked quote. - `revision` integer: Revision when entity was lastly changed. ## 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)