Phones.create - PipelinerCRM

Creates new Phone

Request

Query Params

validation-level

integer <int32>

optional

Specify validation level of Phone 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

error_code

integer <int32>

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

name

string

required

Name of the entity and its default text representation.

Example:

string

owner_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

phone_number

string

optional

Phone number.

Example:

string

twilio_caller_sid

string

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

type

enum<integer>

required

Integer enum value: 1 - Calling, 2 - CallingSmsUnassigned, 3 - CallingSmsPersonal, 4 - CallingSmsCompany, 5 - WhatsAppPersonal, 6 - WhatsAppCompany

Allowed values:

123456

Example:

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

enabled

boolean

required

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

false

Example

{
    "error_code": 1,
    "name": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "phone_number": "string",
    "twilio_caller_sid": "string",
    "type": 1,
    "revision": 1,
    "enabled": false
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

Creation confirmation. Returns created Phone

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (Phone)

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

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

owner

string <uri>

optional

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

error_code

integer <int32>

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

name

string

required

Name of the entity and its default text representation.

Example:

string

owner_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

phone_number

string

optional

Phone number.

Example:

string

twilio_caller_sid

string

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

type

enum<integer>

required

Integer enum value: 1 - Calling, 2 - CallingSmsUnassigned, 3 - CallingSmsPersonal, 4 - CallingSmsCompany, 5 - WhatsAppPersonal, 6 - WhatsAppCompany

Allowed values:

123456

Example:

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

message_forwarding_email

string

optional

Example:

string

call_forwarding_phone

string

optional

Example:

string

enabled

boolean

required

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

false

Example

{
    "success": true,
    "data": {
        "is_delete_protected": false,
        "id": "01234567-abcd-dcba-ffff-000000000000",
        "is_deleted": false,
        "modified": "2019-01-01T00:00:00",
        "created": "2019-01-01T00:00:00",
        "owner": "http://example.com",
        "error_code": 1,
        "name": "string",
        "owner_id": "01234567-abcd-dcba-ffff-000000000000",
        "phone_number": "string",
        "twilio_caller_sid": "string",
        "type": 1,
        "revision": 1,
        "message_forwarding_email": "string",
        "call_forwarding_phone": "string",
        "enabled": false
    }
}

🔴500Server Error