v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Translation

Translations.update

Modifies Translation or Translations with given id(s)

patch/entities/Translations/{id}

Path parameters

idstring uuid required

ID of Translation to update

Query parameters

validation-levelinteger

Specify validation level of Translation 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_type_idstring uuid

Id of the account type.

appointment_type_idstring uuid

Id of the appointment type.

contact_type_idstring uuid

Id of the contact type.

data_idstring uuid

Id of the translated data option.

de_destring

Translated text in German.

en_usstring

Translated text in US English.

es_esstring

Translated text in Spanish.

field_idstring uuid

Id of the translated field.

form_type0 | 1

Field whose values are strictly defined with an enumeration of values.

Integer enum value: 0 - Edit, 1 - Lost

label_type0 | 1 | 2 | 3

Field whose values are strictly defined with an enumeration of values.

Integer enum value: 0 - Field, 1 - Data, 2 - FormField, 3 - FormDescription

lead_type_idstring uuid

Id of the lead type.

oppty_product_relation_type_idstring uuid

Id of the opportunity product relation type.

oppty_type_idstring uuid

Id of the opportunity type.

product_type_idstring uuid

Id of the product type.

project_type_idstring uuid

Id of the project type.

pt_brstring

Translated text in Brazilian Portuguese.

task_type_idstring uuid

Id of the task type.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "account_type_id": "01234567-abcd-dcba-ffff-000000000000",
  "appointment_type_id": "01234567-abcd-dcba-ffff-000000000000",
  "contact_type_id": "01234567-abcd-dcba-ffff-000000000000",
  "data_id": "01234567-abcd-dcba-ffff-000000000000",
  "de_de": "string",
  "en_us": "string",
  "es_es": "string",
  "field_id": "01234567-abcd-dcba-ffff-000000000000",
  "lead_type_id": "01234567-abcd-dcba-ffff-000000000000",
  "oppty_product_relation_type_id": "01234567-abcd-dcba-ffff-000000000000",
  "oppty_type_id": "01234567-abcd-dcba-ffff-000000000000",
  "product_type_id": "01234567-abcd-dcba-ffff-000000000000",
  "project_type_id": "01234567-abcd-dcba-ffff-000000000000",
  "pt_br": "string",
  "task_type_id": "01234567-abcd-dcba-ffff-000000000000",
  "revision": 1
}

Response

Modification confirmation. Returns resulting Translation

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_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "appointment_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "contact_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "data_id": "01234567-abcd-dcba-ffff-000000000000",
    "de_de": "string",
    "en_us": "string",
    "es_es": "string",
    "field_id": "01234567-abcd-dcba-ffff-000000000000",
    "lead_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "oppty_product_relation_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "oppty_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "product_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "project_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "pt_br": "string",
    "task_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1
  }
}