Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Online

OnlineFormRelations.update

Modifies OnlineFormRelation or OnlineFormRelations with given id(s)

patch/entities/OnlineFormRelations/{id}

Path parameters

idstring uuid required

ID of OnlineFormRelation to update

Query parameters

validation-levelinteger

Specify validation level of OnlineFormRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

account_idstring uuid

Id of the linked account.

contact_idstring uuid

Id of the linked contact.

custom_entity_idstring uuid

Id of the linked custom entity record.

is_primaryboolean

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_idstring uuid

Id of the linked lead or opportunity, or empty when not linked.

online_form_idstring uuid

Id of the submission.

project_idstring uuid

Id of the linked project.

quote_idstring uuid

Id of the linked quote.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "account_id": "01234567-abcd-dcba-ffff-000000000000",
  "contact_id": "01234567-abcd-dcba-ffff-000000000000",
  "custom_entity_id": "01234567-abcd-dcba-ffff-000000000000",
  "lead_oppty_id": "01234567-abcd-dcba-ffff-000000000000",
  "online_form_id": "01234567-abcd-dcba-ffff-000000000000",
  "project_id": "01234567-abcd-dcba-ffff-000000000000",
  "quote_id": "01234567-abcd-dcba-ffff-000000000000",
  "revision": 1
}

Response

Modification confirmation. Returns resulting OnlineFormRelation

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "account_id": "01234567-abcd-dcba-ffff-000000000000",
    "contact_id": "01234567-abcd-dcba-ffff-000000000000",
    "custom_entity_id": "01234567-abcd-dcba-ffff-000000000000",
    "lead_oppty_id": "01234567-abcd-dcba-ffff-000000000000",
    "online_form_id": "01234567-abcd-dcba-ffff-000000000000",
    "project_id": "01234567-abcd-dcba-ffff-000000000000",
    "quote_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1
  }
}