Phone created

This event occurs when a new phone is created.
Generated by: Create phone
More information: Address and phone objects

Type: object
Domain: audit
Event: phone_creation
Version: 1

method required

Title: The operation HTTP method
Type: string
Example:
POST

uri required

Title: The API operation URI
Type: string
Example:
/v1/accounts/:accountId/phones

email required

Title: The operator email
Type: string
Example:
[email protected]

roles required

Title: The operator roles
Type: array
Example:

[
    "backoffice-operator",
    "crm-operator",
    "geroficios-operator",
    "inspetoria-master",
    "inspetoria-operator",
    "itibackoffice-master",
    "itibackoffice-operator",
    "itinivel1-operator",
    "treasury-operator"
]

origin required

Title: The Origin Schema
Type: string
Example:
CRM

object required

Title: The audit object message
Type: object

account_id required

Title: The Account identifier
Type: integer
Example:
32422

customer_id

Title: The Customer identifier
Type: integer or null
Example:
42422

area_code required

Title: The phone area code
Type: string
Example:
11

number required

Title: The Phone Number
Type: string
Example:
912242623

type required

Title: The Phone Type
Type: string
Example:
MOBILE

extension required

Title: The Extension type
Type: string or null
Example:
string

active required

Title: Is active or not
Type: boolean
Example:
true

country_code required

Title: The phone country code
Type: string or null
Example:
55

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "Phone created",
    "description": "This event occurs when a new phone is created. \n Generated by: <a href='https://developers.pismo.io/pismo-docs/reference/post-accounts-v1-accounts-accountid-phones' target='_blank'>Create phone</a> \n More information: <a href='https://developers.pismo.io/pismo-docs/docs/address-and-phone-objects' target='_blank'>Address and phone objects</a>",
    "required": [
        "method",
        "uri",
        "email",
        "roles",
        "origin",
        "object"
    ],
    "properties": {
        "method": {
            "type": "string",
            "title": "The operation HTTP method",
            "default": "",
            "examples": [
                "POST"
            ]
        },
        "uri": {
            "type": "string",
            "title": "The API operation URI",
            "default": "",
            "examples": [
                " /v1/accounts/:accountId/phones"
            ]
        },
        "email": {
            "type": "string",
            "title": "The operator email",
            "default": "",
            "examples": [
                "[email protected]"
            ]
        },
        "roles": {
            "type": "array",
            "title": "The operator roles",
            "items": {
                "type": "string",
                "title": "The Roles",
                "examples": [
                    "backoffice-operator",
                    "crm-operator",
                    "geroficios-operator",
                    "inspetoria-master",
                    "inspetoria-operator",
                    "itibackoffice-master",
                    "itibackoffice-operator",
                    "itinivel1-operator",
                    "treasury-operator"
                ]
            }
        },
        "origin": {
            "type": "string",
            "title": "The Origin Schema",
            "default": "",
            "examples": [
                "CRM"
            ]
        },
        "object": {
            "type": "object",
            "title": "The audit object message",
            "required": [
                "account_id",
                "area_code",
                "number",
                "type",
                "extension",
                "active",
                "country_code"
            ],
            "properties": {
                "account_id": {
                    "type": "integer",
                    "title": "The Account identifier",
                    "default": 0,
                    "examples": [
                        32422
                    ]
                },
                "customer_id": {
                    "type": [
                        "integer",
                        "null"
                    ],
                    "title": "The Customer identifier",
                    "examples": [
                        42422
                    ]
                },
                "area_code": {
                    "type": "string",
                    "title": "The phone area code",
                    "default": "",
                    "examples": [
                        "11"
                    ]
                },
                "number": {
                    "type": "string",
                    "title": "The Phone Number",
                    "default": "",
                    "examples": [
                        "912242623"
                    ]
                },
                "type": {
                    "type": "string",
                    "title": "The Phone Type",
                    "default": "",
                    "examples": [
                        "MOBILE"
                    ]
                },
                "extension": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "The Extension type",
                    "default": "",
                    "examples": [
                        "string"
                    ]
                },
                "active": {
                    "type": "boolean",
                    "title": "Is active or not",
                    "default": false,
                    "examples": [
                        true
                    ]
                },
                "country_code": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "The phone country code",
                    "examples": [
                        "55"
                    ]
                }
            }
        }
    }
}

{
    "method": "POST",
    "uri": " /v1/accounts/:accountId/phones",
    "email": "[email protected]",
    "roles": [
        "backoffice-operator",
        "crm-operator",
        "geroficios-operator",
        "inspetoria-master",
        "inspetoria-operator",
        "itibackoffice-master",
        "itibackoffice-operator",
        "itinivel1-operator",
        "treasury-operator"
    ],
    "origin": "CRM",
    "object": {
        "account_id": 32422,
        "customer_id": 42422,
        "area_code": "11",
        "number": "912242623",
        "type": "MOBILE",
        "extension": "string",
        "active": true,
        "country_code": "55"
    }
}

Updated 21 days ago