Custom Fields
get
List all current custom fields in the system.
Authorizations
Responses
200
Success
application/json
Responseall of[]
403
Access denied.
application/json
500
A generic exception has occurred.
application/json
get
GET /api/admin/custom_fields HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*
[
{
"id": 1,
"name": "text",
"short_name": "text",
"auto_assign": "text"
}
]
post
Create a new custom field.
Authorizations
Body
all ofOptional
Responses
200
Success
application/json
Responseall of
403
Access denied.
application/json
500
A generic exception has occurred.
application/json
post
POST /api/admin/custom_fields HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 63
{
"id": 1,
"name": "text",
"short_name": "text",
"auto_assign": "text"
}
{
"id": 1,
"name": "text",
"short_name": "text",
"auto_assign": "text"
}
get
Retrieve details for a single custom field.
Authorizations
Path parameters
idinteger · int64Required
ID
Responses
200
Success
application/json
Responseall of
403
Access denied.
application/json
404
Record not found.
application/json
500
A generic exception has occurred.
application/json
get
GET /api/admin/custom_field/{id} HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*
{
"id": 1,
"name": "text",
"short_name": "text",
"auto_assign": "text"
}
put
Update details of a single custom field.
Authorizations
Path parameters
idinteger · int64Required
ID
Body
all ofOptional
Responses
200
Success
application/json
403
Access denied.
application/json
404
Record not found.
application/json
500
A generic exception has occurred.
application/json
put
PUT /api/admin/custom_field/{id} HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 63
{
"id": 1,
"name": "text",
"short_name": "text",
"auto_assign": "text"
}
{
"success": true,
"message": "Changes saved successfully.",
"formatted_message": "<b>Changes saved successfully.</b>"
}
delete
Delete a single custom field.
Authorizations
Path parameters
idinteger · int64Required
ID
Responses
200
Success
application/json
403
Access denied.
application/json
404
Record not found.
application/json
500
A generic exception has occurred.
application/json
delete
DELETE /api/admin/custom_field/{id} HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*
{
"success": true,
"message": "Changes saved successfully.",
"formatted_message": "<b>Changes saved successfully.</b>"
}
Last updated