{"_id":"5797d3e4e8e2090e003b848b","parentDoc":null,"user":"571fcfeea0acd42000af95be","version":{"_id":"57624356653c2d2200fec79c","__v":20,"project":"55c8cff571d7580d0063a5e5","createdAt":"2016-06-16T06:12:38.244Z","releaseDate":"2016-06-16T06:12:38.244Z","categories":["57624356653c2d2200fec79d","57624356653c2d2200fec79e","57624356653c2d2200fec79f","57624356653c2d2200fec7a0","57624356653c2d2200fec7a1","57624356653c2d2200fec7a2","57624356653c2d2200fec7a3","57624356653c2d2200fec7a4","57624356653c2d2200fec7a5","57624356653c2d2200fec7a6","57624356653c2d2200fec7a7","57624356653c2d2200fec7a8","57624356653c2d2200fec7a9","57624356653c2d2200fec7aa","5779ca1b99b40b0e005abb3a","5779d198aea88b0e00f63277","5797d3ab17ced017003c4be4","57ac170ef1cdae0e0053cdfc","57dbfc723ed3450e00dc9e6d","5804d12d16161c0f0077df9b","5841064b652e5b0f0015a7c8","588b5e5f2966b2230009cbf9","58a68ebf3239fa0f00857619","58c23c8b4922930f0050ac91","58fd1460809fc30f00f2ee07","5934eaf5328680002d77de6a","594bf91601cfe6000f40f4c5","595c4ed696b447001ba0cf6d","596524495cee50001575f5be","5970d4f1313162004dd303b5","59780fac24dbd1001a1fa057","59a8cfd3ead78a002d63cafe","59e0323d93da1f001c9ec170"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"4.0.0","version":"4"},"category":{"_id":"5797d3ab17ced017003c4be4","project":"55c8cff571d7580d0063a5e5","version":"57624356653c2d2200fec79c","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-07-26T21:18:35.003Z","from_sync":false,"order":26,"slug":"account-subaccounts","title":"Account Subaccounts"},"project":"55c8cff571d7580d0063a5e5","__v":32,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-07-26T21:19:32.202Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"name":"","code":"{\n    \"id\": 883,\n    \"name\": \"Teddy\",\n    \"master_account\": {\n        \"id\": 133532,\n        \"name\": \"Bobby Smith\",\n    },\n    \"contact\": {\n        \"name\": \"Teddy\",\n        \"company\": \"Acme, Inc.\",\n        \"address\": {\n            \"line_1\": \"14282 Danielson Street\",\n            \"line_2\": \"box 2\",\n            \"city\": \"Poway\",\n            \"province\": \"CA\",\n            \"postal_code\": \"92064\",\n            \"country\": \"US\"\n        },\n        \"phone\": \"+18585551111\",\n        \"fax\": \"+18585552222\",\n        \"email_1\": \"test:::at:::phone.com\",\n        \"email_2\": \"test@gmail.com\"\n    },\n    \"billing_contact\": {\n        \"name\": \"Bobby\",\n        \"company\": \"xyz co\",\n        \"address\": {\n            \"line_1\": \"100 Main St\",\n            \"line_2\": \"#4\",\n            \"city\": \"San Diego\",\n            \"province\": \"CA\",\n            \"postal_code\": \"92129\",\n            \"country\": \"US\"\n        },\n        \"phone\": \"+18585553333\",\n        \"fax\": \"+18585554444\",\n        \"email_1\": \"sample@phone.com\",\n        \"email_2\": \"sample@gmail.com\"\n    }\n}","language":"json"}]},"settings":"","examples":{"codes":[{"language":"php","code":"<?php\n$client = new \\GuzzleHttp\\Client([\n    'base_uri' => 'https://api.phone.com/v4/',\n    'headers' => ['Authorization' => \"Bearer $token\"]\n]);\n$response = $client->post('accounts/1/subaccounts', ['json' => [\n    \"contact\" : [\n        \"name\": \"Teddy\",\n        \"company\": \"Acme, Inc.\",\n        \"address\": {\n            \"line_1\": \"14282 Danielson Street\",\n            \"line_2\": \"box 2\",\n            \"city\": \"Poway\",\n            \"province\": \"CA\",\n            \"postal_code\": \"92064\",\n            \"country\": \"US\"\n        ],\n        \"phone\": \"+18585551111\",\n        \"fax\": \"+18585552222\",\n        \"email_1\": \"test@phone.com\",\n        \"email_2\": \"test@gmail.com\"\n    ],\n    \"billing_contact\" : [\n        \"name\": \"Bobby\",\n        \"company\": \"xyz co\",\n        \"address\": [\n            \"line_1\": \"100 Main St\",\n            \"line_2\": \"#4\",\n            \"city\": \"San Diego\",\n            \"province\": \"CA\",\n            \"postal_code\": \"92129\",\n            \"country\": \"US\"\n        ],\n        \"phone\": \"+18585553333\",\n        \"fax\": \"+18585554444\",\n        \"email_1\": \"sample@phone.com\",\n        \"email_2\": \"sample@gmail.com\"\n    ]\n]]);"}]},"method":"post","auth":"required","params":[{"_id":"56f9bd91303b34320094b8f6","ref":"","in":"path","required":true,"desc":"Account ID","default":"","type":"int","name":"account_id"},{"_id":"57d9ac553916800e003ddf3c","ref":"","in":"body","required":true,"desc":"Sub account user name","default":"","type":"string","name":"username"},{"_id":"57d9ac553916800e003ddf3b","ref":"","in":"body","required":true,"desc":"Sub account password","default":"","type":"string","name":"password"},{"_id":"57913f2514b5b32b00b79e15","ref":"","in":"body","required":true,"desc":"Contact name","default":"","type":"string","name":"contact.name"},{"_id":"57913f2514b5b32b00b79e13","ref":"","in":"body","required":true,"desc":"Contact street address","default":"","type":"string","name":"contact.address.line_1"},{"_id":"57913f2514b5b32b00b79e12","ref":"","in":"body","required":false,"desc":"Contact street address 2","default":"","type":"string","name":"contact.address.line_2"},{"_id":"57913f2514b5b32b00b79e18","ref":"","in":"body","required":true,"desc":"Contact city","default":"","type":"string","name":"contact.address.city"},{"_id":"57913f2514b5b32b00b79e10","ref":"","in":"body","required":false,"desc":"Contact province","default":"","type":"string","name":"contact.address.province"},{"_id":"57913f2514b5b32b00b79e0f","ref":"","in":"body","required":true,"desc":"Contact postal code","default":"","type":"string","name":"contact.address.postal_code"},{"_id":"57913f2514b5b32b00b79e0e","ref":"","in":"body","required":true,"desc":"Contact country","default":"","type":"string","name":"contact.address.country"},{"_id":"57913f2514b5b32b00b79e0a","ref":"","in":"body","required":true,"desc":"Contact email","default":"","type":"string","name":"contact.primary_email"},{"_id":"57913f2514b5b32b00b79e09","ref":"","in":"body","required":false,"desc":"Contact alternate email","default":"","type":"string","name":"contact.alternate_email"},{"_id":"57913f2514b5b32b00b79e14","ref":"","in":"body","required":false,"desc":"Company","default":"","type":"string","name":"contact.company"},{"_id":"57913f2514b5b32b00b79e0c","ref":"","in":"body","required":true,"desc":"Contact phone","default":"","type":"string","name":"contact.phone"},{"_id":"57913f2514b5b32b00b79e0b","ref":"","in":"body","required":false,"desc":"Contact fax","default":"","type":"string","name":"contact.fax"},{"_id":"5791402f180e233400f70ee9","ref":"","in":"body","required":true,"desc":"Billing contact name","default":"","type":"string","name":"billing_contact.name"},{"_id":"57913f2514b5b32b00b79e0d","ref":"","in":"body","required":true,"desc":"Billing contact street address","default":"","type":"string","name":"billing_contact.address.line_1"},{"_id":"57913f56f0c7242b005a7049","ref":"","in":"body","required":false,"desc":"Billing contact street address 2","default":"","type":"string","name":"billing_contact.address.line_2"},{"_id":"5791402f180e233400f70eec","ref":"","in":"body","required":true,"desc":"Billing contact city","default":"","type":"string","name":"billing_contact.address.city"},{"_id":"5791402f180e233400f70eea","ref":"","in":"body","required":false,"desc":"Billing contact province","default":"","type":"string","name":"billing_contact.address.province"},{"_id":"5791402f180e233400f70ee3","ref":"","in":"body","required":false,"desc":"Billing contact company","default":"","type":"string","name":"billing_contact.company"},{"_id":"5791402f180e233400f70eeb","ref":"","in":"body","required":true,"desc":"Billing contact postal code","default":"","type":"string","name":"billing_contact.address.postal_code"},{"_id":"5791402f180e233400f70ee8","ref":"","in":"body","required":true,"desc":"Billing contact country","default":"","type":"string","name":"billing_contact.address.country"},{"_id":"5791402f180e233400f70ee7","ref":"","in":"body","required":true,"desc":"Billing contact phone","default":"","type":"string","name":"billing_contact.phone"},{"_id":"5791402f180e233400f70ee6","ref":"","in":"body","required":false,"desc":"Billing contact fax","default":"","type":"string","name":"billing_contact.fax"},{"_id":"5791402f180e233400f70ee5","ref":"","in":"body","required":true,"desc":"Billing contact email","default":"","type":"string","name":"billing_contact.primary_email"},{"_id":"5791402f180e233400f70ee4","ref":"","in":"body","required":false,"desc":"Billing contact alternate email","default":"","type":"string","name":"billing_contact.alternate_email"}],"url":"/accounts/:account_id/subaccounts"},"isReference":true,"order":2,"body":"This service shows the details of an individual [Subaccount](doc:subaccounts).","excerpt":"Add a subaccount for the authenticated user or client","slug":"create-account-subaccount","type":"endpoint","title":"Create Subaccount"}

postCreate Subaccount

Add a subaccount for the authenticated user or client

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

account_id:
required
integer
Account ID

Body Params

username:
required
string
Sub account user name
password:
required
string
Sub account password
contact.name:
required
string
Contact name
contact.address.line_1:
required
string
Contact street address
contact.address.line_2:
string
Contact street address 2
contact.address.city:
required
string
Contact city
contact.address.province:
string
Contact province
contact.address.postal_code:
required
string
Contact postal code
contact.address.country:
required
string
Contact country
contact.primary_email:
required
string
Contact email
contact.alternate_email:
string
Contact alternate email
contact.company:
string
Company
contact.phone:
required
string
Contact phone
contact.fax:
string
Contact fax
billing_contact.name:
required
string
Billing contact name
billing_contact.address.line_1:
required
string
Billing contact street address
billing_contact.address.line_2:
string
Billing contact street address 2
billing_contact.address.city:
required
string
Billing contact city
billing_contact.address.province:
string
Billing contact province
billing_contact.company:
string
Billing contact company
billing_contact.address.postal_code:
required
string
Billing contact postal code
billing_contact.address.country:
required
string
Billing contact country
billing_contact.phone:
required
string
Billing contact phone
billing_contact.fax:
string
Billing contact fax
billing_contact.primary_email:
required
string
Billing contact email
billing_contact.alternate_email:
string
Billing contact alternate email

Examples


Result Format


Documentation

This service shows the details of an individual [Subaccount](doc:subaccounts).

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