{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/customdatafields/","auth":"required","examples":{"codes":[]},"method":"post","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"name\": \"externalURL\",\n    \"id\": 34,\n    \"type\": \"TEXT\"\n}","name":""},{"status":400,"language":"text","code":"Orbirental API - Bad request.","name":""},{"status":409,"language":"text","code":"Orbirental API - Property not found."}]},"settings":"","params":[{"name":"agencyUid","type":"string","default":"","desc":"The unique ID of the agency","required":true,"in":"body","ref":"","_id":"56e75cbb5669091700c5b2b2"},{"name":"name","type":"string","default":"","desc":"Name of the custom data field","required":true,"in":"body","ref":"","_id":"5de7cafb95ab6b0051f94ec4"},{"name":"type","type":"string","default":"TEXT","desc":"Type of the custom data field (can be TEXT / LONG_TEXT)","required":false,"in":"body","ref":"","_id":"5de7cafb95ab6b0051f94ec3"}]},"next":{"description":"","pages":[]},"title":"/customdatafields/","type":"endpoint","slug":"customdatafields","excerpt":"Retrieve the custom data fields associated to the agency","body":"","updates":[],"order":13,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5de85dbbb0b885003ddf339e","project":"56e3719a591f620e00bf5095","version":{"version":"1.5","version_clean":"1.5.0","codename":"Domain","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5de85dbbb0b885003ddf3334","56e7b24ad365390e007baeab","5de85dbbb0b885003ddf3335","5de85dbbb0b885003ddf3336","5de85dbbb0b885003ddf3337","5de85dbbb0b885003ddf3338"],"_id":"5de85dbbb0b885003ddf339f","__v":0,"project":"56e3719a591f620e00bf5095","forked_from":"56e3719a591f620e00bf5098","createdAt":"2016-03-12T01:32:10.751Z","releaseDate":"2016-03-12T01:32:10.751Z"},"category":{"sync":{"isSync":false,"url":""},"pages":["5de85dbbb0b885003ddf3339","5de85dbbb0b885003ddf333a","5de85dbbb0b885003ddf333b","5de85dbbb0b885003ddf333c","5de85dbbb0b885003ddf333d","5de85dbbb0b885003ddf333e","5de85dbbb0b885003ddf333f","5de85dbbb0b885003ddf3340","5de85dbbb0b885003ddf3341","5de85dbbb0b885003ddf3342","5de85dbbb0b885003ddf3343","56e77e22911296190096de13","5de85dbbb0b885003ddf3344","5de85dbbb0b885003ddf3345","5de85dbbb0b885003ddf3346","5de85dbbb0b885003ddf3347","5de85dbbb0b885003ddf3348","5de85dbbb0b885003ddf3349","5de85dbbb0b885003ddf334a"],"title":"Documentation","slug":"documentation","order":0,"from_sync":false,"reference":false,"_id":"5de85dbbb0b885003ddf3334","project":"56e3719a591f620e00bf5095","__v":19,"createdAt":"2016-03-12T01:32:11.359Z","version":"5de85dbbb0b885003ddf339f"},"user":"56e371538b32a10e00f79750","createdAt":"2019-12-04T15:04:27.063Z","__v":3,"parentDoc":null}

post/customdatafields/

Retrieve the custom data fields associated to the agency

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

agencyUid:
required
string
The unique ID of the agency
name:
required
string
Name of the custom data field
type:
stringTEXT
Type of the custom data field (can be TEXT / LONG_TEXT)

Result Format


User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}