Translations.create - PipelinerCRM

Creates new Translation

Request

Query Params

validation-level

integer <int32>

optional

Specify validation level of Translation on create. 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.

Body Params application / json

account_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

appointment_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

contact_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

data_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

de_de

string

optional

Multi-line text input field.

Example:

string

en_us

string

optional

Multi-line text input field.

Example:

string

es_es

string

optional

Multi-line text input field.

Example:

string

field_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

form_type

enum<integer>

optional

Integer enum value: 0 - Edit, 1 - Lost

Allowed values:

Example:

label_type

enum<integer>

required

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

Allowed values:

0123

Example:

lead_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

oppty_product_relation_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

oppty_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

product_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

project_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

pt_br

string

optional

Multi-line text input field.

Example:

string

task_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

Example

{
    "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",
    "form_type": 0,
    "label_type": 0,
    "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
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

Creation confirmation. Returns created Translation

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (Translation)

optional

is_delete_protected

boolean

read-onlyrequired

Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.

Example:

false

has_draft

boolean

required

Set to True if draft for entity exists and can be published

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

account_type

string <uri>

optional

Relation to AccountType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AccountType' object for properties.

appointment_type

string <uri>

optional

Relation to AppointmentType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AppointmentType' object for properties.

contact_type

string <uri>

optional

Relation to ContactType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactType' object for properties.

data

string <uri>

optional

Relation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties.

field

string <uri>

optional

Relation to Field. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Field' object for properties.

lead_type

string <uri>

optional

Relation to LeadType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadType' object for properties.

oppty_product_relation_type

string <uri>

optional

Relation to OpptyProductRelationType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyProductRelationType' object for properties.

oppty_type

string <uri>

optional

Relation to OpportunityType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpportunityType' object for properties.

product_type

string <uri>

optional

Relation to ProductType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProductType' object for properties.

project_type

string <uri>

optional

Relation to ProjectType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProjectType' object for properties.

task_type

string <uri>

optional

Relation to TaskType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TaskType' object for properties.

account_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

appointment_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

contact_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

data_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

de_de

string

optional

Multi-line text input field.

Example:

string

en_us

string

optional

Multi-line text input field.

Example:

string

es_es

string

optional

Multi-line text input field.

Example:

string

field_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

form_type

enum<integer>

optional

Integer enum value: 0 - Edit, 1 - Lost

Allowed values:

Example:

label_type

enum<integer>

required

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

Allowed values:

0123

Example:

lead_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

oppty_product_relation_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

oppty_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

product_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

project_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

pt_br

string

optional

Multi-line text input field.

Example:

string

task_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

is_published

boolean

read-onlyoptional

Example:

false

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

Example

{
    "success": true,
    "data": {
        "is_delete_protected": false,
        "has_draft": false,
        "id": "01234567-abcd-dcba-ffff-000000000000",
        "is_deleted": false,
        "modified": "2019-01-01T00:00:00",
        "created": "2019-01-01T00:00:00",
        "account_type": "http://example.com",
        "appointment_type": "http://example.com",
        "contact_type": "http://example.com",
        "data": "http://example.com",
        "field": "http://example.com",
        "lead_type": "http://example.com",
        "oppty_product_relation_type": "http://example.com",
        "oppty_type": "http://example.com",
        "product_type": "http://example.com",
        "project_type": "http://example.com",
        "task_type": "http://example.com",
        "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",
        "form_type": 0,
        "label_type": 0,
        "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",
        "is_published": false,
        "revision": 1
    }
}

🔴500Server Error