COcoevera
Translation

Translations.create

Creates a Translation record.

post/entities/Translations

Request

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

modifiedstring date-time

Last modification time.

createdstring date-time

Creation time.

account_type_idstring uuid

Id of the account type whose form this translation applies to. Set only when label_type is FormField or FormDescription.

appointment_type_idstring uuid

Id of the appointment type whose form this translation applies to. Set only when label_type is FormField or FormDescription.

contact_type_idstring uuid

Id of the contact type whose form this translation applies to. Set only when label_type is FormField or FormDescription.

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

Form of the record type the translation applies to: the edit form, or the lost form of a lead or opportunity type. Required when label_type is FormField or FormDescription.

Integer enum value: 0 - Edit, 1 - Lost

label_type0 | 1 | 2 | 3 required

Kind of text the row translates: a field name (Field), a dropdown or radio option (Data), or the label or description of a field on the form of one record type (FormField, FormDescription).

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

lead_type_idstring uuid

Id of the lead type whose form this translation applies to. Set only when label_type is FormField or FormDescription.

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 whose form this translation applies to. Set only when label_type is FormField or FormDescription.

project_type_idstring uuid

Id of the project type whose form this translation applies to. Set only when label_type is FormField or FormDescription.

pt_brstring

Translated text in Brazilian Portuguese.

task_type_idstring uuid

Id of the task type whose form this translation applies to. Set only when label_type is FormField or FormDescription.

is_publishedboolean

True when the translation is published; false while it exists only as an unpublished draft.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "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
}

Response

The created Translation record.

successboolean

True when the request 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
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.