--- title: "Translations.update" method: PATCH path: "/entities/Translations/{id}" tags: ["Translation"] --- # Translations.update `PATCH /entities/Translations/{id}` ## 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/Translations/{id}` - Auth: HTTP basic - TypeScript: (a function with typed inputs; its response is checked against the schema) Changes fields of the Translation record with the given id; fields left out keep their values. ## Path parameters - `id` string, uuid, required ## Query parameters - `validation-level` integer ## Request body - UpdateTranslationInput: Field values to change on a Translation record; fields left out keep their values. - `account_type_id` string, uuid: Id of the account type whose form this translation applies to. Set only when label_type is FormField or FormDescription. - `appointment_type_id` string, uuid: Id of the appointment type whose form this translation applies to. Set only when label_type is FormField or FormDescription. - `contact_type_id` string, uuid: Id of the contact type whose form this translation applies to. Set only when label_type is FormField or FormDescription. - `data_id` string, uuid: Id of the translated data option. - `de_de` string: Translated text in German. - `en_us` string: Translated text in US English. - `es_es` string: Translated text in Spanish. - `field_id` string, uuid: Id of the translated field. - `form_type` 0 | 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_type` 0 | 1 | 2 | 3: 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_id` string, 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_id` string, uuid: Id of the opportunity product relation type. - `oppty_type_id` string, uuid: Id of the opportunity type. - `product_type_id` string, uuid: Id of the product type whose form this translation applies to. Set only when label_type is FormField or FormDescription. - `project_type_id` string, uuid: Id of the project type whose form this translation applies to. Set only when label_type is FormField or FormDescription. - `pt_br` string: Translated text in Brazilian Portuguese. - `task_type_id` string, uuid: Id of the task type whose form this translation applies to. Set only when label_type is FormField or FormDescription. - `revision` integer: Revision when entity was lastly changed. ## Response `200` The changed Translation record. - object - `success` boolean: True when the request succeeded; false on error. - `data` Translation: Translation of a field name, dropdown option or form text into the supported languages. - `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. - `has_draft` boolean, required: True when the record has unpublished draft changes, including pending translation changes, that can be published. - `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_type` string, uri: Account type the form-level translation applies to. Related AccountType record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'AccountType' for its fields. - `appointment_type` string, uri: Appointment type the form-level translation applies to. Related AppointmentType record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'AppointmentType' for its fields. - `contact_type` string, uri: Contact type the form-level translation applies to. Related ContactType record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'ContactType' for its fields. - `data` string, uri: Data option (dropdown/radio choice) this row translates. Set when label_type is Data. Related Data record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Data' for its fields. - `field` string, uri: Field whose name/label this row translates. Set when label_type is Field, FormField, or FormDescription. Related Field record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Field' for its fields. - `lead_type` string, uri: Lead type the form-level translation applies to. Related LeadType record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'LeadType' for its fields. - `oppty_product_relation_type` string, uri: Opportunity product relation type the form-level translation applies to. Related OpptyProductRelationType record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'OpptyProductRelationType' for its fields. - `oppty_type` string, uri: Opportunity type the form-level translation applies to. Related OpportunityType record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'OpportunityType' for its fields. - `product_type` string, uri: Product type the form-level translation applies to. Related ProductType record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'ProductType' for its fields. - `project_type` string, uri: Project type the form-level translation applies to. Related ProjectType record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'ProjectType' for its fields. - `task_type` string, uri: Task type the form-level translation applies to. Related TaskType record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'TaskType' for its fields. - `account_type_id` string, uuid: Id of the account type whose form this translation applies to. Set only when label_type is FormField or FormDescription. - `appointment_type_id` string, uuid: Id of the appointment type whose form this translation applies to. Set only when label_type is FormField or FormDescription. - `contact_type_id` string, uuid: Id of the contact type whose form this translation applies to. Set only when label_type is FormField or FormDescription. - `data_id` string, uuid: Id of the translated data option. - `de_de` string: Translated text in German. - `en_us` string: Translated text in US English. - `es_es` string: Translated text in Spanish. - `field_id` string, uuid: Id of the translated field. - `form_type` 0 | 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_type` 0 | 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_id` string, 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_id` string, uuid: Id of the opportunity product relation type. - `oppty_type_id` string, uuid: Id of the opportunity type. - `product_type_id` string, uuid: Id of the product type whose form this translation applies to. Set only when label_type is FormField or FormDescription. - `project_type_id` string, uuid: Id of the project type whose form this translation applies to. Set only when label_type is FormField or FormDescription. - `pt_br` string: Translated text in Brazilian Portuguese. - `task_type_id` string, uuid: Id of the task type whose form this translation applies to. Set only when label_type is FormField or FormDescription. - `is_published` boolean: True when the translation is published; false while it exists only as an unpublished draft. - `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). - `404`: No such record or entity (code 143 ERROR_NO_ENTITY, or 2006 ERROR_UNKNOWN_TYPE). - `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)