{"items":[{"type":"link","label":"Subprojects API","link":"/docs/subprojects/api-reference/subprojects","routeSlug":"/docs/subprojects/api-reference/subprojects","content":{"contentType":"overview","meta":{"name":"Subprojects API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"subprojects.json","url":"/_bundle/docs/subprojects/api-reference/subprojects.json?download"},{"kind":"download","label":"subprojects.yaml","url":"/_bundle/docs/subprojects/api-reference/subprojects.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"email","title":"Support at Sinch","email":"support@sinch.com","label":"support@sinch.com","withCopyButton":true,"copyContent":"support@sinch.com"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"MIT","url":"https://www.sinch.com/toc"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://subproject.api.sinch.com","description":"Placeholder Server"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Subprojects API (v1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API to create, find, modify or delete subprojects of Sinch projects (parent projects). Using subprojects you can better organize your organization's projects by customer, department, product, marketing campaign, etc."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you would like help using the Subprojects API, review our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/subprojects/getting-started"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting Started guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Subprojects API is in closed beta."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited availability:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" this API is available to selected customers only. Contact your Account Manager to discuss access."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the current version. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v1alpha1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deprecated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in favour of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; existing clients should migrate to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The two versions are functionally identical - only the path prefix differs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v1alpha1/..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" => "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v1/..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"sectionId":"/docs/subprojects/api-reference/subprojects"}],"sectionId":"/docs/subprojects/api-reference/subprojects"}]}]}},{"type":"group","label":"Subprojects Service","link":"/docs/subprojects/api-reference/subprojects/subprojects-service","routeSlug":"/docs/subprojects/api-reference/subprojects/subprojects-service","items":[{"label":"Create a new subproject","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/subprojects/api-reference/subprojects/subprojects-service/subprojectservice_createsubproject","routeSlug":"/docs/subprojects/api-reference/subprojects/subprojects-service/subprojectservice_createsubproject","metadata":{"seo":{"title":"Create a new subproject","description":"Use this method to create a new subproject off of a parent project. A subproject is a great way to group resources together."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SubprojectService_CreateSubproject","name":"Create a new subproject","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{parentProjectId}~1subprojects/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new subproject","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this method to create a new subproject off of a parent project. A subproject is a great way to group resources together."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"subprojects-service/subprojectservice_createsubproject/request/limitations","deepLinkHash":"/subprojects-service/subprojectservice_createsubproject#subprojects-service/subprojectservice_createsubproject/request/limitations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limitations"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subprojects cannot have their own billing account. The billing account is handled by the parent project."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You cannot have a subproject created off of a subproject."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The username and password are your Key ID and Key Secret from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access keys section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Sinch Customer Dashboard. Exchange these for a bearer token (access token)."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}]},{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about basic authentication, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/subprojects/api-reference/index.md#authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"parentProjectId","in":"path","schemaId":"schema_1024","description":"the parent project ID the subproject belongs to.","required":true,"example":"dxxxxxba48b144xxxxx184b81e4xxxxx"}],"pointer":"/paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1025","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/requestBody/content/application~1json/examples/createFillIn","paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/requestBody/content/application~1json/examples/createDisplayAndLabels"]}},"schemaId":"schema_1025","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/requestBody/content/application~1json/examples/createFillIn","paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/requestBody/content/application~1json/examples/createDisplayAndLabels"],"pointer":"/paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{parentProjectId}/subprojects","servers":[{"url":"https://subproject.api.sinch.com","description":"Placeholder Server"}],"parameters":{"path":[{"name":"parentProjectId","in":"path","required":true,"example":"dxxxxxba48b144xxxxx184b81e4xxxxx","schemaId":"schema_1024"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}],"scopes":[]},{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1025","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/requestBody/content/application~1json/examples/createFillIn","paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/requestBody/content/application~1json/examples/createDisplayAndLabels"]}},"responseCodes":["200","400","401","403","404"],"pointer":"/v1/projects/{parentProjectId}/subprojects","href":"subprojects-service/subprojectservice_createsubproject","openApiOperationId":"SubprojectService_CreateSubproject","summary":"Create a new subproject","securityGroups":[{"OAuth2.0":[]},{"Basic":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://subproject.api.sinch.com","description":"Placeholder Server"}],"schemaId":"schema_1025","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/requestBody/content/application~1json/examples/createFillIn","paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/requestBody/content/application~1json/examples/createDisplayAndLabels"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1025","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/requestBody/content/application~1json/examples/createFillIn","paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/requestBody/content/application~1json/examples/createDisplayAndLabels"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A successful response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subproject"}},"schemaId":"components/schemas/Subproject"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request can't be completed. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the body distinguishes the cause:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ARGUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the request doesn't conform to the API (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"displayName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is missing, empty, or longer than 255 characters)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the parent project is invalid or does not exist."},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/responses/400/content/application~1json/examples/invalidArgument","paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/responses/400/content/application~1json/examples/failedPrecondition"]}},"schemaId":"schema_1026","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/responses/400/content/application~1json/examples/invalidArgument","paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/responses/400/content/application~1json/examples/failedPrecondition"]},{"code":"401","description":"UNAUTHENTICATED: The authentication token is invalid. ","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/responses/401/content/application~1json/example"]}},"schemaId":"schema_1026","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/responses/401/content/application~1json/example"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERMISSION_DENIED: The request syntax is valid but can't be performed."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/responses/403/content/application~1json/example"]}},"schemaId":"schema_1026","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/responses/403/content/application~1json/example"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT_FOUND: The path is invalid or no resource exists with the given ID."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/responses/404/content/application~1json/example"]}},"schemaId":"schema_1026","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Subproject","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subproject"}}},{"code":"400","schemaId":"schema_1026","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/responses/400/content/application~1json/examples/invalidArgument","paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/responses/400/content/application~1json/examples/failedPrecondition"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/responses/400/content/application~1json/examples/invalidArgument","paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/responses/400/content/application~1json/examples/failedPrecondition"]}}},{"code":"401","schemaId":"schema_1026","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"schema_1026","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_1026","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subprojects-service/subprojectservice_createsubproject"}],"panels":[]}]},"httpPath":"/v1/projects/{parentProjectId}/subprojects"},{"label":"List all subprojects","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/subprojects/api-reference/subprojects/subprojects-service/subprojectservice_listsubprojects","routeSlug":"/docs/subprojects/api-reference/subprojects/subprojects-service/subprojectservice_listsubprojects","metadata":{"seo":{"title":"List all subprojects","description":"A list of all subprojects under a projectId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SubprojectService_ListSubprojects","name":"List all subprojects","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{parentProjectId}~1subprojects/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all subprojects","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of all subprojects under a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The username and password are your Key ID and Key Secret from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access keys section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Sinch Customer Dashboard. Exchange these for a bearer token (access token)."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}]},{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about basic authentication, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/subprojects/api-reference/index.md#authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"parentProjectId","in":"path","schemaId":"schema_1024","description":"the parent project ID the subproject belongs to.","required":true,"example":"dxxxxxba48b144xxxxx184b81e4xxxxx"}],"pointer":"/paths/~1v1~1projects~1{parentProjectId}~1subprojects/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_1027","description":"Optional. The maximum number of results to return in a single response.","example":100},{"name":"pageToken","in":"query","schemaId":"schema_1028","description":"Optional. The pagination token returned in an earlier response."},{"name":"showDeleted","in":"query","schemaId":"schema_1029","description":"Optional. A flag specifying whether to return subprojects that have been deleted.","example":false}],"pointer":"/paths/~1v1~1projects~1{parentProjectId}~1subprojects/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{parentProjectId}/subprojects","servers":[{"url":"https://subproject.api.sinch.com","description":"Placeholder Server"}],"parameters":{"path":[{"name":"parentProjectId","in":"path","required":true,"example":"dxxxxxba48b144xxxxx184b81e4xxxxx","schemaId":"schema_1024"}],"query":[{"name":"pageSize","in":"query","required":false,"example":100,"schemaId":"schema_1027"},{"name":"pageToken","in":"query","required":false,"schemaId":"schema_1028"},{"name":"showDeleted","in":"query","required":false,"example":false,"schemaId":"schema_1029"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}],"scopes":[]},{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/v1/projects/{parentProjectId}/subprojects","href":"subprojects-service/subprojectservice_listsubprojects","openApiOperationId":"SubprojectService_ListSubprojects","summary":"List all subprojects","securityGroups":[{"OAuth2.0":[]},{"Basic":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://subproject.api.sinch.com","description":"Placeholder Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A successful response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListSubprojectsResponse"}},"schemaId":"components/schemas/ListSubprojectsResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INVALID_ARGUMENT: The request doesn't conform to the API."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/get/responses/400/content/application~1json/example"]}},"schemaId":"schema_1026","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/get/responses/400/content/application~1json/example"]},{"code":"401","description":"UNAUTHENTICATED: The authentication token is invalid. ","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/get/responses/401/content/application~1json/example"]}},"schemaId":"schema_1026","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/get/responses/401/content/application~1json/example"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERMISSION_DENIED: The request syntax is valid but can't be performed."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_1026","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/get/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1v1~1projects~1{parentProjectId}~1subprojects/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListSubprojectsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListSubprojectsResponse"}}},{"code":"400","schemaId":"schema_1026","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_1026","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"schema_1026","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1projects~1{parentProjectId}~1subprojects/get/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subprojects-service/subprojectservice_listsubprojects"}],"panels":[]}]},"httpPath":"/v1/projects/{parentProjectId}/subprojects"},{"label":"Get a single subproject by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/subprojects/api-reference/subprojects/subprojects-service/subprojectservice_getsubproject","routeSlug":"/docs/subprojects/api-reference/subprojects/subprojects-service/subprojectservice_getsubproject","metadata":{"seo":{"title":"Get a single subproject by ID","description":"Using the subprojectId, get the details of one subproject."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SubprojectService_GetSubproject","name":"Get a single subproject by ID","isWebhook":false,"pointer":"/paths/~1v1~1subprojects~1{subprojectId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a single subproject by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subprojectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", get the details of one subproject."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The username and password are your Key ID and Key Secret from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access keys section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Sinch Customer Dashboard. Exchange these for a bearer token (access token)."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}]},{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about basic authentication, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/subprojects/api-reference/index.md#authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subprojectId","in":"path","schemaId":"schema_1028","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique subproject identifier. Not to be confused with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parentProjectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subprojectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a new ID related to your parent project."},"children":[]}]}]}],"required":true,"example":"01FC66621VHDBN119Z8PMXXXXX"}],"pointer":"/paths/~1v1~1subprojects~1{subprojectId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/subprojects/{subprojectId}","servers":[{"url":"https://subproject.api.sinch.com","description":"Placeholder Server"}],"parameters":{"path":[{"name":"subprojectId","in":"path","required":true,"example":"01FC66621VHDBN119Z8PMXXXXX","schemaId":"schema_1028"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}],"scopes":[]},{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/v1/subprojects/{subprojectId}","href":"subprojects-service/subprojectservice_getsubproject","openApiOperationId":"SubprojectService_GetSubproject","summary":"Get a single subproject by ID","securityGroups":[{"OAuth2.0":[]},{"Basic":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://subproject.api.sinch.com","description":"Placeholder Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A successful response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subproject"}},"schemaId":"components/schemas/Subproject"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INVALID_ARGUMENT: The request doesn't conform to the API."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/get/responses/400/content/application~1json/example"]}},"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/get/responses/400/content/application~1json/example"]},{"code":"401","description":"UNAUTHENTICATED: The authentication token is invalid. ","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/get/responses/401/content/application~1json/example"]}},"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/get/responses/401/content/application~1json/example"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERMISSION_DENIED: The request syntax is valid but can't be performed."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/get/responses/403/content/application~1json/example"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT_FOUND: The path is invalid or no resource exists with the given ID."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1v1~1subprojects~1{subprojectId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Subproject","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subproject"}}},{"code":"400","schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subprojects-service/subprojectservice_getsubproject"}],"panels":[]}]},"httpPath":"/v1/subprojects/{subprojectId}"},{"label":"Update an existing subproject","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/subprojects/api-reference/subprojects/subprojects-service/subprojectservice_updatesubproject","routeSlug":"/docs/subprojects/api-reference/subprojects/subprojects-service/subprojectservice_updatesubproject","metadata":{"seo":{"title":"Update an existing subproject","description":"Update the displayName or label information on an existing subproject."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SubprojectService_UpdateSubproject","name":"Update an existing subproject","isWebhook":false,"pointer":"/paths/~1v1~1subprojects~1{subprojectId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an existing subproject","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"displayName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or label information on an existing subproject."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The username and password are your Key ID and Key Secret from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access keys section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Sinch Customer Dashboard. Exchange these for a bearer token (access token)."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}]},{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about basic authentication, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/subprojects/api-reference/index.md#authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subprojectId","in":"path","schemaId":"schema_1028","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique subproject identifier. Not to be confused with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parentProjectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subprojectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a new ID related to your parent project."},"children":[]}]}]}],"required":true,"example":"01FC66621VHDBN119Z8PMXXXXX"}],"pointer":"/paths/~1v1~1subprojects~1{subprojectId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1030","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/patch/requestBody/content/application~1json/examples/updateFillIn","paths/~1v1~1subprojects~1{subprojectId}/patch/requestBody/content/application~1json/examples/updateDisplayName","paths/~1v1~1subprojects~1{subprojectId}/patch/requestBody/content/application~1json/examples/updateLabels"]}},"schemaId":"schema_1030","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/patch/requestBody/content/application~1json/examples/updateFillIn","paths/~1v1~1subprojects~1{subprojectId}/patch/requestBody/content/application~1json/examples/updateDisplayName","paths/~1v1~1subprojects~1{subprojectId}/patch/requestBody/content/application~1json/examples/updateLabels"],"pointer":"/paths/~1v1~1subprojects~1{subprojectId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/subprojects/{subprojectId}","servers":[{"url":"https://subproject.api.sinch.com","description":"Placeholder Server"}],"parameters":{"path":[{"name":"subprojectId","in":"path","required":true,"example":"01FC66621VHDBN119Z8PMXXXXX","schemaId":"schema_1028"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}],"scopes":[]},{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1030","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/patch/requestBody/content/application~1json/examples/updateFillIn","paths/~1v1~1subprojects~1{subprojectId}/patch/requestBody/content/application~1json/examples/updateDisplayName","paths/~1v1~1subprojects~1{subprojectId}/patch/requestBody/content/application~1json/examples/updateLabels"]}},"responseCodes":["200","400","401","403","404"],"pointer":"/v1/subprojects/{subprojectId}","href":"subprojects-service/subprojectservice_updatesubproject","openApiOperationId":"SubprojectService_UpdateSubproject","summary":"Update an existing subproject","securityGroups":[{"OAuth2.0":[]},{"Basic":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://subproject.api.sinch.com","description":"Placeholder Server"}],"schemaId":"schema_1030","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/patch/requestBody/content/application~1json/examples/updateFillIn","paths/~1v1~1subprojects~1{subprojectId}/patch/requestBody/content/application~1json/examples/updateDisplayName","paths/~1v1~1subprojects~1{subprojectId}/patch/requestBody/content/application~1json/examples/updateLabels"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1030","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/patch/requestBody/content/application~1json/examples/updateFillIn","paths/~1v1~1subprojects~1{subprojectId}/patch/requestBody/content/application~1json/examples/updateDisplayName","paths/~1v1~1subprojects~1{subprojectId}/patch/requestBody/content/application~1json/examples/updateLabels"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A successful response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subproject"}},"schemaId":"components/schemas/Subproject"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INVALID_ARGUMENT: The request doesn't conform to the API."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/patch/responses/400/content/application~1json/example"]}},"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/patch/responses/400/content/application~1json/example"]},{"code":"401","description":"UNAUTHENTICATED: The authentication token is invalid. ","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/patch/responses/401/content/application~1json/example"]}},"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/patch/responses/401/content/application~1json/example"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERMISSION_DENIED: The request syntax is valid but can't be performed."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/patch/responses/403/content/application~1json/example"]}},"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/patch/responses/403/content/application~1json/example"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT_FOUND: The path is invalid or no resource exists with the given ID."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/patch/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1v1~1subprojects~1{subprojectId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Subproject","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subproject"}}},{"code":"400","schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/patch/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/patch/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/patch/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/patch/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/patch/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subprojects-service/subprojectservice_updatesubproject"}],"panels":[]}]},"httpPath":"/v1/subprojects/{subprojectId}"},{"label":"Delete an existing subproject","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/subprojects/api-reference/subprojects/subprojects-service/subprojectservice_deletesubproject","routeSlug":"/docs/subprojects/api-reference/subprojects/subprojects-service/subprojectservice_deletesubproject","metadata":{"seo":{"title":"Delete an existing subproject","description":"When a subproject is no longer needed, delete it using this endpoint. The only parameter needed is the subprojectId for the project which you'd like to delete."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SubprojectService_DeleteSubproject","name":"Delete an existing subproject","isWebhook":false,"pointer":"/paths/~1v1~1subprojects~1{subprojectId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an existing subproject","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a subproject is no longer needed, delete it using this endpoint. The only parameter needed is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subprojectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the project which you'd like to delete."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The username and password are your Key ID and Key Secret from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access keys section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Sinch Customer Dashboard. Exchange these for a bearer token (access token)."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}]},{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about basic authentication, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/subprojects/api-reference/index.md#authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subprojectId","in":"path","schemaId":"schema_1028","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique subproject identifier. Not to be confused with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parentProjectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subprojectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a new ID related to your parent project."},"children":[]}]}]}],"required":true,"example":"01FC66621VHDBN119Z8PMXXXXX"}],"pointer":"/paths/~1v1~1subprojects~1{subprojectId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/subprojects/{subprojectId}","servers":[{"url":"https://subproject.api.sinch.com","description":"Placeholder Server"}],"parameters":{"path":[{"name":"subprojectId","in":"path","required":true,"example":"01FC66621VHDBN119Z8PMXXXXX","schemaId":"schema_1028"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}],"scopes":[]},{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/v1/subprojects/{subprojectId}","href":"subprojects-service/subprojectservice_deletesubproject","openApiOperationId":"SubprojectService_DeleteSubproject","summary":"Delete an existing subproject","securityGroups":[{"OAuth2.0":[]},{"Basic":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://subproject.api.sinch.com","description":"Placeholder Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A successful response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1031"}},"schemaId":"schema_1031"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INVALID_ARGUMENT: The request doesn't conform to the API."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/delete/responses/400/content/application~1json/example"]}},"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/delete/responses/400/content/application~1json/example"]},{"code":"401","description":"UNAUTHENTICATED: The authentication token is invalid. ","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/delete/responses/401/content/application~1json/example"]}},"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/delete/responses/401/content/application~1json/example"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERMISSION_DENIED: The request syntax is valid but can't be performed."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/delete/responses/403/content/application~1json/example"]}},"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/delete/responses/403/content/application~1json/example"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT_FOUND: The path is invalid or no resource exists with the given ID."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/delete/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1v1~1subprojects~1{subprojectId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1031","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1031"}}},{"code":"400","schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/delete/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/delete/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/delete/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/delete/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/~1v1~1subprojects~1{subprojectId}/delete/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subprojects-service/subprojectservice_deletesubproject"}],"panels":[]}]},"httpPath":"/v1/subprojects/{subprojectId}"}],"content":{"contentType":"group","meta":{"name":"Subprojects Service"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subprojects Service","showPageActions":true},{"nodeType":"markdoc","content":"Service to create, find, modify or delete subprojects of Sinch projects."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects/{parentProjectId}/subprojects","summary":"Create a new subproject","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subprojects-service/subprojectservice_createsubproject","deprecated":false},{"title":"/v1/projects/{parentProjectId}/subprojects","summary":"List all subprojects","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subprojects-service/subprojectservice_listsubprojects","deprecated":false},{"title":"/v1/subprojects/{subprojectId}","summary":"Get a single subproject by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subprojects-service/subprojectservice_getsubproject","deprecated":false},{"title":"/v1/subprojects/{subprojectId}","summary":"Update an existing subproject","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/subprojects-service/subprojectservice_updatesubproject","deprecated":false},{"title":"/v1/subprojects/{subprojectId}","summary":"Delete an existing subproject","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/subprojects-service/subprojectservice_deletesubproject","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ListSubprojectsResponse":{"id":"components/schemas/ListSubprojectsResponse","kind":"json-schema","title":"ListSubprojectsResponse","data":{"type":"object","description":"The response containing the subprojects.","properties":{"nextPageToken":{"type":"string","description":"The next pagination token or an empty value if no more results."},"subprojects":{"type":"array","items":{"$ref":"#/components/schemas/Subproject"},"description":"Collection of subprojects."}}}},"components/schemas/Subproject":{"id":"components/schemas/Subproject","kind":"json-schema","title":"Subproject","data":{"type":"object","description":"Subprojects are used to logically group a set of product services.","required":["subprojectId","displayName","parentProjectId","createTime","updateTime","deleted"],"properties":{"createTime":{"type":"string","format":"date-time","description":"The date/time the subproject was created. ISO 8601 format.","readOnly":true},"deleted":{"type":"boolean","description":"The current deleted state of the subproject.","readOnly":true,"example":false},"displayName":{"type":"string","minLength":1,"maxLength":255,"description":"The display name of the subproject. You cannot have a null value. It does not have to be unique.","example":"Your Customer's Business Name"},"labels":{"type":"object","maxProperties":255,"additionalProperties":{"type":"string","minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A map of labels. String, key-value pairs that are completely customizable to allow for your metadata. Both the key and the value can be modified. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"region\": \"US-Northwest\""},"children":[]}]}]}]},"propertyNames":{"minLength":1,"maxLength":255}},"parentProjectId":{"type":"string","description":"The parent project ID the subproject belongs to. Set from the URL path on creation; a value sent in the request body is ignored.","readOnly":true},"subprojectId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique subproject identifier. Not to be confused with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parentProjectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subprojectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a new ID related to your parent project."},"children":[]}]}]}],"type":"string","readOnly":true},"updateTime":{"type":"string","format":"date-time","description":"The date/time the subproject was updated. ISO 8601 format.","readOnly":true}}}},"schema_1024":{"kind":"json-schema","data":{"type":"string","pattern":"[^/]+"},"id":"schema_1024"},"schema_1025":{"kind":"json-schema","data":{"type":"object","description":"The request to create a new subproject.","required":["displayName"],"properties":{"displayName":{"type":"string","minLength":1,"maxLength":255,"description":"The display name of the subproject. You cannot have a null value. It does not have to be unique.","example":"Taco Time"},"labels":{"type":"object","maxProperties":255,"additionalProperties":{"type":"string","minLength":1,"maxLength":255},"propertyNames":{"minLength":1,"maxLength":255},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A map of labels. String, key-value pairs that are completely customizable to allow for your metadata. Both the key and the value can be modified. Examples: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"region\": \"US-Northwest\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"phoneNumber\": \"14051234567\""},"children":[]}]}]}]}}},"id":"schema_1025"},"schema_1026":{"kind":"json-schema","data":{},"id":"schema_1026"},"schema_1027":{"kind":"json-schema","data":{"type":"integer","format":"int32","minimum":1,"maximum":1000,"default":100},"id":"schema_1027"},"schema_1028":{"kind":"json-schema","data":{"type":"string"},"id":"schema_1028"},"schema_1029":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_1029"},"schema_1030":{"kind":"json-schema","data":{"type":"object","properties":{"displayName":{"type":"string","minLength":1,"maxLength":255,"description":"Nonempty, non-unique display name of the subproject.","example":"Not Yo Momma's Cookin'"},"labels":{"type":"object","maxProperties":255,"additionalProperties":{"type":"string","minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A map of labels. String, key-value pairs that are completely customizable to allow for your metadata. Both the key and the value can be modified. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"region\": \"US-Northwest\""},"children":[]}]}]}]},"propertyNames":{"minLength":1,"maxLength":255}}}},"id":"schema_1030"},"schema_1031":{"kind":"json-schema","data":{"properties":{}},"id":"schema_1031"}},"exampleStore":{"components/examples/createFillIn":{"id":"components/examples/createFillIn","value":{"displayName":"YOUR_customer's_business_name","labels":{"YOUR_key1":"YOUR_value1","YOUR_key2":"YOUR_value2","YOUR_key3":"YOUR_value3"}},"summary":"Create a subproject - fill in"},"components/examples/createDisplayAndLabels":{"id":"components/examples/createDisplayAndLabels","value":{"displayName":"Taco Time","labels":{"region":"US-Northwest","size":"1000-5000","industry":"restaurant"}},"summary":"Create a subproject with a display name and labels"},"components/examples/updateFillIn":{"id":"components/examples/updateFillIn","value":{"displayName":"YOUR_customer's_updated_displayName","labels":{"YOUR_new_key":"YOUR_new_value2"}},"summary":"Update all parameters - fill in"},"components/examples/updateDisplayName":{"id":"components/examples/updateDisplayName","value":{"displayName":"Newfangled Sassy Actuaries"},"summary":"Update the display name"},"components/examples/updateLabels":{"id":"components/examples/updateLabels","value":{"labels":{"region":"UK-London"}},"summary":"Update the labels"},"paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/requestBody/content/application~1json/examples/createFillIn":{"value":{"displayName":"YOUR_customer's_business_name","labels":{"YOUR_key1":"YOUR_value1","YOUR_key2":"YOUR_value2","YOUR_key3":"YOUR_value3"}},"key":"createFillIn","summary":"Create a subproject - fill in","id":"paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/requestBody/content/application~1json/examples/createFillIn"},"paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/requestBody/content/application~1json/examples/createDisplayAndLabels":{"value":{"displayName":"Taco Time","labels":{"region":"US-Northwest","size":"1000-5000","industry":"restaurant"}},"key":"createDisplayAndLabels","summary":"Create a subproject with a display name and labels","id":"paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/requestBody/content/application~1json/examples/createDisplayAndLabels"},"paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/responses/400/content/application~1json/examples/invalidArgument":{"value":{"error":{"code":400,"message":"","status":"INVALID_ARGUMENT","details":[]}},"key":"invalidArgument","summary":"INVALID_ARGUMENT","id":"paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/responses/400/content/application~1json/examples/invalidArgument"},"paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/responses/400/content/application~1json/examples/failedPrecondition":{"value":{"error":{"code":400,"message":"","status":"FAILED_PRECONDITION","details":[]}},"key":"failedPrecondition","summary":"FAILED_PRECONDITION (invalid or non-existent parent project)","id":"paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/responses/400/content/application~1json/examples/failedPrecondition"},"paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/responses/401/content/application~1json/example":{"value":{"error":{"code":401,"message":"","status":"UNAUTHENTICATED","details":[]}},"id":"paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/responses/401/content/application~1json/example"},"paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/responses/403/content/application~1json/example":{"value":{"error":{"code":403,"message":"","status":"PERMISSION_DENIED","details":[]}},"id":"paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/responses/403/content/application~1json/example"},"paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/responses/404/content/application~1json/example":{"value":{"error":{"code":404,"message":"","status":"NOT_FOUND","details":[]}},"id":"paths/~1v1~1projects~1{parentProjectId}~1subprojects/post/responses/404/content/application~1json/example"},"paths/~1v1~1projects~1{parentProjectId}~1subprojects/get/responses/400/content/application~1json/example":{"value":{"error":{"code":400,"message":"","status":"INVALID_ARGUMENT","details":[]}},"id":"paths/~1v1~1projects~1{parentProjectId}~1subprojects/get/responses/400/content/application~1json/example"},"paths/~1v1~1projects~1{parentProjectId}~1subprojects/get/responses/401/content/application~1json/example":{"value":{"error":{"code":401,"message":"","status":"UNAUTHENTICATED","details":[]}},"id":"paths/~1v1~1projects~1{parentProjectId}~1subprojects/get/responses/401/content/application~1json/example"},"paths/~1v1~1projects~1{parentProjectId}~1subprojects/get/responses/403/content/application~1json/example":{"value":{"error":{"code":403,"message":"","status":"PERMISSION_DENIED","details":[]}},"id":"paths/~1v1~1projects~1{parentProjectId}~1subprojects/get/responses/403/content/application~1json/example"},"paths/~1v1~1subprojects~1{subprojectId}/get/responses/400/content/application~1json/example":{"value":{"error":{"code":400,"message":"","status":"INVALID_ARGUMENT","details":[]}},"id":"paths/~1v1~1subprojects~1{subprojectId}/get/responses/400/content/application~1json/example"},"paths/~1v1~1subprojects~1{subprojectId}/get/responses/401/content/application~1json/example":{"value":{"error":{"code":401,"message":"","status":"UNAUTHENTICATED","details":[]}},"id":"paths/~1v1~1subprojects~1{subprojectId}/get/responses/401/content/application~1json/example"},"paths/~1v1~1subprojects~1{subprojectId}/get/responses/403/content/application~1json/example":{"value":{"error":{"code":403,"message":"","status":"PERMISSION_DENIED","details":[]}},"id":"paths/~1v1~1subprojects~1{subprojectId}/get/responses/403/content/application~1json/example"},"paths/~1v1~1subprojects~1{subprojectId}/get/responses/404/content/application~1json/example":{"value":{"error":{"code":404,"message":"","status":"NOT_FOUND","details":[]}},"id":"paths/~1v1~1subprojects~1{subprojectId}/get/responses/404/content/application~1json/example"},"paths/~1v1~1subprojects~1{subprojectId}/patch/requestBody/content/application~1json/examples/updateFillIn":{"value":{"displayName":"YOUR_customer's_updated_displayName","labels":{"YOUR_new_key":"YOUR_new_value2"}},"key":"updateFillIn","summary":"Update all parameters - fill in","id":"paths/~1v1~1subprojects~1{subprojectId}/patch/requestBody/content/application~1json/examples/updateFillIn"},"paths/~1v1~1subprojects~1{subprojectId}/patch/requestBody/content/application~1json/examples/updateDisplayName":{"value":{"displayName":"Newfangled Sassy Actuaries"},"key":"updateDisplayName","summary":"Update the display name","id":"paths/~1v1~1subprojects~1{subprojectId}/patch/requestBody/content/application~1json/examples/updateDisplayName"},"paths/~1v1~1subprojects~1{subprojectId}/patch/requestBody/content/application~1json/examples/updateLabels":{"value":{"labels":{"region":"UK-London"}},"key":"updateLabels","summary":"Update the labels","id":"paths/~1v1~1subprojects~1{subprojectId}/patch/requestBody/content/application~1json/examples/updateLabels"},"paths/~1v1~1subprojects~1{subprojectId}/patch/responses/400/content/application~1json/example":{"value":{"error":{"code":400,"message":"","status":"INVALID_ARGUMENT","details":[]}},"id":"paths/~1v1~1subprojects~1{subprojectId}/patch/responses/400/content/application~1json/example"},"paths/~1v1~1subprojects~1{subprojectId}/patch/responses/401/content/application~1json/example":{"value":{"error":{"code":401,"message":"","status":"UNAUTHENTICATED","details":[]}},"id":"paths/~1v1~1subprojects~1{subprojectId}/patch/responses/401/content/application~1json/example"},"paths/~1v1~1subprojects~1{subprojectId}/patch/responses/403/content/application~1json/example":{"value":{"error":{"code":403,"message":"","status":"PERMISSION_DENIED","details":[]}},"id":"paths/~1v1~1subprojects~1{subprojectId}/patch/responses/403/content/application~1json/example"},"paths/~1v1~1subprojects~1{subprojectId}/patch/responses/404/content/application~1json/example":{"value":{"error":{"code":404,"message":"","status":"NOT_FOUND","details":[]}},"id":"paths/~1v1~1subprojects~1{subprojectId}/patch/responses/404/content/application~1json/example"},"paths/~1v1~1subprojects~1{subprojectId}/delete/responses/400/content/application~1json/example":{"value":{"error":{"code":400,"message":"","status":"INVALID_ARGUMENT","details":[]}},"id":"paths/~1v1~1subprojects~1{subprojectId}/delete/responses/400/content/application~1json/example"},"paths/~1v1~1subprojects~1{subprojectId}/delete/responses/401/content/application~1json/example":{"value":{"error":{"code":401,"message":"","status":"UNAUTHENTICATED","details":[]}},"id":"paths/~1v1~1subprojects~1{subprojectId}/delete/responses/401/content/application~1json/example"},"paths/~1v1~1subprojects~1{subprojectId}/delete/responses/403/content/application~1json/example":{"value":{"error":{"code":403,"message":"","status":"PERMISSION_DENIED","details":[]}},"id":"paths/~1v1~1subprojects~1{subprojectId}/delete/responses/403/content/application~1json/example"},"paths/~1v1~1subprojects~1{subprojectId}/delete/responses/404/content/application~1json/example":{"value":{"error":{"code":404,"message":"","status":"NOT_FOUND","details":[]}},"id":"paths/~1v1~1subprojects~1{subprojectId}/delete/responses/404/content/application~1json/example"}},"securitySchemeStore":{"Basic":{"id":"Basic","type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about basic authentication, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/subprojects/api-reference/index.md#authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"OAuth2.0":{"id":"OAuth2.0","type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The username and password are your Key ID and Key Secret from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access keys section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Sinch Customer Dashboard. Exchange these for a bearer token (access token)."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}},"servers":[{"url":"https://subproject.api.sinch.com","description":"Placeholder Server"}],"specType":"openapi"},"options":{"sortRequiredPropsFirst":true,"mockServer":{"url":"/_mock/docs/subprojects/api-reference/subprojects","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/docs/subprojects/api-reference/subprojects.json?download"},{"url":"/_bundle/docs/subprojects/api-reference/subprojects.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Subprojects API","description":"An API to create, find, modify or delete subprojects of Sinch projects (parent projects). Using subprojects you can better organize your organization's projects by customer, department, product, marketing campaign, etc.\n\nIf you would like help using the Subprojects API, review our [Getting Started guide](https://developers.sinch.com/docs/subprojects/getting-started).\n**The Subprojects API is in closed beta.**\n\n**Limited availability:** this API is available to selected customers only. Contact your Account Manager to discuss access.\n\n**Versioning:** `v1` is the current version. `v1alpha1` is **deprecated** in favour of `v1`; existing clients should migrate to `v1`. The two versions are functionally identical - only the path prefix differs (`/v1alpha1/...` => `/v1/...`)."}},"baseSlug":"/docs/subprojects/api-reference/subprojects","routesMapping":{}}