curl --request POST \
--url https://api.messaging.phonovation.com/people/2/customAttributes \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Contract Expiry Date",
"dataType": "DATE"
}
'{
"createdAt": "2019-02-25T12:46:06",
"modifiedAt": "2019-02-25T12:46:06",
"name": "Contract Expiry Date",
"dataType": "DATE"
}Create a custom attribute
Create a new custom attribute by using this method.
Required scope: Enable one of: people:manage.
curl --request POST \
--url https://api.messaging.phonovation.com/people/2/customAttributes \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Contract Expiry Date",
"dataType": "DATE"
}
'{
"createdAt": "2019-02-25T12:46:06",
"modifiedAt": "2019-02-25T12:46:06",
"name": "Contract Expiry Date",
"dataType": "DATE"
}Authorizations
This is the most secure authorization type and the one with the most flexibility.
API keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can be revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases. Finally, the loss of an API key is easily manageable.
You can manage your API keys from GUI, or programmatically with dedicated API.
API key Authorization header example:
Authorization: App 003026bbc133714df1834b8638bb496e-8f4b3d9a-e931-478d-a994-28a725159ab9
Body
Custom attribute type.
STRING, DECIMAL, INTEGER, BOOLEAN, DATE, DATE_TIME, LIST_OF_OBJECTS Custom attribute name, 256 characters max. Invalid characters: {}[].
Object schema for LIST_OF_OBJECTS type. Defines the shape of the list items.
Show child attributes
Show child attributes
Response
successful response
Date and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss.
Custom attribute type.
STRING, DECIMAL, INTEGER, BOOLEAN, DATE, DATE_TIME, LIST_OF_OBJECTS Date and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss.
Custom attribute name, 256 characters max. Invalid characters: {}[].
Object schema for LIST_OF_OBJECTS type. Defines the shape of the list items.
Show child attributes
Show child attributes