{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/serviceproviders","auth":"required","params":[{"name":"agencyUid","type":"string","default":"","desc":"The unique id of the parent agency","required":true,"in":"body","ref":"","_id":"56e788a19b25270e001d1269"},{"name":"firstName","type":"string","default":"","desc":"first name of the service provider","required":true,"in":"body","ref":"","_id":"56e788a19b25270e001d1260"},{"name":"lastName","type":"string","default":"","desc":"Last name of the service provider","required":true,"in":"body","ref":"","_id":"56e788a19b25270e001d1265"},{"name":"type","type":"string","default":"","desc":"Can be CLEANER, GREETER, HANDYMAN, LANDSCAPE, CONTRACTOR, OTHER","required":true,"in":"body","ref":"","_id":"56e792971e071c22001a0488"},{"name":"companyName","type":"string","default":"","desc":"Company name of the service provider","required":false,"in":"body","ref":"","_id":"56e788a19b25270e001d125f"},{"name":"email","type":"string","default":"","desc":"Email of the service provider","required":false,"in":"body","ref":"","_id":"56e788a19b25270e001d1267"},{"name":"address","type":"string","default":"","desc":"Address of the service provider","required":false,"in":"body","ref":"","_id":"56e788a19b25270e001d1262"},{"name":"city","type":"string","default":"","desc":"City of the service provider","required":false,"in":"body","ref":"","_id":"56e788a19b25270e001d125e"},{"name":"zipCode","type":"string","default":"","desc":"Zip code of the service provider","required":false,"in":"body","ref":"","_id":"592351a888e3d00f00e60a9e"},{"name":"state","type":"string","default":"","desc":"State of the service provider","required":false,"in":"body","ref":"","_id":"592351a888e3d00f00e60a9d"},{"name":"phoneNumber","type":"string","default":"","desc":"Phone number of the service provider","required":false,"in":"body","ref":"","_id":"592351a888e3d00f00e60a9c"},{"name":"countryCode","type":"string","default":"","desc":"Use an ISO_3166-1_alpha-2 format","required":false,"in":"body","ref":"","_id":"56e788a19b25270e001d1263"},{"name":"currency","type":"string","default":"","desc":"Use an ISO 4217 format","required":false,"in":"body","ref":"","_id":"592351a888e3d00f00e60a9b"}],"results":{"codes":[{"name":"","code":"{\n  \"uid\": \"4f6a3a32-6d57-450d-8b46-44abb3b01994\",\n  \"type\": \"CLEANER\",\n  \"firstName\": \"Cedric\",\n  \"lastName\": \"Raudin\",\n  \"companyName\": \"Responseev\",\n  \"email\": \"cedric.r:::at:::gmail.com\",\n  \"address\": \"Haight Street\",\n  \"city\": \"San Francisco\",\n  \"zipCode\": \"H1B TP2\",\n  \"state\": \"CA\",\n  \"countryCode\": \"US\",\n  \"cost\": \"10\",\n  \"currency\": \"USD\",\n  \"phoneNumber\": \"+4098764587\",\n}","language":"json","status":200},{"name":"","code":"Orbirental API - Bad request.","language":"text","status":400},{"code":"Orbirental API - Agency not found.","language":"text","status":409}]},"settings":"","examples":{"codes":[]},"method":"post"},"next":{"description":"","pages":[]},"title":"/serviceproviders","type":"endpoint","slug":"serviceproviders-1","excerpt":"Create a new service provider","body":"","updates":[],"order":74,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5de85dbbb0b885003ddf3368","user":"56e371538b32a10e00f79750","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"},"parentDoc":null,"__v":2,"githubsync":"","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"},"project":"56e3719a591f620e00bf5095","createdAt":"2017-05-22T21:01:28.270Z"}

post/serviceproviders

Create a new service provider

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

agencyUid:
required
string
The unique id of the parent agency
firstName:
required
string
first name of the service provider
lastName:
required
string
Last name of the service provider
type:
required
string
Can be CLEANER, GREETER, HANDYMAN, LANDSCAPE, CONTRACTOR, OTHER
companyName:
string
Company name of the service provider
email:
string
Email of the service provider
address:
string
Address of the service provider
city:
string
City of the service provider
zipCode:
string
Zip code of the service provider
state:
string
State of the service provider
phoneNumber:
string
Phone number of the service provider
countryCode:
string
Use an ISO_3166-1_alpha-2 format
currency:
string
Use an ISO 4217 format

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 }}